Skip to content

Commit ee77031

Browse files
authored
Merge pull request #1064 from msebolt/format-standard-pr6
format standard pr6
2 parents 87805f4 + 83654db commit ee77031

30 files changed

+462
-462
lines changed

docs/standard-library/gslice-array-class.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -65,15 +65,15 @@ public:
6565
6666
## Remarks
6767
68-
The class describes an object that stores a reference to an object **va** of class [valarray](../standard-library/valarray-class.md)**\<Type>**, along with an object **gs** of class [gslice](../standard-library/gslice-class.md) which describes the sequence of elements to select from the **valarray\<Type>** object.
68+
The class describes an object that stores a reference to an object `va` of class [valarray](../standard-library/valarray-class.md)**\<Type>**, along with an object `gs` of class [gslice](../standard-library/gslice-class.md) which describes the sequence of elements to select from the `valarray<Type>` object.
6969
70-
You construct a **gslice_array\<Type>** object only by writing an expression of the form [va&#91;gs&#93;](../standard-library/valarray-class.md#op_at). The member functions of class gslice_array then behave like the corresponding function signatures defined for **valarray\<Type>**, except that only the sequence of selected elements is affected.
70+
You construct a `gslice_array<Type>` object only by writing an expression of the form [va&#91;gs&#93;](../standard-library/valarray-class.md#op_at). The member functions of class gslice_array then behave like the corresponding function signatures defined for `valarray<Type>`, except that only the sequence of selected elements is affected.
7171
7272
The template class is created indirectly by certain valarray operations and cannot be used directly in the program. An internal auxiliary template class instead is used by the slice subscript operator:
7373
7474
`gslice_array`\< **Type**> `valarray`\< **Type**>:: `operator[]` ( **constgslice&**).
7575
76-
You construct a **gslice_array\<Type>** object only by writing an expression of the form **va[gsl]**, for a slice **gsl** of valarray **va**. The member functions of class gslice_array then behave like the corresponding function signatures defined for **valarray\<Type>**, except that only the sequence of selected elements is affected. The sequence controlled by the gslice_array is defined by the three parameters of the slice constructor, the index of the first element in the first slice, the number of elements in each slice, and the distance between the elements in each slice.
76+
You construct a `gslice_array<Type>` object only by writing an expression of the form `va[gsl]`, for a slice `gsl` of valarray `va`. The member functions of class gslice_array then behave like the corresponding function signatures defined for `valarray<Type>`, except that only the sequence of selected elements is affected. The sequence controlled by the gslice_array is defined by the three parameters of the slice constructor, the index of the first element in the first slice, the number of elements in each slice, and the distance between the elements in each slice.
7777
7878
In the following example:
7979

docs/standard-library/gslice-class.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -22,9 +22,9 @@ The class stores the parameters that characterize an object of type [gslice_arra
2222

2323
- A starting index.
2424

25-
- A length vector of class **valarray<size_t>**.
25+
- A length vector of class `valarray<size_t>`.
2626

27-
- A stride vector of class **valarray<size_t>**.
27+
- A stride vector of class `valarray<size_t>`.
2828

2929
The two vectors must have the same length.
3030

@@ -67,22 +67,22 @@ gslice(
6767
6868
### Parameters
6969
70-
`_StartIndex`
70+
*_StartIndex*
7171
The valarray index of the first element in the subset.
7272
73-
`_LenArray`
73+
*_LenArray*
7474
An array specifying the number of elements in each slice.
7575
76-
`_IncArray`
76+
*_IncArray*
7777
An array specifying the stride in each slice.
7878
7979
### Return Value
8080
81-
The default constructor stores zero for the starting index, and zero-length vectors for the length and stride vectors. The second constructor stores `_StartIndex` for the starting index, `_LenArray` for the length array, and `_IncArray` for the stride array.
81+
The default constructor stores zero for the starting index, and zero-length vectors for the length and stride vectors. The second constructor stores *_StartIndex* for the starting index, *_LenArray* for the length array, and *_IncArray* for the stride array.
8282
8383
### Remarks
8484
85-
**gslice** defines a subset of a valarray that consists of multiple slices of the valarray that each start at the same specified element. The ability to use arrays to define multiple slices is the only difference between `gslice` and [slice::slice](../standard-library/slice-class.md#slice). The first slice has a first element with an index of `_StartIndex`, a number of elements specified by the first element of `_LenArray`, and a stride given by the first element of `_IncArray`. The next set of orthogonal slices has first elements given by the first slice. The second element of `_LenArray` specifies the number of elements. The stride is given by the second element of `_IncArray`. A third dimension of slices would take the elements of the two-dimensional array as the starting elements and proceed analogously
85+
**gslice** defines a subset of a valarray that consists of multiple slices of the valarray that each start at the same specified element. The ability to use arrays to define multiple slices is the only difference between `gslice` and [slice::slice](../standard-library/slice-class.md#slice). The first slice has a first element with an index of *_StartIndex*, a number of elements specified by the first element of *_LenArray*, and a stride given by the first element of *_IncArray*. The next set of orthogonal slices has first elements given by the first slice. The second element of *_LenArray* specifies the number of elements. The stride is given by the second element of *_IncArray*. A third dimension of slices would take the elements of the two-dimensional array as the starting elements and proceed analogously
8686
8787
### Example
8888

docs/standard-library/has-iterator-debugging.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -17,19 +17,19 @@ ms.workload: ["cplusplus"]
1717
Superseded by [_ITERATOR_DEBUG_LEVEL](../standard-library/iterator-debug-level.md), this macro defines whether the iterator debugging feature is enabled in a debug build. By default, iterator debugging is enabled in Debug builds and disabled in Retail builds. For more information, see [Debug Iterator Support](../standard-library/debug-iterator-support.md).
1818

1919
> [!IMPORTANT]
20-
> Direct use of the `_HAS_ITERATOR_DEBUGGING` macro is deprecated. Instead, use `_ITERATOR_DEBUG_LEVEL` to control iterator debug settings. For more information, see [_ITERATOR_DEBUG_LEVEL](../standard-library/iterator-debug-level.md).
20+
> Direct use of the _HAS_ITERATOR_DEBUGGING macro is deprecated. Instead, use _ITERATOR_DEBUG_LEVEL to control iterator debug settings. For more information, see [_ITERATOR_DEBUG_LEVEL](../standard-library/iterator-debug-level.md).
2121
2222
## Remarks
2323

24-
To enable iterator debugging in debug builds, set `_ITERATOR_DEBUG_LEVEL` to 2. This is equivalent to a `_HAS_ITERATOR_DEBUGGING` setting of 1, or enabled:
24+
To enable iterator debugging in debug builds, set _ITERATOR_DEBUG_LEVEL to 2. This is equivalent to a _HAS_ITERATOR_DEBUGGING setting of 1, or enabled:
2525

2626
```cpp
2727
#define _ITERATOR_DEBUG_LEVEL 2
2828
```
2929
30-
`_ITERATOR_DEBUG_LEVEL` cannot be set to 2 (and `_HAS_ITERATOR_DEBUGGING` cannot be set to 1) in retail builds.
30+
_ITERATOR_DEBUG_LEVEL cannot be set to 2 (and _HAS_ITERATOR_DEBUGGING cannot be set to 1) in retail builds.
3131
32-
To disable debug iterators in debug builds, set `_ITERATOR_DEBUG_LEVEL` to 0 or 1. This is equivalent to a `_HAS_ITERATOR_DEBUGGING` setting of 0, or disabled:
32+
To disable debug iterators in debug builds, set _ITERATOR_DEBUG_LEVEL to 0 or 1. This is equivalent to a _HAS_ITERATOR_DEBUGGING setting of 0, or disabled:
3333
3434
```cpp
3535
#define _ITERATOR_DEBUG_LEVEL 0

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

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -34,15 +34,15 @@ class hash_compare
3434

3535
## Remarks
3636

37-
Each hash associative container stores a hash traits object of type **Traits** (a template parameter). You can derive a class from a specialization of hash_compare to selectively override certain functions and objects, or you can supply your own version of this class if you meet certain minimum requirements. Specifically, for an object hash_comp of type **hash_compare\<Key, Traits>**, the following behavior is required by the above containers:
37+
Each hash associative container stores a hash traits object of type `Traits` (a template parameter). You can derive a class from a specialization of hash_compare to selectively override certain functions and objects, or you can supply your own version of this class if you meet certain minimum requirements. Specifically, for an object hash_comp of type `hash_compare<Key, Traits>`, the following behavior is required by the above containers:
3838

39-
- For all values `key` of type **Key**, the call **hash_comp**( `key`) serves as a hash function, which yields a distribution of values of type **size_t**. The function supplied by hash_compare returns `key`.
39+
- For all values `key` of type `Key`, the call **hash_comp**(`key`) serves as a hash function, which yields a distribution of values of type `size_t`. The function supplied by hash_compare returns `key`.
4040

41-
- For any value `key1` of type **Key** that precedes `key2` in the sequence and has the same hash value (value returned by the hash function), **hash_comp**( `key2`, `key1`) is false. The function must impose a total ordering on values of type **Key**. The function supplied by hash_compare returns *comp*( `key2`, `key1`) `,` where *comp* is a stored object of type **Traits** that you can specify when you construct the object hash_comp. For the default **Traits** parameter type **less\<Key>**, sort keys never decrease in value.
41+
- For any value `key1` of type `Key` that precedes `key2` in the sequence and has the same hash value (value returned by the hash function), **hash_comp**(`key2`, `key1`) is false. The function must impose a total ordering on values of type `Key`. The function supplied by hash_compare returns *comp*(`key2`, `key1`) `,` where *comp* is a stored object of type `Traits` that you can specify when you construct the object hash_comp. For the default `Traits` parameter type `less<Key>`, sort keys never decrease in value.
4242

43-
- The integer constant **bucket_size** specifies the mean number of elements per "bucket" (hash-table entry) that the container should try not to exceed. It must be greater than zero. The value supplied by hash_compare is 4.
43+
- The integer constant `bucket_size` specifies the mean number of elements per "bucket" (hash-table entry) that the container should try not to exceed. It must be greater than zero. The value supplied by hash_compare is 4.
4444

45-
- The integer constant **min_buckets** specifies the minimum number of buckets to maintain in the hash table. It must be a power of two and greater than zero. The value supplied by hash_compare is 8.
45+
- The integer constant `min_buckets` specifies the minimum number of buckets to maintain in the hash table. It must be a power of two and greater than zero. The value supplied by hash_compare is 8.
4646

4747
## Example
4848

0 commit comments

Comments
 (0)