Skip to content

Commit 49e804b

Browse files
author
Colin Robertson
authored
Merge branch 'master' into cr-basic-reformat
2 parents b52e4f3 + 1a8fb53 commit 49e804b

214 files changed

Lines changed: 439 additions & 443 deletions

File tree

Some content is hidden

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

docs/standard-library/aligned-union-class.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ The distinct types in the underlying union.
2929
3030
## Remarks
3131
32-
Use the template class to get the alignment and size needed to store a union in uninitialized storage. The member typedef `type` names a POD type suitable for storage of any type listed in *Types*; the minimum size is *Len*. The static member `alignment_value` of type `std::size_t` contains the strictest alignment required of all the types listed in *Types*.
32+
Use the class template to get the alignment and size needed to store a union in uninitialized storage. The member typedef `type` names a POD type suitable for storage of any type listed in *Types*; the minimum size is *Len*. The static member `alignment_value` of type `std::size_t` contains the strictest alignment required of all the types listed in *Types*.
3333
3434
## Example
3535

docs/standard-library/allocator-base-class.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ class allocator_base
3838
|[difference_type](#difference_type)|A signed integral type that can represent the difference between values of pointers to the type of object managed by the allocator.|
3939
|[pointer](#pointer)|A type that provides a pointer to the type of object managed by the allocator.|
4040
|[reference](#reference)|A type that provides a reference to the type of object managed by the allocator.|
41-
|[size_type](#size_type)|An unsigned integral type that can represent the length of any sequence that an object of template class `allocator_base` can allocate.|
41+
|[size_type](#size_type)|An unsigned integral type that can represent the length of any sequence that an object of type `allocator_base` can allocate.|
4242
|[value_type](#value_type)|A type that is managed by the allocator.|
4343
4444
### Member functions
@@ -285,7 +285,7 @@ typedef Type& reference;
285285

286286
## <a name="size_type"></a> allocator_base::size_type
287287

288-
An unsigned integral type that can represent the length of any sequence that an object of template class `allocator_base` can allocate.
288+
An unsigned integral type that can represent the length of any sequence that an object of type `allocator_base` can allocate.
289289

290290
```cpp
291291
typedef std::size_t size_type;

docs/standard-library/allocator-class.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ ms.assetid: 3fd58076-56cc-43bb-ad58-b4b7c9c6b410
77
---
88
# allocator Class
99

10-
The template class describes an object that manages storage allocation and freeing for arrays of objects of type `Type`. An object of class `allocator` is the default allocator object specified in the constructors for several container template classes in the C++ Standard Library.
10+
The class template describes an object that manages storage allocation and freeing for arrays of objects of type `Type`. An object of class `allocator` is the default allocator object specified in the constructors for several container class templates in the C++ Standard Library.
1111

1212
## Syntax
1313

@@ -60,7 +60,7 @@ These `Type`s specify the form that pointers and references must take for alloca
6060
|[difference_type](#difference_type)|A signed integral type that can represent the difference between values of pointers to the type of object managed by the allocator.|
6161
|[pointer](#pointer)|A type that provides a pointer to the type of object managed by the allocator.|
6262
|[reference](#reference)|A type that provides a reference to the type of object managed by the allocator.|
63-
|[size_type](#size_type)|An unsigned integral type that can represent the length of any sequence that an object of template class `allocator` can allocate.|
63+
|[size_type](#size_type)|An unsigned integral type that can represent the length of any sequence that an object of type `allocator` can allocate.|
6464
|[value_type](#value_type)|A type that is managed by the allocator.|
6565
6666
### Functions
@@ -300,7 +300,7 @@ typedef const value_type *const_pointer;
300300

301301
#### Remarks
302302

303-
The pointer type describes an object `ptr` that can designate, through the expression `*ptr`, any const object that an object of template class allocator can allocate.
303+
The pointer type describes an object `ptr` that can designate, through the expression `*ptr`, any const object that an object of type `allocator` can allocate.
304304

305305
#### Example
306306

@@ -355,7 +355,7 @@ typedef const value_type& const_reference;
355355

356356
#### Remarks
357357

358-
The reference type describes an object that can designate any const object that an object of template class allocator can allocate.
358+
The reference type describes an object that can designate any const object that an object of type `allocator` can allocate.
359359

360360
#### Example
361361

@@ -583,7 +583,7 @@ typedef ptrdiff_t difference_type;
583583

584584
#### Remarks
585585

586-
The signed integer type describes an object that can represent the difference between the addresses of any two elements in a sequence that an object of template class allocator can allocate.
586+
The signed integer type describes an object that can represent the difference between the addresses of any two elements in a sequence that an object of type `allocator` can allocate.
587587

588588
#### Example
589589

@@ -776,7 +776,7 @@ typedef value_type *pointer;
776776

777777
#### Remarks
778778

779-
The pointer type describes an object `ptr` that can designate, through the expression **\*ptr**, any object that an object of template class allocator can allocate.
779+
The pointer type describes an object `ptr` that can designate, through the expression **\*ptr**, any object that an object of type `allocator` can allocate.
780780

781781
#### Example
782782

@@ -838,7 +838,7 @@ The type of element for which memory is being allocated.
838838
839839
This structure is useful for allocating memory for type that differs from the element type of the container being implemented.
840840
841-
The member template class defines the type other. Its sole purpose is to provide the type name **allocator**\<_ **Other**>, given the type name **allocator**\< **Type**>.
841+
The member class template defines the type other. Its sole purpose is to provide the type name **allocator**\<_ **Other**>, given the type name **allocator**\< **Type**>.
842842
843843
For example, given an allocator object `al` of type `A`, you can allocate an object of type `_Other` with the expression:
844844
@@ -887,7 +887,7 @@ typedef value_type& reference;
887887

888888
#### Remarks
889889

890-
The reference type describes an object that can designate any object that an object of template class allocator can allocate.
890+
The reference type describes an object that can designate any object that an object of type `allocator` can allocate.
891891

892892
#### Example
893893

@@ -939,7 +939,7 @@ The element referred to by vref after being modified is: 150.
939939

940940
### <a name="size_type"></a> size_type
941941

942-
An unsigned integral type that can represent the length of any sequence that an object of template class allocator can allocate.
942+
An unsigned integral type that can represent the length of any sequence that an object of type `allocator` can allocate.
943943

944944
```cpp
945945
typedef size_t size_type;

docs/standard-library/allocator-traits-class.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ helpviewer_keywords: ["std::allocator_traits [C++]", "std::allocator_traits [C++
77
---
88
# allocator_traits Class
99

10-
The template class describes an object that supplements an *allocator type*. An allocator type is any type that describes an allocator object that is used for managing allocated storage. Specifically, for any allocator type `Alloc`, you can use `allocator_traits<Alloc>` to determine all the information that is needed by an allocator-enabled container. For more information, see the default [allocator Class](../standard-library/allocator-class.md).
10+
The class template describes an object that supplements an *allocator type*. An allocator type is any type that describes an allocator object that is used for managing allocated storage. Specifically, for any allocator type `Alloc`, you can use `allocator_traits<Alloc>` to determine all the information that is needed by an allocator-enabled container. For more information, see the default [allocator Class](../standard-library/allocator-class.md).
1111

1212
## Syntax
1313

docs/standard-library/allocator-void-class.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ ms.assetid: abfb40f5-c600-46a6-b130-f42c6535b2bd
77
---
88
# allocator&lt;void&gt; Class
99

10-
A specialization of the template class allocator to type **void**, defining the types that make sense in this context.
10+
A specialization of the class template allocator to type **void**, defining the types that make sense in this context.
1111

1212
## Syntax
1313

@@ -32,12 +32,12 @@ class allocator<void> {
3232
3333
## Remarks
3434
35-
The class explicitly specializes template class [allocator](../standard-library/allocator-class.md) for type **void**. Its constructors and assignment operator behave the same as for the template class, but it defines only the following types:
35+
The class explicitly specializes class template [allocator](../standard-library/allocator-class.md) for type **void**. Its constructors and assignment operator behave the same as for the class template, but it defines only the following types:
3636
3737
- [const_pointer](../standard-library/allocator-class.md#const_pointer).
3838
3939
- [pointer](../standard-library/allocator-class.md#pointer).
4040
4141
- [value_type](../standard-library/allocator-class.md#value_type).
4242
43-
- [rebind](../standard-library/allocator-class.md#rebind), a nested template class.
43+
- [rebind](../standard-library/allocator-class.md#rebind), a nested class template.

docs/standard-library/allocators-functions.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,15 +14,15 @@ helpviewer_keywords: ["std::ALLOCATOR_DECL [C++]", "std::CACHE_CHUNKLIST [C++]",
1414

1515
## <a name="allocator_decl"></a> ALLOCATOR_DECL
1616

17-
Yields an allocator template class.
17+
Yields an allocator class template.
1818

1919
```cpp
2020
#define ALLOCATOR_DECL(cache, sync, name) <alloc_template>
2121
```
2222
2323
### Remarks
2424
25-
The macro yields a template definition `template <class Type> class name {.....}` and a specialization `template <> class name<void> {.....}` which together define an allocator template class that uses the synchronization filter `sync` and a cache of type `cache`.
25+
The macro yields a template definition `template <class Type> class name {.....}` and a specialization `template <> class name<void> {.....}` which together define an allocator class template that uses the synchronization filter `sync` and a cache of type `cache`.
2626
2727
For compilers that can compile rebind, the resulting template definition looks like this:
2828

docs/standard-library/allocators-header.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ The node-based containers in the C++ Standard Library (std::list, std::set, std:
2525

2626
When used with containers that are not node-based (such as the C++ Standard Library containers std::vector std::deque, and std::basic_string), the alllocator templates will work correctly, but are not likely to provide any performance improvement over the default allocator.
2727

28-
An allocator is a template class that describes an object that manages storage allocation and freeing for objects and arrays of objects of a designated type. Allocator objects are used by several container template classes in the C++ Standard Library.
28+
An allocator is a class template that describes an object that manages storage allocation and freeing for objects and arrays of objects of a designated type. Allocator objects are used by several container class templates in the C++ Standard Library.
2929

3030
The allocators are all templates of this type:
3131

@@ -34,7 +34,7 @@ template<class Type>
3434
class allocator;
3535
```
3636

37-
where the template argument `Type` is the type managed by the allocator instance. The C++ Standard Library provides a default allocator, template class [allocator](../standard-library/allocator-class.md), which is defined in [\<memory>](../standard-library/memory.md). The \<allocators> header provides the following allocators:
37+
where the template argument `Type` is the type managed by the allocator instance. The C++ Standard Library provides a default allocator, class template [allocator](../standard-library/allocator-class.md), which is defined in [\<memory>](../standard-library/memory.md). The \<allocators> header provides the following allocators:
3838

3939
- [allocator_newdel](../standard-library/allocator-newdel-class.md)
4040

@@ -69,7 +69,7 @@ std::list<int, alloc<int> > _List1;
6969
7070
_Lst1 allocates nodes with `allocator_chunklist` and the [sync_per_thread](../standard-library/sync-per-thread-class.md) synchronization filter.
7171
72-
A block allocator is a cache or a filter. A cache is a template class that takes one argument of type std::size_t. It defines a block allocator that allocates and deallocates memory blocks of a single size. It must obtain memory using operator **new**, but it need not make a separate call to operator **new** for each block. It may, for example, suballocate from a larger block or cache deallocated blocks for subsequent reallocation.
72+
A block allocator is a cache or a filter. A cache is a class template that takes one argument of type std::size_t. It defines a block allocator that allocates and deallocates memory blocks of a single size. It must obtain memory using operator **new**, but it need not make a separate call to operator **new** for each block. It may, for example, suballocate from a larger block or cache deallocated blocks for subsequent reallocation.
7373
7474
With a compiler that cannot compile rebind the value of the std::size_t argument used when the template was instantiated is not necessarily the value of the argument _Sz passed to a cache's member functions allocate and deallocate.
7575
@@ -113,7 +113,7 @@ The cache template `cache_freelist` takes a max class argument which determines
113113
114114
|Macro|Description|
115115
|-|-|
116-
|[ALLOCATOR_DECL](../standard-library/allocators-functions.md#allocator_decl)|Yields an allocator template class.|
116+
|[ALLOCATOR_DECL](../standard-library/allocators-functions.md#allocator_decl)|Yields an allocator class template.|
117117
|[CACHE_CHUNKLIST](../standard-library/allocators-functions.md#cache_chunklist)|Yields `stdext::allocators::cache_chunklist<sizeof(Type)>`.|
118118
|[CACHE_FREELIST](../standard-library/allocators-functions.md#cache_freelist)|Yields `stdext::allocators::cache_freelist<sizeof(Type), max>`.|
119119
|[CACHE_SUBALLOC](../standard-library/allocators-functions.md#cache_suballoc)|Yields `stdext::allocators::cache_suballoc<sizeof(Type)>`.|
@@ -145,7 +145,7 @@ The cache template `cache_freelist` takes a max class argument which determines
145145
|[max_none](../standard-library/max-none-class.md)|Describes a max class object that limits a [freelist](../standard-library/freelist-class.md) object to a maximum length of zero.|
146146
|[max_unbounded](../standard-library/max-unbounded-class.md)|Describes a max class object that does not limit the maximum length of a [freelist](../standard-library/freelist-class.md) object.|
147147
|[max_variable_size](../standard-library/max-variable-size-class.md)|Describes a max class object that limits a [freelist](../standard-library/freelist-class.md) object to a maximum length that is roughly proportional to the number of allocated memory blocks.|
148-
|[rts_alloc](../standard-library/rts-alloc-class.md)|The rts_alloc template class describes a [filter](../standard-library/allocators-header.md) that holds an array of cache instances and determines which instance to use for allocation and deallocation at runtime instead of at compile time.|
148+
|[rts_alloc](../standard-library/rts-alloc-class.md)|The rts_alloc class template describes a [filter](../standard-library/allocators-header.md) that holds an array of cache instances and determines which instance to use for allocation and deallocation at runtime instead of at compile time.|
149149
|[sync_none](../standard-library/sync-none-class.md)|Describes a synchronization filter that provides no synchronization.|
150150
|[sync_per_container](../standard-library/sync-per-container-class.md)|Describes a synchronization filter that provides a separate cache object for each allocator object.|
151151
|[sync_per_thread](../standard-library/sync-per-thread-class.md)|Describes a synchronization filter that provides a separate cache object for each thread.|

docs/standard-library/array-operators.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -113,7 +113,7 @@ Right container to compare.
113113

114114
### Remarks
115115

116-
The template function overloads `operator<` to compare two objects of template class [array Class](../standard-library/array-class-stl.md). The function returns `lexicographical_compare(left.begin(), left.end(), right.begin())`.
116+
The template function overloads `operator<` to compare two objects of class template [array Class](../standard-library/array-class-stl.md). The function returns `lexicographical_compare(left.begin(), left.end(), right.begin())`.
117117

118118
### Example
119119

@@ -259,7 +259,7 @@ Right container to compare.
259259

260260
### Remarks
261261

262-
The template function overloads `operator==` to compare two objects of template class [array Class](../standard-library/array-class-stl.md). The function returns `equal(left.begin(), left.end(), right.begin())`.
262+
The template function overloads `operator==` to compare two objects of class template [array Class](../standard-library/array-class-stl.md). The function returns `equal(left.begin(), left.end(), right.begin())`.
263263

264264
### Example
265265

docs/standard-library/array.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ ms.assetid: 084147c1-e805-478e-8201-76846020f187
77
---
88
# &lt;array&gt;
99

10-
Defines the container template class **array** and several supporting templates.
10+
Defines the container class template **array** and several supporting templates.
1111

1212
## Requirements
1313

docs/standard-library/atomic.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ ms.assetid: e79a6b9f-52ff-48da-9554-654c4e1999f6
66
---
77
# &lt;atomic&gt;
88

9-
Defines classes and template classes to use to create types that support atomic operations.
9+
Defines classes and class templates to use to create types that support atomic operations.
1010

1111
## Syntax
1212

@@ -31,7 +31,7 @@ On some platforms, it might not be possible to efficiently implement atomic oper
3131

3232
The class [atomic_flag](../standard-library/atomic-flag-structure.md) provides a minimal atomic type that holds a **bool** flag. Its operations are always lock-free.
3333

34-
The template class `atomic<T>` stores an object of its argument type `T` and provides atomic access to that stored value. You can instantiate it by using any type that can be copied by using [memcpy](../c-runtime-library/reference/memcpy-wmemcpy.md) and tested for equality by using [memcmp](../c-runtime-library/reference/memcmp-wmemcmp.md). In particular, you can use it with user-defined types that meet these requirements and, in many cases, with floating-point types.
34+
The class template `atomic<T>` stores an object of its argument type `T` and provides atomic access to that stored value. You can instantiate it by using any type that can be copied by using [memcpy](../c-runtime-library/reference/memcpy-wmemcpy.md) and tested for equality by using [memcmp](../c-runtime-library/reference/memcmp-wmemcmp.md). In particular, you can use it with user-defined types that meet these requirements and, in many cases, with floating-point types.
3535

3636
The template also has a set of specializations for integral types and a partial specialization for pointers. These specializations provide additional operations that are not available through the primary template.
3737

0 commit comments

Comments
 (0)