Skip to content

Commit 635923b

Browse files
author
Michael Blome
committed
cleaned up headings in amp and concrt per mvp feedback
1 parent 8b57374 commit 635923b

File tree

112 files changed

+1681
-932
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

112 files changed

+1681
-932
lines changed

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

Lines changed: 112 additions & 56 deletions
Large diffs are not rendered by default.

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

Lines changed: 35 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -98,7 +98,7 @@ class accelerator_view;
9898

9999
**Namespace:** Concurrency
100100

101-
## <a name="accelerator"></a> accelerator_view::accelerator Data Member
101+
## <a name="accelerator"></a> accelerator
102102

103103
Gets the accelerator object for the accelerator_view object.
104104

@@ -108,7 +108,8 @@ Gets the accelerator object for the accelerator_view object.
108108
__declspec(property(get= get_accelerator)) Concurrency::accelerator accelerator;
109109
```
110110

111-
## <a name="ctor"></a> accelerator_view::accelerator_view Constructor
111+
## <a name="ctor"></a> accelerator_view
112+
112113
Initializes a new instance of the accelerator_view class by copying an existing `accelerator_view` object.
113114

114115
### Syntax
@@ -121,7 +122,8 @@ accelerator_view( const accelerator_view & _Other );
121122
`_Other`
122123
The `accelerator_view` object to copy.
123124

124-
## <a name="accelerator_view__create_marker"></a> accelerator_view::create_marker Method
125+
## <a name="accelerator_view__create_marker"></a> create_marker
126+
125127
Returns a future to track the completion of all commands submitted so far to this `accelerator_view` object.
126128

127129
### Syntax
@@ -133,7 +135,8 @@ concurrency::completion_future create_marker();
133135
### Return Value
134136
A future to track the completion of all commands submitted so far to this `accelerator_view` object.
135137

136-
## <a name="flush"></a> accelerator_view::flush Method
138+
## <a name="flush"></a> flush
139+
137140
Submits all pending commands queued to the accelerator_view object to the accelerator for execution.
138141

139142
### Syntax
@@ -145,7 +148,8 @@ void flush();
145148
### Return Value
146149
Returns `void`.
147150

148-
## <a name="accelerator_view__get_accelerator"></a> accelerator_view::get_accelerator Method
151+
## <a name="accelerator_view__get_accelerator"></a> get_accelerator
152+
149153
Returns the accelerator object for the accelerator_view object.
150154
### Syntax
151155
```
@@ -154,7 +158,8 @@ accelerator get_accelerator() const;
154158
### Return Value
155159
The accelerator object for the accelerator_view object.
156160

157-
## <a name="accelerator_view__get_is_auto_selection"></a> accelerator_view::get_is_auto_selection Method
161+
## <a name="accelerator_view__get_is_auto_selection"></a> get_is_auto_selection
162+
158163
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).
159164

160165
### Syntax
@@ -166,7 +171,8 @@ bool get_is_auto_selection() const;
166171
### Return Value
167172
`true` if the runtime will automatically select an appropriate accelerator; otherwise, `false`.
168173

169-
## <a name="accelerator_view__get_is_debug"></a> accelerator_view::get_is_debug Method
174+
## <a name="accelerator_view__get_is_debug"></a> get_is_debug
175+
170176
Returns a Boolean value that indicates whether the accelerator_view object has the DEBUG layer enabled for extensive error reporting.
171177

172178
### Syntax
@@ -178,7 +184,8 @@ bool get_is_debug() const;
178184
### Return Value
179185
A Boolean value that indicates whether the `accelerator_view` object has the DEBUG layer enabled for extensive error reporting.
180186

181-
## <a name="accelerator_view__get_queuing_mode"></a> accelerator_view::get_queuing_mode Method
187+
## <a name="accelerator_view__get_queuing_mode"></a> get_queuing_mode
188+
182189
Returns the queuing mode for the accelerator_view object.
183190

184191
### Syntax
@@ -190,7 +197,8 @@ queuing_mode get_queuing_mode() const;
190197
### Return Value
191198
The queuing mode for the `accelerator_view` object.
192199

193-
## <a name="accelerator_view__get_version"></a> accelerator_view::get_version Method
200+
## <a name="accelerator_view__get_version"></a> get_version
201+
194202
Returns the version of the accelerator_view.
195203

196204
### Syntax
@@ -202,7 +210,8 @@ unsigned int get_version() const;
202210
### Return Value
203211
The version of the `accelerator_view`.
204212

205-
## <a name="accelerator_view__is_auto_selection"></a> accelerator_view::is_auto_selection Data Member
213+
## <a name="accelerator_view__is_auto_selection"></a> is_auto_selection
214+
206215
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](concurrency-namespace-functions-amp.md#parallel_for_each).
207216

208217
### Syntax
@@ -211,7 +220,8 @@ Gets a Boolean value that indicates whether the runtime will automatically selec
211220
__declspec(property(get= get_is_auto_selection)) bool is_auto_selection;
212221
```
213222

214-
## <a name="accelerator_view__is_debug"></a> accelerator_view::is_debug Data Member
223+
## <a name="accelerator_view__is_debug"></a> is_debug
224+
215225
Gets a Boolean value that indicates whether the accelerator_view object has the DEBUG layer enabled for extensive error reporting.
216226

217227
### Syntax
@@ -220,7 +230,8 @@ Gets a Boolean value that indicates whether the accelerator_view object has the
220230
__declspec(property(get= get_is_debug)) bool is_debug;
221231
```
222232

223-
## <a name="accelerator_view__operator_neq"></a> accelerator_view::operator!= Operator
233+
## <a name="accelerator_view__operator_neq"></a> operator!=
234+
224235
Compares this accelerator_view object with another and returns `false` if they are the same; otherwise, returns `true`.
225236

226237
### Syntax
@@ -236,7 +247,8 @@ bool operator!= ( const accelerator_view & _Other ) const;
236247
### Return Value
237248
`false` if the two objects are the same; otherwise, `true`.
238249

239-
## <a name="accelerator_view__operator_eq"></a> accelerator_view::operator= Operator
250+
## <a name="accelerator_view__operator_eq"></a> operator=
251+
240252
Copies the contents of the specified accelerator_view object into this one.
241253

242254
### Syntax
@@ -252,7 +264,8 @@ accelerator_view & operator= ( const accelerator_view & _Other );
252264
### Return Value
253265
A reference to the modified `accelerator_view` object.
254266

255-
## <a name="accelerator_view__operator_eq_eq"></a> accelerator_view::operator== Operator
267+
## <a name="accelerator_view__operator_eq_eq"></a> operator==
268+
256269
Compares this accelerator_view object with another and returns `true` if they are the same; otherwise, returns `false`.
257270

258271
### Syntax
@@ -268,7 +281,8 @@ bool operator= = ( const accelerator_view & _Other ) const;
268281
### Return Value
269282
`true` if the two objects are the same; otherwise, `false`.
270283

271-
## <a name="accelerator_view__queuing_mode"></a> accelerator_view::queuing_mode Data Member
284+
## <a name="accelerator_view__queuing_mode"></a> queuing_mode
285+
272286
Gets the queuing mode for the accelerator_view object.
273287

274288
### Syntax
@@ -277,7 +291,8 @@ Gets the queuing mode for the accelerator_view object.
277291
__declspec(property(get= get_queuing_mode)) Concurrency::queuing_mode queuing_mode;
278292
```
279293

280-
## <a name="accelerator_view__version"></a> accelerator_view::version Data Member
294+
## <a name="accelerator_view__version"></a> version
295+
281296
Gets the version of the accelerator_view.
282297

283298
### Syntax
@@ -286,7 +301,8 @@ Gets the version of the accelerator_view.
286301
__declspec(property(get= get_version)) unsigned int version;
287302
```
288303

289-
## <a name="accelerator_view__wait"></a> accelerator_view::wait Method
304+
## <a name="accelerator_view__wait"></a> wait
305+
290306
Waits for all commands submitted to the accelerator_view object to finish.
291307

292308
### Syntax
@@ -301,7 +317,8 @@ void wait();
301317
#### Remarks
302318
If the [queuing_mode](concurrency-namespace-enums-amp.md#queuing_mode) is `immediate`, this method returns immediately without blocking.
303319

304-
## <a name="dtor"></a> accelerator_view::~accelerator_view Destructor
320+
## <a name="dtor"></a> ~accelerator_view
321+
305322
Destroys the accelerator_view object.
306323

307324
#### Syntax

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

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -70,7 +70,8 @@ class accelerator_view_removed : public runtime_exception;
7070

7171
**Namespace:** Concurrency
7272

73-
## <a name="ctor"></a> accelerator_view_removed::accelerator_view_removed Constructor
73+
## <a name="ctor"></a> accelerator_view_removed
74+
7475
Initializes a new instance of the [accelerator_view_removed](accelerator-view-removed-class.md) class.
7576

7677
### Syntax
@@ -94,7 +95,8 @@ explicit accelerator_view_removed(
9495
### Return Value
9596
A new instance of the accelerator_view_removed class.
9697

97-
## <a name="get_view_removed_reason_method"></a> accelerator_view_removed::get_view_removed_reason Method
98+
## <a name="get_view_removed_reason_method"></a> get_view_removed_reason
99+
98100
Returns an HRESULT error code indicating the cause of the `accelerator_view` object's removal.
99101

100102
### Syntax

docs/parallel/amp/reference/array-class.md

Lines changed: 40 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -122,21 +122,24 @@ friend class array;
122122

123123
**Namespace:** Concurrency
124124

125-
## <a name="dtor"></a> array::~array Destructor
125+
## <a name="dtor"></a> ~array
126+
126127
Destroys the `array` object.
127128

128129
```
129130
~array() restrict(cpu);
130131
```
131132

132-
## <a name="accelerator_view"></a> array::accelerator_view Data Member
133+
## <a name="accelerator_view"></a> accelerator_view
134+
133135
Gets the [accelerator_view](accelerator-view-class.md) object that represents the location where the array is allocated. This property can be accessed only on the CPU.
134136

135137
```
136138
__declspec(property(get= get_accelerator_view)) Concurrency::accelerator_view accelerator_view;
137139
```
138140

139-
## <a name="ctor"></a> array::array Constructor
141+
## <a name="ctor"></a> array
142+
140143
Initializes a new instance of the [array class](array-class.md). There is no default constructor for `array<T,N>`. All constructors are run on the CPU only. They cannot be executed on a Direct3D target.
141144

142145
```
@@ -438,14 +441,16 @@ array(array&& _Other) restrict(cpu);
438441
`value_type`
439442
The data type of the elements that are copied.
440443

441-
## <a name="associated_accelerator_view"></a> array::associated_accelerator_view Data Member
444+
## <a name="associated_accelerator_view"></a> associated_accelerator_view
445+
442446
Gets the second [accelerator_view](accelerator-view-class.md) object that is passed as a parameter when a staging constructor is called to instantiate the `array` object.
443447

444448
```
445449
__declspec(property(get= get_associated_accelerator_view)) Concurrency::accelerator_view associated_accelerator_view;
446450
```
447451

448-
## <a name="copy_to"></a> array::copy_to Method
452+
## <a name="copy_to"></a> copy_to
453+
449454
Copies the contents of the `array` to another `array`.
450455

451456
```
@@ -460,14 +465,16 @@ void copy_to(
460465
`_Dest`
461466
The [array_view](array-view-class.md) object to copy to.
462467

463-
## <a name="cpu_access_type"></a> array::cpu_access_type Data Member
468+
## <a name="cpu_access_type"></a> cpu_access_type
469+
464470
Gets the CPU access_type allowed for this array.
465471

466472
```
467473
__declspec(property(get= get_cpu_access_type)) access_type cpu_access_type;
468474
```
469475

470-
## <a name="data"></a> array::data Method
476+
## <a name="data"></a> data
477+
471478
Returns a pointer to the raw data of the `array`.
472479

473480
```
@@ -479,14 +486,16 @@ const value_type* data() const restrict(amp, cpu);
479486
### Return Value
480487
A pointer to the raw data of the array.
481488

482-
## <a name="extent"></a> array::extent Data Member
489+
## <a name="extent"></a> extent
490+
483491
Gets the [extent](extent-class.md) object that defines the shape of the `array`.
484492

485493
```
486494
__declspec(property(get= get_extent)) Concurrency::extent<_Rank> extent;
487495
```
488496

489-
## <a name="get_accelerator_view"></a> array::get_accelerator_view Method
497+
## <a name="get_accelerator_view"></a> get_accelerator_view
498+
490499
Returns the [accelerator_view](accelerator-view-class.md) object that represents the location where the `array` object is allocated. This property can be accessed only on the CPU.
491500

492501
```
@@ -496,7 +505,8 @@ Concurrency::accelerator_view get_accelerator_view() const;
496505
### Return Value
497506
The `accelerator_view` object that represents the location where the `array` object is allocated.
498507

499-
## <a name="get_associated_accelerator_view"></a> array::get_associated_accelerator_view Method
508+
## <a name="get_associated_accelerator_view"></a> get_associated_accelerator_view
509+
500510
Gets the second [accelerator_view](accelerator-view-class.md) object that is passed as a parameter when a staging constructor is called to instantiate the `array` object.
501511

502512
```
@@ -506,7 +516,8 @@ Concurrency::accelerator_view get_associated_accelerator_view() const ;
506516
### Return Value
507517
The second [accelerator_view](accelerator-view-class.md) object passed to the staging constructor.
508518

509-
## <a name="get_cpu_access_type"></a> array::get_cpu_access_type Method
519+
## <a name="get_cpu_access_type"></a> get_cpu_access_type
520+
510521
Returns the CPU access_type that's allowed for this array.
511522

512523
```
@@ -515,7 +526,8 @@ access_type get_cpu_access_type() const restrict(cpu);
515526

516527
### Return Value
517528

518-
## <a name="get_extent"></a> array::get_extent Method
529+
## <a name="get_extent"></a> get_extent
530+
519531
Returns the [extent](extent-class.md) object of the `array`.
520532

521533
```
@@ -525,7 +537,8 @@ Concurrency::extent<_Rank> get_extent() const restrict(amp,cpu);
525537
### Return Value
526538
The `extent` object of the `array`.
527539

528-
## <a name="operator_vec"></a> array::operator std::vector&lt;value_type&gt; Operator
540+
## <a name="operator_vec"></a> operator std::vector&lt;value_type&gt;
541+
529542
Uses `copy(*this, vector)` to implicitly convert the array to a std::vector object.
530543

531544
```
@@ -539,7 +552,8 @@ operator std::vector<value_type>() const restrict(cpu);
539552
### Return Value
540553
An object of type `vector<T>` that contains a copy of the data that is contained in the array.
541554

542-
## <a name="operator_call"></a> array::operator() Operator
555+
## <a name="operator_call"></a> operator()
556+
543557
Returns the element value that is specified by the parameters.
544558

545559
```
@@ -579,7 +593,8 @@ typename details::_Projection_result_type<value_type,_Rank>::_Const_result_type
579593
### Return Value
580594
The element value specified by the parameters.
581595

582-
## <a name="operator_at"></a> array::operator[] Operator
596+
## <a name="operator_at"></a> operator[]
597+
583598
Returns the element that is at the specified index.
584599

585600
```
@@ -603,7 +618,8 @@ typename details::_Projection_result_type<value_type,_Rank>::_Const_result_type
603618
### Return Value
604619
The element that is at the specified index.
605620

606-
## <a name="operator_eq"></a> array::operator= Operator
621+
## <a name="operator_eq"></a> operator=
622+
607623
Copies the contents of the specified `array` object.
608624

609625
```
@@ -625,13 +641,15 @@ array& operator= (
625641
### Return Value
626642
A reference to this `array` object.
627643

628-
## <a name="rank"></a> array::rank Constant
644+
## <a name="rank"></a> rank
645+
629646
Stores the rank of the `array`.
630647

631648
```
632649
static const int rank = _Rank;
633650
```
634-
## <a name="reinterpret_as"></a> array::reinterpret_as Method
651+
## <a name="reinterpret_as"></a> reinterpret_as
652+
635653
Reinterprets the array through a one-dimensional array_view, which optionally may have a different value type than the source array.
636654

637655
### Syntax
@@ -665,7 +683,8 @@ array_view<float,1> v = a.reinterpret_as<float>();
665683
assert(v.extent == 3*a.extent);
666684
```
667685
668-
## <a name="section"></a> array::section Method
686+
## <a name="section"></a> section
687+
669688
Returns a subsection of the `array` object that is at the specified origin and, optionally, that has the specified extent.
670689
671690
```
@@ -766,7 +785,8 @@ array_view<const value_type,3> section(
766785
### Return Value
767786
Returns a subsection of the `array` object that is at the specified origin and, optionally, that has the specified extent. When only the `index` object is specified, the subsection contains all elements in the associated grid that have indexes that are larger than the indexes of the elements in the `index` object.
768787
769-
## <a name="view_as"></a> array::view_as Method
788+
## <a name="view_as"></a> view_as
789+
770790
Reinterprets this array as an [array_view](array-view-class.md) of a different rank.
771791
772792
```

0 commit comments

Comments
 (0)