Skip to content

Commit dcefc14

Browse files
author
Colin Robertson
committed
Fix stray underscores, formatting
1 parent 0c60b47 commit dcefc14

File tree

9 files changed

+263
-247
lines changed

9 files changed

+263
-247
lines changed

docs/standard-library/hash-multiset-class.md

Lines changed: 60 additions & 43 deletions
Original file line numberDiff line numberDiff line change
@@ -751,24 +751,25 @@ Inserts an element constructed in place into a hash_multiset, with a placement h
751751
```cpp
752752
template <class ValTy>
753753
iterator insert(
754-
const_iterator _Where,
754+
const_iterator where,
755755
ValTy&& val);
756756
```
757757
758758
### Parameters
759759
760-
|Parameter|Description|
761-
|-|-|
762-
|*val*|The value of an element to be inserted into the [hash_multiset](../standard-library/hash-multiset-class.md) unless the `hash_multiset` already contains that element or, more generally, an element whose key is equivalently ordered.|
763-
|*_Where*|The place to start searching for the correct point of insertion. (Insertion can occur in amortized constant time, instead of logarithmic time, if the insertion point immediately follows *_Where*.)|
760+
*val*\
761+
The value of an element to be inserted into the [hash_multiset](../standard-library/hash-multiset-class.md) unless the `hash_multiset` already contains that element or, more generally, an element whose key is equivalently ordered.
762+
763+
*where*\
764+
The place to start searching for the correct point of insertion. (Insertion can occur in amortized constant time, instead of logarithmic time, if the insertion point immediately follows *where*.)
764765
765766
### Return Value
766767
767768
The [hash_multiset::emplace](#emplace) member function returns an iterator that points to the position where the new element was inserted into the `hash_multiset`.
768769
769770
### Remarks
770771
771-
Insertion can occur in amortized constant time, instead of logarithmic time, if the insertion point immediately follows *_Where*.
772+
Insertion can occur in amortized constant time, instead of logarithmic time, if the insertion point immediately follows *where*.
772773
773774
### Example
774775
@@ -1003,7 +1004,7 @@ The hash_multiset hms1 doesn't have an element with a key less than 40.
10031004
Removes an element or a range of elements in a hash_multiset from specified positions or removes elements that match a specified key.
10041005

10051006
```cpp
1006-
iterator erase(iterator _Where);
1007+
iterator erase(iterator where);
10071008

10081009
iterator erase(iterator first, iterator last);
10091010

@@ -1012,7 +1013,7 @@ size_type erase(const key_type& key);
10121013
10131014
### Parameters
10141015
1015-
*_Where*\
1016+
*where*\
10161017
Position of the element to be removed from the hash_multiset.
10171018
10181019
*first*\
@@ -1304,33 +1305,42 @@ hash_multiset(
13041305
13051306
template <class InputIterator>
13061307
hash_multiset(
1307-
InputIterator First,
1308-
InputIterator Last);
1308+
InputIterator first,
1309+
InputIterator last);
13091310
13101311
template <class InputIterator>
13111312
hash_multiset(
1312-
InputIterator First,
1313-
InputIterator Last,
1313+
InputIterator first,
1314+
InputIterator last,
13141315
const Traits& Comp);
13151316
13161317
template <class InputIterator>
13171318
hash_multiset(
1318-
InputIterator First,
1319-
InputIterator Last,
1319+
InputIterator first,
1320+
InputIterator last,
13201321
const Traits& Comp,
13211322
const Allocator& Al);
13221323
```
13231324

13241325
### Parameters
13251326

1326-
|Parameter|Description|
1327-
|-|-|
1328-
|*Al*|The storage allocator class to be used for this `hash_multiset` object, which defaults to `Allocator`.|
1329-
|*Comp*|The comparison function of type `const Traits` used to order the elements in the `hash_multiset`, which defaults to `hash_compare`.|
1330-
|*Right*|The `hash_multiset` of which the constructed `hash_multiset` is to be a copy.|
1331-
|*First*|The position of the first element in the range of elements to be copied.|
1332-
|*Last*|The position of the first element beyond the range of elements to be copied.|
1333-
|*IList*|The initializer_list that contains the elements to be copied.|
1327+
*Al*\
1328+
The storage allocator class to be used for this `hash_multiset` object, which defaults to `Allocator`.
1329+
1330+
*Comp*\
1331+
The comparison function of type `const Traits` used to order the elements in the `hash_multiset`, which defaults to `hash_compare`.
1332+
1333+
*Right*\
1334+
The `hash_multiset` of which the constructed `hash_multiset` is to be a copy.
1335+
1336+
*first*\
1337+
The position of the first element in the range of elements to be copied.
1338+
1339+
*last*\
1340+
The position of the first element beyond the range of elements to be copied.
1341+
1342+
*IList*\
1343+
The initializer_list that contains the elements to be copied.
13341344

13351345
### Remarks
13361346

@@ -1346,7 +1356,7 @@ The fourth constructor moves the `hash_multiset` `Right`.
13461356

13471357
The fifth, sixth, and seventh constructors use an initializer_list.
13481358

1349-
The last three constructors copy the range [ `First`, `Last`) of a `hash_multiset` with increasing explicitness in specifying the type of comparison function of class Compare and allocator.
1359+
The last three constructors copy the range [ `first`, `last`) of a `hash_multiset` with increasing explicitness in specifying the type of comparison function of class Compare and allocator.
13501360

13511361
The actual order of elements in a hashed set container depends on the hash function, the ordering function and the current size of the hash table and cannot, in general, be predicted as it could with the set container, where it was determined by the ordering function alone.
13521362

@@ -1359,58 +1369,65 @@ Inserts an element or a range of elements into a hash_multiset.
13591369

13601370
```cpp
13611371
iterator insert(
1362-
const Type& Val);
1372+
const Type& value);
13631373

13641374
iterator insert(
1365-
iterator Where,
1375+
iterator where,
13661376
const Type& Al);
13671377

13681378
void insert(
13691379
initializer_list<Type> IList);
13701380

13711381
iterator insert(
1372-
const Type& Val);
1382+
const Type& value);
13731383

13741384
iterator insert(
1375-
Iterator Where,
1376-
const Type& Val);
1385+
Iterator where,
1386+
const Type& value);
13771387

13781388
template <class InputIterator>
13791389
void insert(
1380-
InputIterator First,
1381-
InputIterator Last);
1390+
InputIterator first,
1391+
InputIterator last);
13821392

13831393
template <class ValTy>
13841394
iterator insert(
1385-
ValTy&& Val);
1395+
ValTy&& value);
13861396

13871397
template <class ValTy>
13881398
iterator insert(
1389-
const_iterator Where,
1390-
ValTy&& Val);
1399+
const_iterator where,
1400+
ValTy&& value);
13911401
```
13921402
13931403
### Parameters
13941404
1395-
|Parameter|Description|
1396-
|-|-|
1397-
|*Val*|The value of an element to be inserted into the hash_multiset unless the hash_multiset already contains that element or, more generally, an element whose key is equivalently ordered.|
1398-
|*Where*|The place to start searching for the correct point of insertion. (Insertion can occur in amortized constant time, instead of logarithmic time, if the insertion point immediately follows `_Where`.)|
1399-
|*First*|The position of the first element to be copied from a hash_multiset.|
1400-
|*Last*|The position just beyond the last element to be copied from a hash_multiset.|
1401-
|*IList*|The initializer_list that contains the elements to copy.|
1405+
*value*\
1406+
The value of an element to be inserted into the hash_multiset unless the hash_multiset already contains that element or, more generally, an element whose key is equivalently ordered.
1407+
1408+
*where*\
1409+
The place to start searching for the correct point of insertion. (Insertion can occur in amortized constant time, instead of logarithmic time, if the insertion point immediately follows *where*.)
1410+
1411+
*first*\
1412+
The position of the first element to be copied from a hash_multiset.
1413+
1414+
*last*\
1415+
The position just beyond the last element to be copied from a hash_multiset.
1416+
1417+
*IList*\
1418+
The initializer_list that contains the elements to copy.
14021419
14031420
### Return Value
14041421
14051422
The first two insert member functions return an iterator that points to the position where the new element was inserted.
14061423
14071424
The next three member functions use an initializer_list.
14081425
1409-
The third member function inserts the sequence of element values into a hash_multiset corresponding to each element addressed by an iterator of in the range [ `First`, `Last`) of a specified hash_multiset.
1426+
The third member function inserts the sequence of element values into a hash_multiset corresponding to each element addressed by an iterator of in the range [ `first`, `last`) of a specified hash_multiset.
14101427
14111428
### Remarks
14121429
1413-
Insertion can occur in amortized constant time for the hint version of insert, instead of logarithmic time, if the insertion point immediately follows *Where*.
1430+
Insertion can occur in amortized constant time for the hint version of insert, instead of logarithmic time, if the insertion point immediately follows *where*.
14141431
14151432
## <a name="iterator"></a> hash_multiset::iterator
14161433
@@ -1452,7 +1469,7 @@ For more information on *Traits* see the [hash_multiset Class](../standard-libra
14521469

14531470
The stored object defines a member function:
14541471

1455-
**bool operator**( **const Key&** *_xVal,* **const Key&** _ `yVal`);
1472+
`bool operator<(const Key& _xVal, const Key& _yVal);`
14561473

14571474
which returns **true** if `_xVal` precedes and is not equal to `_yVal` in the sort order.
14581475

0 commit comments

Comments
 (0)