accelerator Class

 

For the latest documentation on Visual Studio 2017, see Visual Studio 2017 Documentation.

An accelerator is a hardware capability that is optimized for data-parallel computing. An accelerator may be a device attached to a PCIe bus (such as a GPU), or it might be an extended instruction set on the main CPU.

class accelerator;  

Public Constructors

NameDescription
accelerator::accelerator ConstructorInitializes a new instance of the accelerator class.
accelerator::~accelerator DestructorDestroys the accelerator object.

Public Methods

NameDescription
accelerator::create_view MethodCreates and returns an accelerator_view object on this accelerator.
accelerator::get_all MethodReturns a vector of accelerator objects that represent all the available accelerators.
accelerator::get_auto_selection_view MethodReturns the auto-selection accelerator_view.
accelerator::get_dedicated_memory MethodReturns the dedicated memory for the accelerator, in kilobytes.
accelerator::get_default_cpu_access_type MethodReturns the default access_type for buffers created on this accelerator.
accelerator::get_default_view MethodReturns the default accelerator_view object that is associated with the accelerator.
accelerator::get_description MethodReturns a short description of the accelerator device.
accelerator::get_device_path MethodReturns the path of the device.
accelerator::get_has_display MethodDetermines whether the accelerator is attached to a display.
accelerator::get_is_debug MethodDetermines whether the accelerator has the DEBUG layer enabled for extensive error reporting.
accelerator::get_is_emulated MethodDetermines whether the accelerator is emulated.
accelerator::get_supports_cpu_shared_memory MethodDetermines whether the accelerator supports shared memory
accelerator::get_supports_double_precision MethodDetermines whether the accelerator is attached to a display.
accelerator::get_supports_limited_double_precision MethodDetermines whether the accelerator has limited support for double-precision math.
accelerator::get_version MethodReturns the version of the accelerator.
accelerator::set_default MethodReturns the path of the default accelerator.
accelerator::set_default_cpu_access_type MethodSets the default CPU access_type for arrays and implicit memory allocations made on this accelerator.

Public Operators

NameDescription
accelerator::operator!= OperatorCompares this accelerator object with another and returns false if they are the same; otherwise, returns true.
accelerator::operator= OperatorCopies the contents of the specified accelerator object to this one.
accelerator::operator== OperatorCompares this accelerator object with another and returns true if they are the same; otherwise, returns false.

Public Data Members

NameDescription
accelerator::cpu_accelerator Data MemberGets a string constant for the CPU accelerator.
accelerator::dedicated_memory Data MemberGets the dedicated memory for the accelerator, in kilobytes.
accelerator::default_accelerator Data MemberGets a string constant for the default accelerator.
accelerator::default_cpu_access_type Data MemberGets or sets the default CPU access_type for arrays and implicit memory allocations made on this accelerator.
accelerator::default_view Data MemberGets the default accelerator_view object that is associated with the accelerator.
accelerator::description Data MemberGets a short description of the accelerator device.
accelerator::device_path Data MemberGets the path of the device.
accelerator::direct3d_ref Data MemberGets a string constant for a Direct3D reference accelerator.
accelerator::direct3d_warp Data MemberGets the string constant for an accelerator object that you can use for executing C++ AMP code on multi-core CPUs that use Streaming SIMD Extensions (SSE).
accelerator::has_display Data MemberGets a Boolean value that indicates whether the accelerator is attached to a display.
accelerator::is_debug Data MemberIndicates whether the accelerator has the DEBUG layer enabled for extensive error reporting.
accelerator::is_emulated Data MemberIndicates whether the accelerator is emulated.
accelerator::supports_cpu_shared_memory Data MemberIndicates whether the accelerator supports shared memory.
accelerator::supports_double_precision Data MemberIndicates whether the accelerator supports double-precision math.
accelerator::supports_limited_double_precision Data MemberIndicates whether the accelerator has limited support for double-precision math.
accelerator::version Data MemberGets the version of the accelerator.

accelerator

An accelerator is a hardware capability that is optimized for data-parallel computing. An accelerator is often a discrete GPU, but it can also be a virtual host-side entity such as a DirectX REF device, a WARP (a CPU-side device that is accelerated by means of SSE instructions), or the CPU itself.

You can construct an accelerator object by enumerating the available devices, or by getting the default device, the reference device, or the WARP device.

Header: amprt.h

Namespace: Concurrency

Destroys the accelerator object.

~accelerator();

Return Value

Initializes a new instance of the accelerator class.

accelerator();

 
explicit accelerator(const std::wstring& _Device_path);

 
accelerator(const accelerator& _Other);

Parameters

_Device_path
The path of the physical device.

_Other
The accelerator to copy.

Gets a string constant for the CPU accelerator.

static const wchar_t cpu_accelerator[];  

Creates and returns an accelerator_view object on this accelerator, using the specified queuing mode. When the queuing mode is not specified, the new accelerator_view uses the queuing_mode::immediate queuing mode.

accelerator_view create_view(queuing_mode qmode = queuing_mode_automatic);

Parameters

qmode
The queuing mode.

Return Value

A new accelerator_view object on this accelerator, using the specified queuing mode.

Gets the dedicated memory for the accelerator, in kilobytes.

__declspec(property(get= get_dedicated_memory)) size_t dedicated_memory;  

Gets a string constant for the default accelerator.

static const wchar_t default_accelerator[];  

The default cpu access_type for arrays and implicit memory allocations made on this this accelerator.

__declspec(property(get= get_default_cpu_access_type)) access_type default_cpu_access_type;  

Gets the default accelerator view that is associated with the accelerator.

__declspec(property(get= get_default_view)) accelerator_view default_view;  

Gets a short description of the accelerator device.

__declspec(property(get= get_description)) std::wstring description;  

Gets the path of the accelerator. The path is unique on the system.

__declspec(property(get= get_device_path)) std::wstring device_path;  

Gets a string constant for a Direct3D reference accelerator.

static const wchar_t direct3d_ref[];  

Gets the string constant for an accelerator object that you can use for executing your C++ AMP code on multi-core CPUs using Streaming SIMD Extensions (SSE).

static const wchar_t direct3d_warp[];  

Returns a vector of accelerator objects that represent all the available accelerators.

static inline std::vector<accelerator> get_all();

Return Value

The vector of available accelerators

Returns the auto selection accelerator_view, which when specified as the parallel_for_each target results in the target accelerator_view for executing the parallel_for_each kernel to be automatically selected by the runtime. For all other purposes, the accelerator_view returned by this method is the same as the default accelerator_view of the default accelerator

static accelerator_view __cdecl get_auto_selection_view();

Return Value

The auto selection accelerator_view.

Returns the dedicated memory for the accelerator, in kilobytes.

size_t get_dedicated_memory() const;

 

Return Value

The dedicated memory for the accelerator, in kilobytes.

Gets the default cpu access_type for buffers created on this accelerator

access_type get_default_cpu_access_type() const;

 

Return Value

The default cpu access_type for buffers created on this accelerator.

Returns the default accelerator_view object that is associated with the accelerator.

accelerator_view get_default_view() const;

 

Return Value

The default accelerator_view object that is associated with the accelerator.

Returns a short description of the accelerator device.

std::wstring get_description() const;

 

Return Value

A short description of the accelerator device.

Returns the path of the accelerator. The path is unique on the system.

std::wstring get_device_path() const;

 

Return Value

The system-wide unique device instance path.

Returns a Boolean value that indicates whether the accelerator can output to a display.

bool get_has_display() const;

 

Return Value

true if the accelerator can output to a display; otherwise, false.

Determines whether the accelerator has the DEBUG layer enabled for extensive error reporting.

bool get_is_debug() const;

 

Return Value

true if the accelerator has the DEBUG layer enabled for extensive error reporting. Otherwise, false.

Determines whether the accelerator is emulated.

bool get_is_emulated() const;

 

Return Value

true if the accelerator is emulated. Otherwise, false.

Returns a boolean value indicating whether the accelerator supports memory accessible both by the accelerator and the CPU.

bool get_supports_cpu_shared_memory() const;

 

Return Value

true if the accelerator supports CPU shared memory; otherwise, false.

Returns a Boolean value that indicates whether the accelerator supports double precision math, including fused multiply add (FMA), division, reciprocal, and casting between int and double.

bool get_supports_double_precision() const;

 

Return Value

true if the accelerator supports double precision math; otherwise, false.

Returns a Boolean value that indicates whether the accelerator has limited support for double precision math. If the accelerator has only limited support, then fused multiply add (FMA), division, reciprocal, and casting between int and double are not supported.

bool get_supports_limited_double_precision() const;

 

Return Value

true if the accelerator has limited support for double precision math; otherwise, false.

Returns the version of the accelerator.

unsigned int get_version() const;

 

Return Value

The version of the accelerator.

Gets a Boolean value that indicates whether the accelerator can output to a display.

__declspec(property(get= get_has_display)) bool has_display;  

Gets a Boolean value that indicates whether the accelerator has the DEBUG layer enabled for extensive error reporting.

__declspec(property(get= get_is_debug)) bool is_debug;  

Gets a Boolean value that indicates whether the accelerator is emulated.

__declspec(property(get= get_is_emulated)) bool is_emulated;  

Compares this accelerator object with another and returns false if they are the same; otherwise, returns true.

bool operator!= (const accelerator& _Other) const;

 

Parameters

_Other
The accelerator object to compare with this one.

Return Value

false if the two accelerator objects are the same; otherwise, true.

Copies the contents of the specified accelerator object to this one.

accelerator& operator= (const accelerator& _Other);

Parameters

_Other
The accelerator object to copy from.

Return Value

A reference to this accelerator object.

Compares this accelerator object with another and returns true if they are the same; otherwise, returns false.

bool operator== (const accelerator& _Other) const;

 

Parameters

_Other
The accelerator object to compare with this one.

Return Value

true if the other accelerator object is same as this accelerator object; otherwise, false.

Sets the default accelerator to be used for any operation that implicitly uses the default accelerator. This method only succeeds if the runtime selected default accelerator has not already been used in an operation that implicitly uses the default accelerator

static inline bool set_default(std::wstring _Path);

Parameters

_Path
The path to the accelerator.

Return Value

true if the call succeeds at setting the default accelerator. Otherwise, false.

Set the default cpu access_type for arrays created on this accelerator or for implicit memory allocations as part of array_views accessed on this this accelerator. This method only succeeds if the default_cpu_access_type for the accelerator has not already been overriden by a previous call to this method and the runtime selected default_cpu_access_type for this accelerator has not yet been used for allocating an array or for an implicit memory allocation backing an array_view accessed on this accelerator.

bool set_default_cpu_access_type(access_type _Default_cpu_access_type);

Parameters

_Default_cpu_access_type
The default cpu access_type to be used for array/array_view memory allocations on this accelerator.

Return Value

A boolean value indicating if the default cpu access_type for the accelerator was successfully set.

Gets a Boolean value indicating whether the accelerator supports shared memory.

__declspec(property(get= get_supports_cpu_shared_memory)) bool supports_cpu_shared_memory;  

Gets a Boolean value that indicates whether the accelerator supports double precision math.

__declspec(property(get= get_supports_double_precision)) bool supports_double_precision;  

Gets a Boolean value that indicates whether the accelerator has limited support for double precision math. If the accelerator has only limited support, then fused multiply add (FMA), division, reciprocal, and casting between int and double are not supported.

__declspec(property(get= get_supports_limited_double_precision)) bool supports_limited_double_precision;  

Gets the version of the accelerator.

__declspec(property(get= get_version)) unsigned int version;  

Destroys the accelerator_view object.

~accelerator_view();

Return Value

Gets the accelerator object for the accelerator_view object.

__declspec(property(get= get_accelerator)) Concurrency::accelerator accelerator;  

Initializes a new instance of the accelerator_view class by copying an existing accelerator_view object.

accelerator_view(const accelerator_view& _Other);

Parameters

_Other
The accelerator_view object to copy.

Returns a future to track the completion of all commands submitted so far to this accelerator_view object.

concurrency::completion_future create_marker();

Return Value

A future to track the completion of all commands submitted so far to this accelerator_view object.

Submits all pending commands queued to the accelerator_view object to the accelerator for execution.

void flush();

Return Value

Returns void.

Returns the accelerator object for the accelerator_view object.

accelerator get_accelerator() const;

 

Return Value

The accelerator object for the accelerator_view object.

Returns a Boolean value that indicates whether the runtime will automatically select an appropriate accelerator when the accelerator_view is passed to a parallel_for_each.

bool get_is_auto_selection() const;

 

Return Value

true if the runtime will automatically select an appropriate accelerator; otherwise, false.

Returns a Boolean value that indicates whether the accelerator_view object has the DEBUG layer enabled for extensive error reporting.

bool get_is_debug() const;

 

Return Value

A Boolean value that indicates whether the accelerator_view object has the DEBUG layer enabled for extensive error reporting.

Returns the queuing mode for the accelerator_view object.

queuing_mode get_queuing_mode() const;

 

Return Value

The queuing mode for the accelerator_view object.

Returns the version of the accelerator_view.

unsigned int get_version() const;

 

Return Value

The version of the accelerator_view.

Gets a Boolean value that indicates whether the runtime will automatically select an appropriate accelerator when the accelerator_view is passed to a parallel_for_each.

__declspec(property(get= get_is_auto_selection)) bool is_auto_selection;  

Gets a Boolean value that indicates whether the accelerator_view object has the DEBUG layer enabled for extensive error reporting.

__declspec(property(get= get_is_debug)) bool is_debug;  

Compares this accelerator_view object with another and returns false if they are the same; otherwise, returns true.

bool operator!= (const accelerator_view& _Other) const;

 

Parameters

_Other
The accelerator_view object to compare with this one.

Return Value

false if the two objects are the same; otherwise, true.

Copies the contents of the specified accelerator_view object into this one.

accelerator_view& operator= (const accelerator_view& _Other);

Parameters

_Other
The accelerator_view object to copy from.

Return Value

A reference to the modified accelerator_view object.

Compares this accelerator_view object with another and returns true if they are the same; otherwise, returns false.

bool operator== (const accelerator_view& _Other) const;

 

Parameters

_Other
The accelerator_view object to compare with this one.

Return Value

true if the two objects are the same; otherwise, false.

Gets the queuing mode for the accelerator_view object.

__declspec(property(get= get_queuing_mode)) Concurrency::queuing_mode queuing_mode;  

Gets the version of the accelerator_view.

__declspec(property(get= get_version)) unsigned int version;  

Waits for all commands submitted to the accelerator_view object to finish.

void wait();

Return Value

Returns void.

Concurrency Namespace (C++ AMP)

Show: