Skip to content

Commit 076f1fa

Browse files
author
Michael Blome
committed
broken link fixes in amp
1 parent 37da574 commit 076f1fa

9 files changed

Lines changed: 1086 additions & 347 deletions

‎docs/parallel/amp/reference/accelerator-view-class.md‎

Lines changed: 237 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ translation.priority.ht:
3737
# accelerator_view Class
3838
Represents a virtual device abstraction on a C++ AMP data-parallel accelerator.
3939

40-
## Syntax
40+
### Syntax
4141

4242
```
4343
class accelerator_view;
@@ -49,54 +49,269 @@ class accelerator_view;
4949

5050
|Name|Description|
5151
|----------|-----------------|
52-
|[accelerator_view::accelerator_view Constructor](../Topic/accelerator_view::accelerator_view%20Constructor.md)|Initializes a new instance of the `accelerator_view` class.|
53-
|[accelerator_view::~accelerator_view Destructor](../Topic/accelerator_view::~accelerator_view%20Destructor.md)|Destroys the `accelerator_view` object.|
52+
|[accelerator_view::accelerator_view Constructor](#accelerator_view_ctor)|Initializes a new instance of the `accelerator_view` class.|
53+
|[accelerator_view::~accelerator_view Destructor](#accelerator_view_dtor)|Destroys the `accelerator_view` object.|
5454

5555
### Public Methods
5656

5757
|Name|Description|
5858
|----------|-----------------|
59-
|[accelerator_view::create_marker Method](../Topic/accelerator_view::create_marker%20Method.md)|Returns a future to track the completion of all commands submitted so far to this `accelerator_view` object.|
60-
|[accelerator_view::flush Method](../Topic/accelerator_view::flush%20Method.md)|Submits all pending commands queued to the `accelerator_view` object to the accelerator for execution.|
61-
|[accelerator_view::get_accelerator Method](../Topic/accelerator_view::get_accelerator%20Method.md)|Returns the `accelerator` object for the `accelerator_view` object.|
62-
|[accelerator_view::get_is_auto_selection Method](../Topic/accelerator_view::get_is_auto_selection%20Method.md)|Returns a Boolean value that indicates whether the runtime will automatically select an appropriate accelerator when the `accelerator_view` object is passed to a [parallel_for_each](../Topic/parallel_for_each%20Function%20\(C++%20AMP\).md).|
63-
|[accelerator_view::get_is_debug Method](../Topic/accelerator_view::get_is_debug%20Method.md)|Returns a Boolean value that indicates whether the `accelerator_view` object has the DEBUG layer enabled for extensive error reporting.|
64-
|[accelerator_view::get_queuing_mode Method](../Topic/accelerator_view::get_queuing_mode%20Method.md)|Returns the queuing mode for the `accelerator_view` object.|
65-
|[accelerator_view::get_version Method](../Topic/accelerator_view::get_version%20Method.md)|Returns the version of the `accelerator_view`.|
66-
|[accelerator_view::wait Method](../Topic/accelerator_view::wait%20Method.md)|Waits for all commands submitted to the `accelerator_view` object to finish.|
59+
|[accelerator_view::create_marker Method](#create_marker)|Returns a future to track the completion of all commands submitted so far to this `accelerator_view` object.|
60+
|[accelerator_view::flush Method](#flush)|Submits all pending commands queued to the `accelerator_view` object to the accelerator for execution.|
61+
|[accelerator_view::get_accelerator Method](#get_accelerator)|Returns the `accelerator` object for the `accelerator_view` object.|
62+
|[accelerator_view::get_is_auto_selection Method](#get_is_auto_selection)|Returns a Boolean value that indicates whether the runtime will automatically select an appropriate accelerator when the `accelerator_view` object is passed to a parallel_for_each function.|
63+
|[accelerator_view::get_is_debug Method](#get_is_debug)|Returns a Boolean value that indicates whether the `accelerator_view` object has the DEBUG layer enabled for extensive error reporting.|
64+
|[accelerator_view::get_queuing_mode Method](#get_queuing_mode)|Returns the queuing mode for the `accelerator_view` object.|
65+
|[accelerator_view::get_version Method](#get_version)|Returns the version of the `accelerator_view`.|
66+
|[accelerator_view::wait Method](#wait)|Waits for all commands submitted to the `accelerator_view` object to finish.|
6767

6868
### Public Operators
6969

7070
|Name|Description|
7171
|----------|-----------------|
72-
|[accelerator_view::operator!= Operator](../Topic/accelerator_view::operator!=%20Operator.md)|Compares this `accelerator_view` object with another and returns `false` if they are the same; otherwise, returns `true`.|
73-
|[accelerator_view::operator= Operator](../Topic/accelerator_view::operator=%20Operator.md)|Copies the contents of the specified `accelerator_view` object into this one.|
74-
|[accelerator_view::operator== Operator](../Topic/accelerator_view::operator==%20Operator.md)|Compares this `accelerator_view` object with another and returns `true` if they are the same; otherwise, returns `false`.|
72+
|[accelerator_view::operator!= Operator](#operator_neq)|Compares this `accelerator_view` object with another and returns `false` if they are the same; otherwise, returns `true`.|
73+
|[accelerator_view::operator= Operator](#operator_eq)|Copies the contents of the specified `accelerator_view` object into this one.|
74+
|[accelerator_view::operator== Operator](#operator_eq_eq)|Compares this `accelerator_view` object with another and returns `true` if they are the same; otherwise, returns `false`.|
7575

7676
### Public Data Members
7777

7878
|Name|Description|
7979
|----------|-----------------|
80-
|[accelerator_view::accelerator Data Member](../Topic/accelerator_view::accelerator%20Data%20Member.md)|Gets the `accelerator` object for the `accelerator_view` object.|
81-
|[accelerator_view::is_auto_selection Data Member](../Topic/accelerator_view::is_auto_selection%20Data%20Member.md)|Gets a Boolean value that indicates whether the runtime will automatically select an appropriate accelerator when the `accelerator_view` object is passed to a [parallel_for_each](../Topic/parallel_for_each%20Function%20\(C++%20AMP\).md).|
82-
|[accelerator_view::is_debug Data Member](../Topic/accelerator_view::is_debug%20Data%20Member.md)|Gets a Boolean value that indicates whether the `accelerator_view` object has the DEBUG layer enabled for extensive error reporting.|
83-
|[accelerator_view::queuing_mode Data Member](../Topic/accelerator_view::queuing_mode%20Data%20Member.md)|Gets the queuing mode for the `accelerator_view` object.|
84-
|[accelerator_view::version Data Member](../Topic/accelerator_view::version%20Data%20Member.md)|Gets the version of the accelerator.|
80+
|[accelerator_view::accelerator Data Member](#accelerator)|Gets the `accelerator` object for the `accelerator_view` object.|
81+
|[accelerator_view::is_auto_selection Data Member](#is_auto_selection)|Gets a Boolean value that indicates whether the runtime will automatically select an appropriate accelerator when the `accelerator_view` object is passed to a parallel_for_each function.|
82+
|[accelerator_view::is_debug Data Member](#is_debug)|Gets a Boolean value that indicates whether the `accelerator_view` object has the DEBUG layer enabled for extensive error reporting.|
83+
|[accelerator_view::queuing_mode Data Member](#queuing_mode)|Gets the queuing mode for the `accelerator_view` object.|
84+
|[accelerator_view::version Data Member](#version)|Gets the version of the accelerator.|
8585

8686
## Inheritance Hierarchy
8787
`accelerator_view`
8888

89-
## Remarks
89+
### Remarks
9090
An `accelerator_view` object represents a logical, isolated view of an accelerator. A single physical compute device can have many logical, isolated `accelerator_view` objects. Each accelerator has a default `accelerator_view` object. Additional `accelerator_view` objects can be created.
9191

9292
Physical devices can be shared among many client threads. Client threads can cooperatively use the same `accelerator_view` object of an accelerator, or each client can communicate with a compute device via an independent `accelerator_view` object for isolation from other client threads.
9393

94-
An `accelerator_view` object can have one of two [queuing_mode Enumeration](../../../parallel/amp/reference/queuing-mode-enumeration.md) states. If the queuing mode is `immediate`, commands like `copy` and `parallel_for_each` are sent to the corresponding accelerator device as soon as they return to the caller. If the queuing mode is `deferred`, such commands are queued up on a command queue that corresponds to the `accelerator_view` object. Commands are not actually sent to the device until `flush()` is called.
94+
An `accelerator_view` object can have one of two [queuing_mode Enumeration](concurrency-namespace-enums-amp.md#queuing-mode-enumeration) states. If the queuing mode is `immediate`, commands like `copy` and `parallel_for_each` are sent to the corresponding accelerator device as soon as they return to the caller. If the queuing mode is `deferred`, such commands are queued up on a command queue that corresponds to the `accelerator_view` object. Commands are not actually sent to the device until `flush()` is called.
9595

9696
## Requirements
9797
**Header:** amprt.h
9898

9999
**Namespace:** Concurrency
100+
101+
## <a name="accelerator"></a> accelerator_view::accelerator Data Member
102+
103+
Gets the accelerator object for the accelerator_view object.
100104

105+
### Syntax
106+
107+
```
108+
__declspec(property(get= get_accelerator)) Concurrency::accelerator accelerator;
109+
```
110+
111+
## <a name="accelerator_view_ctor"></a> accelerator_view::accelerator_view Constructor
112+
Initializes a new instance of the accelerator_view class by copying an existing `accelerator_view` object.
113+
114+
### Syntax
115+
116+
```
117+
accelerator_view( const accelerator_view & _Other );
118+
```
119+
120+
### Parameters
121+
`_Other`
122+
The `accelerator_view` object to copy.
123+
124+
## <a name="create_marker"></a> accelerator_view::create_marker Method
125+
Returns a future to track the completion of all commands submitted so far to this `accelerator_view` object.
126+
127+
### Syntax
128+
129+
```
130+
concurrency::completion_future create_marker();
131+
```
132+
133+
### Return Value
134+
A future to track the completion of all commands submitted so far to this `accelerator_view` object.
135+
136+
## <a name="flush"></a> accelerator_view::flush Method
137+
Submits all pending commands queued to the accelerator_view object to the accelerator for execution.
138+
139+
### Syntax
140+
141+
```
142+
void flush();
143+
```
144+
145+
### Return Value
146+
Returns `void`.
147+
148+
## <a name="get_accelerator"></a> accelerator_view::get_accelerator Method
149+
Returns the accelerator object for the accelerator_view object.
150+
### Syntax
151+
```
152+
accelerator get_accelerator() const;
153+
```
154+
### Return Value
155+
The accelerator object for the accelerator_view object.
156+
157+
## <a name="get_is_auto_selection"></a> accelerator_view::get_is_auto_selection Method
158+
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](concurrency-namespace-functions-amp.md#parallel_for_each).
159+
160+
### Syntax
161+
162+
```
163+
bool get_is_auto_selection() const;
164+
```
165+
166+
### Return Value
167+
`true` if the runtime will automatically select an appropriate accelerator; otherwise, `false`.
168+
169+
## <a name="get_is_debug"></a> accelerator_view::get_is_debug Method
170+
Returns a Boolean value that indicates whether the accelerator_view object has the DEBUG layer enabled for extensive error reporting.
171+
172+
### Syntax
173+
174+
```
175+
bool get_is_debug() const;
176+
```
177+
178+
### Return Value
179+
A Boolean value that indicates whether the `accelerator_view` object has the DEBUG layer enabled for extensive error reporting.
180+
181+
## <a name="get_queuing_mode"></a> accelerator_view::get_queuing_mode Method
182+
Returns the queuing mode for the accelerator_view object.
183+
184+
### Syntax
185+
186+
```
187+
queuing_mode get_queuing_mode() const;
188+
```
189+
190+
### Return Value
191+
The queuing mode for the `accelerator_view` object.
192+
193+
## <a name="get_version"></a> accelerator_view::get_version Method
194+
Returns the version of the accelerator_view.
195+
196+
### Syntax
197+
198+
```
199+
unsigned int get_version() const;
200+
```
201+
202+
### Return Value
203+
The version of the `accelerator_view`.
204+
205+
## <a name="is_auto_selection"></a> accelerator_view::is_auto_selection Data Member
206+
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](../Topic/parallel_for_each__Function__\(C++__AMP\)).
207+
208+
### Syntax
209+
210+
```
211+
__declspec(property(get= get_is_auto_selection)) bool is_auto_selection;
212+
```
213+
214+
## <a name="is_debug"></a> accelerator_view::is_debug Data Member
215+
Gets a Boolean value that indicates whether the accelerator_view object has the DEBUG layer enabled for extensive error reporting.
216+
217+
### Syntax
218+
219+
```
220+
__declspec(property(get= get_is_debug)) bool is_debug;
221+
```
222+
223+
## <a name="operator_neq"></a> accelerator_view::operator!= Operator
224+
Compares this accelerator_view object with another and returns `false` if they are the same; otherwise, returns `true`.
225+
226+
### Syntax
227+
228+
```
229+
bool operator!= ( const accelerator_view & _Other ) const;
230+
```
231+
232+
### Parameters
233+
`_Other`
234+
The `accelerator_view` object to compare with this one.
235+
236+
### Return Value
237+
`false` if the two objects are the same; otherwise, `true`.
238+
239+
## <a name="operator_eq"></a> accelerator_view::operator= Operator
240+
Copies the contents of the specified accelerator_view object into this one.
241+
242+
### Syntax
243+
244+
```
245+
accelerator_view & operator= ( const accelerator_view & _Other );
246+
```
247+
248+
### Parameters
249+
`_Other`
250+
The `accelerator_view` object to copy from.
251+
252+
### Return Value
253+
A reference to the modified `accelerator_view` object.
254+
255+
## <a name="operator_eq_eq"></a> accelerator_view::operator== Operator
256+
Compares this accelerator_view object with another and returns `true` if they are the same; otherwise, returns `false`.
257+
258+
### Syntax
259+
260+
```
261+
bool operator= = ( const accelerator_view & _Other ) const;
262+
```
263+
264+
### Parameters
265+
`_Other`
266+
The `accelerator_view` object to compare with this one.
267+
268+
### Return Value
269+
`true` if the two objects are the same; otherwise, `false`.
270+
271+
## <a name="queuing_mode"></a> accelerator_view::queuing_mode Data Member
272+
Gets the queuing mode for the accelerator_view object.
273+
274+
### Syntax
275+
276+
```
277+
__declspec(property(get= get_queuing_mode)) Concurrency::queuing_mode queuing_mode;
278+
```
279+
280+
## <a name="version"></a> accelerator_view::version Data Member
281+
Gets the version of the accelerator_view.
282+
283+
### Syntax
284+
285+
```
286+
__declspec(property(get= get_version)) unsigned int version;
287+
```
288+
289+
## <a name="wait"></a> accelerator_view::wait Method
290+
Waits for all commands submitted to the accelerator_view object to finish.
291+
292+
### Syntax
293+
294+
```
295+
void wait();
296+
```
297+
298+
#### Return Value
299+
Returns `void`.
300+
301+
#### Remarks
302+
If the [queuing_mode](../Topic/queuing_mode__Enumeration) is `immediate`, this method returns immediately without blocking.
303+
304+
## <a name="accelerator_view_dtor"></a> accelerator_view::~accelerator_view Destructor
305+
Destroys the accelerator_view object.
306+
307+
#### Syntax
308+
309+
```
310+
~accelerator_view();
311+
```
312+
313+
### Return Value
314+
315+
101316
## See Also
102-
[Concurrency Namespace (C++ AMP)](../../../parallel/amp/reference/concurrency-namespace-cpp-amp.md)
317+
[Concurrency Namespace (C++ AMP)](../../../parallel/amp/reference/concurrency-namespace-cpp-amp)

‎docs/parallel/amp/reference/accelerator-view-removed-class.md‎

Lines changed: 37 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -50,13 +50,13 @@ class accelerator_view_removed : public runtime_exception;
5050

5151
|Name|Description|
5252
|----------|-----------------|
53-
|[accelerator_view_removed::accelerator_view_removed Constructor](../Topic/accelerator_view_removed::accelerator_view_removed%20Constructor.md)|Initializes a new instance of the `accelerator_view_removed` class.|
53+
|[accelerator_view_removed::accelerator_view_removed Constructor](#accelerator_view_removed_ctor)|Initializes a new instance of the `accelerator_view_removed` class.|
5454

5555
### Public Methods
5656

5757
|Name|Description|
5858
|----------|-----------------|
59-
|[accelerator_view_removed::get_view_removed_reason Method](../Topic/accelerator_view_removed::get_view_removed_reason%20Method.md)|Returns an HRESULT error code indicating the cause of the `accelerator_view` object's removal.|
59+
|[accelerator_view_removed::get_view_removed_reason Method](#get_view_removed_reason)|Returns an HRESULT error code indicating the cause of the `accelerator_view` object's removal.|
6060

6161
## Inheritance Hierarchy
6262
`exception`
@@ -69,6 +69,40 @@ class accelerator_view_removed : public runtime_exception;
6969
**Header:** amprt.h
7070

7171
**Namespace:** Concurrency
72+
73+
## <a name="accelerator_view_removed_ctor"></a> accelerator_view_removed::accelerator_view_removed Constructor
74+
Initializes a new instance of the [accelerator_view_removed](../Topic/accelerator_view_removed%20Class.md) class.
7275

76+
### Syntax
77+
78+
```
79+
explicit accelerator_view_removed(
80+
const char * _Message,
81+
HRESULT _View_removed_reason ) throw();
82+
83+
explicit accelerator_view_removed(
84+
HRESULT _View_removed_reason ) throw();
85+
```
86+
87+
### Parameters
88+
`_Message`
89+
A description of the error.
90+
91+
`_View_removed_reason`
92+
An HRESULT error code indicating the cause of removal of the `accelerator_view` object.
93+
94+
### Return Value
95+
A new instance of the accelerator_view_removed class.
96+
97+
## <a name="get_view_removed_reason"></a> accelerator_view_removed::get_view_removed_reason Method
98+
Returns an HRESULT error code indicating the cause of the `accelerator_view` object's removal.
99+
100+
### Syntax
101+
102+
```
103+
HRESULT get_view_removed_reason() const throw();
104+
```
105+
106+
73107
## See Also
74-
[Concurrency Namespace (C++ AMP)](../../../parallel/amp/reference/concurrency-namespace-cpp-amp.md)
108+
[Concurrency Namespace (C++ AMP)](concurrency-namespace-amp.md)

0 commit comments

Comments
 (0)