Skip to content

Commit 79055e8

Browse files
authored
Merge pull request #1001 from msebolt/consolidation-final
consolidation final edits
2 parents f21847f + 270f5e6 commit 79055e8

17 files changed

+48
-42
lines changed

docs/dotnet/TOC.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -172,14 +172,14 @@
172172
### [How to: Convert from a .NET Collection to a STL/CLR Container](how-to-convert-from-a-dotnet-collection-to-a-stl-clr-container.md)
173173
### [How to: Convert from a STL/CLR Container to a .NET Collection](how-to-convert-from-a-stl-clr-container-to-a-dotnet-collection.md)
174174
### [How to: Expose an STL/CLR Container from an Assembly](how-to-expose-an-stl-clr-container-from-an-assembly.md)
175-
### [adapter (STL/CLR)](adapter-stl-clr.md)
176-
### [algorithm (STL/CLR)](algorithm-stl-clr.md)
177-
### [deque (STL/CLR)](deque-stl-clr.md)
178175
### [for each, in](for-each-in.md)
179176
#### [Iterating Over C++ Standard Library Collection By Using for each](iterating-over-stl-collection-by-using-for-each.md)
180177
#### [How to: Iterate Over Arrays with for each](how-to-iterate-over-arrays-with-for-each.md)
181178
#### [How to: Iterate Over a Generic Collection with for each](how-to-iterate-over-a-generic-collection-with-for-each.md)
182179
#### [How to: Iterate Over a User-Defined Collection with for each](how-to-iterate-over-a-user-defined-collection-with-for-each.md)
180+
### [adapter (STL/CLR)](adapter-stl-clr.md)
181+
### [algorithm (STL/CLR)](algorithm-stl-clr.md)
182+
### [deque (STL/CLR)](deque-stl-clr.md)
183183
### [functional (STL/CLR)](functional-stl-clr.md)
184184
### [hash_map (STL/CLR)](hash-map-stl-clr.md)
185185
### [hash_multimap (STL/CLR)](hash-multimap-stl-clr.md)

docs/dotnet/adapter-stl-clr.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ The STL/CLR header `<cliext/adapter>` specifies two template classes (`collectio
3232

3333
**Namespace:** cliext
3434

35-
## Members
35+
## Declarations
3636

3737
|Class|Description|
3838
|-----------|-----------------|
@@ -43,6 +43,8 @@ The STL/CLR header `<cliext/adapter>` specifies two template classes (`collectio
4343
|--------------|-----------------|
4444
|[make_collection (STL/CLR)](#make_collection)|Creates a range adapter using an iterator pair.|
4545

46+
## Members
47+
4648
## <a name="collection_adapter"></a> collection_adapter (STL/CLR)
4749
Wraps a .NET collection for use as an STL/CLR container. A `collection_adapter` is a template class that describes a simple STL/CLR container object. It wraps a Base Class Library (BCL) interface, and returns an iterator pair that you use to manipulate the controlled sequence.
4850

docs/dotnet/algorithm-stl-clr.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ Defines STL/CLR container template functions that perform algorithms.
4444

4545
**Namespace:** cliext
4646

47-
## Functions
47+
## Declarations
4848

4949
|Function|Description|
5050
|--------------|-----------------|
@@ -115,6 +115,7 @@ Defines STL/CLR container template functions that perform algorithms.
115115
|[unique_copy (STL/CLR)](#unique_copy)|Copies elements from a source range into a destination range except for the duplicate elements that are adjacent to each other.|
116116
|[upper_bound (STL/CLR)](#upper_bound)|Finds the position of the first element in an ordered range that has a value that is greater than a specified value, where the ordering criterion may be specified by a binary predicate.|
117117

118+
## Members
118119

119120
## <a name="adjacent_find"></a> adjacent_find (STL/CLR)
120121
Searches for two adjacent elements that are either equal or satisfy a specified condition.

docs/dotnet/deque-stl-clr.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@ template<typename Value>
5757

5858
**Namespace:** cliext
5959

60-
## Members
60+
## Declarations
6161

6262
|Type Definition|Description|
6363
|---------------------|-----------------|
@@ -138,7 +138,7 @@ template<typename Value>
138138

139139
Erasing or removing an element calls the destructor for its stored value. Destroying the container erases all elements. Thus, a container whose element type is a ref class ensures that no elements outlive the container. Note, however, that a container of handles does `not` destroy its elements.
140140

141-
## Member Definitions
141+
## Members
142142

143143
## <a name="assign"></a> deque::assign (STL/CLR)
144144
Replaces all elements.

docs/dotnet/hash-multimap-stl-clr.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@ template<typename Key,
5757
{ ..... };
5858
```
5959

60-
#### Parameters
60+
### Parameters
6161
Key
6262
The type of the key component of an element in the controlled sequence.
6363

docs/dotnet/hash-multiset-stl-clr.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ template<typename Key>
4848
{ ..... };
4949
```
5050

51-
#### Parameters
51+
### Parameters
5252
Key
5353
The type of the key component of an element in the controlled sequence.
5454

@@ -57,7 +57,7 @@ template<typename Key>
5757

5858
**Namespace:** cliext
5959

60-
## Members
60+
## Declarations
6161

6262
|Type Definition|Description|
6363
|---------------------|-----------------|
@@ -122,7 +122,7 @@ template<typename Key>
122122
|<xref:System.Collections.Generic.ICollection%601>|Maintain group of typed elements.|
123123
|IHash\<Key, Value>|Maintain generic container.|
124124

125-
### Remarks
125+
## Remarks
126126
The object allocates and frees storage for the sequence it controls as individual nodes in a bidirectional linked list. To speed access, the object also maintains a varying-length array of pointers into the list (the hash table), effectively managing the whole list as a sequence of sublists, or buckets. It inserts elements into a bucket that it keeps ordered by altering the links between nodes, never by copying the contents of one node to another. That means you can insert and remove elements freely without disturbing remaining elements.
127127

128128
The object orders each bucket it controls by calling a stored delegate object of type [hash_set::key_compare (STL/CLR)](../dotnet/hash-set-key-compare-stl-clr.md). You can specify the stored delegate object when you construct the hash_set; if you specify no delegate object, the default is the comparison `operator<=(key_type, key_type)`.
@@ -155,6 +155,8 @@ template<typename Key>
155155

156156
Erasing or removing an element calls the destructor for its stored value. Destroying the container erases all elements. Thus, a container whose element type is a ref class ensures that no elements outlive the container. Note, however, that a container of handles does `not` destroy its elements.
157157

158+
## Members
159+
158160
## <a name="begin"></a> hash_multiset::begin (STL/CLR)
159161
Designates the beginning of the controlled sequence.
160162

docs/dotnet/hash-set-stl-clr.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ The template class describes an object that controls a varying-length sequence o
3131

3232
In the description below, `GValue` is the same as `GKey`, which in turn is the same as `Key` unless the latter is a ref type, in which case it is `Key^`.
3333

34-
### Syntax
34+
## Syntax
3535

3636
```
3737
template<typename Key>
@@ -47,7 +47,7 @@ template<typename Key>
4747
{ ..... };
4848
```
4949

50-
#### Parameters
50+
### Parameters
5151
Key
5252
The type of the key component of an element in the controlled sequence.
5353

@@ -56,7 +56,7 @@ template<typename Key>
5656

5757
**Namespace:** cliext
5858

59-
## Members
59+
## Declarations
6060

6161
|Type Definition|Description|
6262
|---------------------|-----------------|
@@ -121,7 +121,7 @@ template<typename Key>
121121
|<xref:System.Collections.Generic.ICollection%601>|Maintain group of typed elements.|
122122
|IHash\<Key, Value>|Maintain generic container.|
123123

124-
### Remarks
124+
## Remarks
125125
The object allocates and frees storage for the sequence it controls as individual nodes in a bidirectional linked list. To speed access, the object also maintains a varying-length array of pointers into the list (the hash table), effectively managing the whole list as a sequence of sublists, or buckets. It inserts elements into a bucket that it keeps ordered by altering the links between nodes, never by copying the contents of one node to another. That means you can insert and remove elements freely without disturbing remaining elements.
126126

127127
The object orders each bucket it controls by calling a stored delegate object of type [hash_set::key_compare (STL/CLR)](../dotnet/hash-set-key-compare-stl-clr.md). You can specify the stored delegate object when you construct the hash_set; if you specify no delegate object, the default is the comparison `operator<=(key_type, key_type)`.
@@ -154,6 +154,8 @@ template<typename Key>
154154

155155
Erasing or removing an element calls the destructor for its stored value. Destroying the container erases all elements. Thus, a container whose element type is a ref class ensures that no elements outlive the container. Note, however, that a container of handles does `not` destroy its elements.
156156

157+
## Members
158+
157159
## <a name="begin"></a> hash_set::begin (STL/CLR)
158160
Designates the beginning of the controlled sequence.
159161

docs/dotnet/list-stl-clr.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ template<typename Value>
4646
{ ..... };
4747
```
4848

49-
#### Parameters
49+
### Parameters
5050
Value
5151
The type of an element in the controlled sequence.
5252

@@ -55,7 +55,7 @@ template<typename Value>
5555

5656
**Namespace:** cliext
5757

58-
## Members
58+
## Declarations
5959

6060
|Type Definition|Description|
6161
|---------------------|-----------------|
@@ -140,6 +140,8 @@ template<typename Value>
140140

141141
Erasing or removing an element calls the destructor for its stored value. Destroying the container erases all elements. Thus, a container whose element type is a ref class ensures that no elements outlive the container. Note, however, that a container of handles does `not` destroy its elements.
142142

143+
## Members
144+
143145
## <a name="assign"></a> list::assign (STL/CLR)
144146
Replaces all elements.
145147

docs/dotnet/map-stl-clr.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,7 @@ template<typename Key,
6565
{ ..... };
6666
```
6767

68-
#### Parameters
68+
### Parameters
6969
Key
7070
The type of the key component of an element in the controlled sequence.
7171

docs/dotnet/multimap-stl-clr.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ The template class describes an object that controls a varying-length sequence o
4545

4646
`GMapped` is the same as `Mapped` unless the latter is a ref type, in which case it is `Mapped^`
4747

48-
### Syntax
48+
## Syntax
4949

5050
```
5151
template<typename Key,
@@ -62,7 +62,7 @@ template<typename Key,
6262
{ ..... };
6363
```
6464

65-
#### Parameters
65+
### Parameters
6666
Key
6767
The type of the key component of an element in the controlled sequence.
6868

@@ -140,7 +140,7 @@ template<typename Key,
140140
|<xref:System.Collections.Generic.ICollection%601>|Maintain group of typed elements.|
141141
|ITree\<Key, Value>|Maintain generic container.|
142142

143-
### Remarks
143+
## Remarks
144144
The object allocates and frees storage for the sequence it controls as individual nodes. It inserts elements into a (nearly) balanced tree that it keeps ordered by altering the links between nodes, never by copying the contents of one node to another. That means you can insert and remove elements freely without disturbing remaining elements.
145145

146146
The object orders the sequence it controls by calling a stored delegate object of type [multimap::key_compare (STL/CLR)](../dotnet/multimap-key-compare-stl-clr.md). You can specify the stored delegate object when you construct the multimap; if you specify no delegate object, the default is the comparison `operator<(key_type, key_type)`. You access this stored object by calling the member function [multimap::key_comp (STL/CLR)](../dotnet/multimap-key-comp-stl-clr.md)`()`.

docs/dotnet/multiset-stl-clr.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ template<typename Key>
5454
{ ..... };
5555
```
5656

57-
#### Parameters
57+
### Parameters
5858
Key
5959
The type of the key component of an element in the controlled sequence.
6060

docs/dotnet/numeric-stl-clr.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ Defines container template functions that perform algorithms provided for numeri
3535
|[inner_product (STL/CLR)](#inner_product)|Computes the sum of the element-wise product of two ranges and adds it to a specified initial value or computes the result of a generalized procedure where the sum and product binary operations are replaced by other specified binary operations.|
3636
|[partial_sum (STL/CLR)](#partial_sum)|Computes a series of sums in an input range from the first element through the `i`th element and stores the result of each such sum in `i`th element of a destination range or computes the result of a generalized procedure where the sum operation is replaced by another specified binary operation.|
3737

38-
## Functions
38+
## Members
3939

4040
## <a name="accumulate"></a> accumulate (STL/CLR)
4141
Computes the sum of all the elements in a specified range including some initial value by computing successive partial sums or computes the result of successive partial results similarly obtained from using a specified binary operation other than the sum.

docs/dotnet/priority-queue-stl-clr.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ The template class describes an object that controls a varying-length ordered se
2727

2828
In the description below, `GValue` is the same as `Value` unless the latter is a ref type, in which case it is `Value^`. Similarly, `GContainer` is the same as `Container` unless the latter is a ref type, in which case it is `Container^`.
2929

30-
### Syntax
30+
## Syntax
3131

3232
```
3333
template<typename Value,
@@ -38,7 +38,7 @@ template<typename Value,
3838
{ ..... };
3939
```
4040

41-
#### Parameters
41+
### Parameters
4242
Value
4343
The type of an element in the controlled sequence.
4444

@@ -92,7 +92,7 @@ template<typename Value,
9292
|<xref:System.ICloneable>|Duplicate an object.|
9393
|IPriorityQueue\<Value, Container>|Maintain generic container adapter.|
9494

95-
### Remarks
95+
## Remarks
9696
The object allocates and frees storage for the sequence it controls through an underlying container, of type `Container`, that stores `Value` elements and grows on demand. It keeps the sequence ordered as a heap, with the highest-priority element (the top element) readily accessible and removable. The object restricts access to pushing new elements and popping just the highest-priority element, implementing a priority queue.
9797

9898
The object orders the sequence it controls by calling a stored delegate object of type [priority_queue::value_compare (STL/CLR)](../dotnet/priority-queue-value-compare-stl-clr.md). You can specify the stored delegate object when you construct the priority_queue; if you specify no delegate object, the default is the comparison `operator<(value_type, value_type)`. You access this stored object by calling the member function [priority_queue::value_comp (STL/CLR)](../dotnet/priority-queue-value-comp-stl-clr.md)`()`.

docs/dotnet/queue-stl-clr.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ template<typename Value,
4141
{ ..... };
4242
```
4343

44-
#### Parameters
44+
### Parameters
4545
Value
4646
The type of an element in the controlled sequence.
4747

@@ -101,7 +101,7 @@ template<typename Value,
101101
|<xref:System.ICloneable>|Duplicate an object.|
102102
|IQueue\<Value, Container>|Maintain generic container adapter.|
103103

104-
### Remarks
104+
## Remarks
105105
The object allocates and frees storage for the sequence it controls through an underlying container, of type `Container`, that stores `Value` elements and grows on demand. The object restricts access to just pushing the first element and popping the last element, implementing a first-in first-out queue (also known as a FIFO queue, or simply a queue).
106106

107107
## Members

docs/dotnet/set-stl-clr.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ The template class describes an object that controls a varying-length sequence o
3737

3838
In the description below, `GValue` is the same as `GKey`, which in turn is the same as `Key` unless the latter is a ref type, in which case it is `Key^`.
3939

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

4242
```
4343
template<typename Key>
@@ -53,10 +53,15 @@ template<typename Key>
5353
{ ..... };
5454
```
5555

56-
#### Parameters
56+
### Parameters
5757
Key
5858
The type of the key component of an element in the controlled sequence.
5959

60+
## Requirements
61+
**Header:** \<cliext/set>
62+
63+
**Namespace:** cliext
64+
6065
## Declarations
6166

6267
|Type Definition|Description|
@@ -122,7 +127,7 @@ template<typename Key>
122127
|<xref:System.Collections.Generic.ICollection%601>|Maintain group of typed elements.|
123128
|ITree\<Key, Value>|Maintain generic container.|
124129

125-
### Remarks
130+
## Remarks
126131
The object allocates and frees storage for the sequence it controls as individual nodes. It inserts elements into a (nearly) balanced tree that it keeps ordered by altering the links between nodes, never by copying the contents of one node to another. That means you can insert and remove elements freely without disturbing remaining elements.
127132

128133
The object orders the sequence it controls by calling a stored delegate object of type [set::key_compare (STL/CLR)](../dotnet/set-key-compare-stl-clr.md). You can specify the stored delegate object when you construct the set; if you specify no delegate object, the default is the comparison `operator<(key_type, key_type)`. You access this stored object by calling the member function [set::key_comp (STL/CLR)](../dotnet/set-key-comp-stl-clr.md)`()`.
@@ -148,11 +153,6 @@ template<typename Key>
148153
A set iterator stores a handle to its associated set node, which in turn stores a handle to its associated container. You can use iterators only with their associated container objects. A set iterator remains valid so long as its associated set node is associated with some set. Moreover, a valid iterator is dereferencable -- you can use it to access or alter the element value it designates -- so long as it is not equal to `end()`.
149154

150155
Erasing or removing an element calls the destructor for its stored value. Destroying the container erases all elements. Thus, a container whose element type is a ref class ensures that no elements outlive the container. Note, however, that a container of handles does `not` destroy its elements.
151-
152-
## Requirements
153-
**Header:** \<cliext/set>
154-
155-
**Namespace:** cliext
156156

157157
## Members
158158

docs/dotnet/stack-stl-clr.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ template<typename Value,
4141
{ ..... };
4242
```
4343

44-
#### Parameters
44+
### Parameters
4545
Value
4646
The type of an element in the controlled sequence.
4747

docs/dotnet/vector-stl-clr.md

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ template<typename Value>
5353
{ ..... };
5454
```
5555

56-
#### Parameters
56+
### Parameters
5757
Value
5858
The type of an element in the controlled sequence.
5959

@@ -143,10 +143,7 @@ template<typename Value>
143143

144144
Erasing or removing an element calls the destructor for its stored value. Destroying the container erases all elements. Thus, a container whose element type is a ref class ensures that no elements outlive the container. Note, however, that a container of handles does not destroy its elements.
145145

146-
## Requirements
147-
**Header:** \<cliext/vector>
148-
149-
**Namespace:** cliext
146+
## Members
150147

151148
## <a name="assign"></a> vector::assign (STL/CLR)
152149
Replaces all elements.

0 commit comments

Comments
 (0)