Skip to content

Elide more manual table of contents #5420

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 7 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 9 additions & 13 deletions docs/standard-library/allocators-operators.md
Original file line number Diff line number Diff line change
@@ -1,18 +1,14 @@
---
description: "Learn more about: <allocators> operators"
title: "<allocators> operators"
ms.date: "11/04/2016"
description: "Learn more about: <allocators> operators"
ms.date: 11/04/2016
f1_keywords: ["allocators/std::operator!=", "allocators/std::operator=="]
ms.assetid: b55d67cb-3c69-46bf-ad40-e845fb096c4e
---
# `<allocators>` operators

These are the global template operator functions defined in `<allocators>`. For class member operator functions, see the class documentation.

[operator!=](#op_neq)\
[operator==](#op_eq_eq)

## <a name="op_neq"></a> operator!=
## <a name="op_neq"></a> `operator!=`

Tests for inequality between allocator objects of a specified class.

Expand All @@ -25,10 +21,10 @@ bool operator!=(

### Parameters

*left*\
*`left`*\
One of the allocator objects to be tested for inequality.

*right*\
*`right`*\
One of the allocator objects to be tested for inequality.

### Return Value
Expand All @@ -39,7 +35,7 @@ One of the allocator objects to be tested for inequality.

The template operator returns `!(left == right)`.

## <a name="op_eq_eq"></a> operator==
## <a name="op_eq_eq"></a> `operator==`

Tests for equality between allocator objects of a specified class.

Expand All @@ -52,10 +48,10 @@ bool operator==(

### Parameters

*left*\
*`left`*\
One of the allocator objects to be tested for equality.

*right*\
*`right`*\
One of the allocator objects to be tested for equality.

### Return Value
Expand All @@ -68,4 +64,4 @@ This template operator returns `left.equals(right)`.

## See also

[\<allocators>](allocators-header.md)
[`<allocators>`](allocators-header.md)
32 changes: 14 additions & 18 deletions docs/standard-library/array-functions.md
Original file line number Diff line number Diff line change
@@ -1,19 +1,15 @@
---
description: "Learn more about: <array> functions"
title: "<array> functions"
ms.date: "11/04/2016"
description: "Learn more about: <array> functions"
ms.date: 11/04/2016
f1_keywords: ["array/std::array::get", "array/std::get", "array/std::swap"]
ms.assetid: e0700a33-a833-4655-8735-16e71175efc8
helpviewer_keywords: ["std::array [C++], get", "std::get [C++]", "std::swap [C++]"]
---
# `<array>` functions

The \<array> header includes two non-member functions, `get` and `swap`, that operate on **array** objects.

[get](#get)\
[swap](#swap)
The `<array>` header includes two non-member functions, `get` and `swap`, that operate on **array** objects.

## <a name="get"></a> get
## <a name="get"></a> `get`

Returns a reference to the specified element of the array.

Expand All @@ -30,16 +26,16 @@ constexpr T&& get(array<T, N>&& arr) noexcept;

### Parameters

*Index*\
*`Index`*\
The element offset.

*T*\
*`T`*\
The type of an element.

*N*\
*`N`*\
The number of elements in the array.

*arr*\
*`arr`*\
The array to select from.

### Example
Expand Down Expand Up @@ -74,7 +70,7 @@ int main()
1 3
```

## <a name="swap"></a> swap
## <a name="swap"></a> `swap`

A non-member template specialization of `std::swap` that swaps two **array** objects.

Expand All @@ -85,16 +81,16 @@ void swap(array<Ty, N>& left, array<Ty, N>& right);

### Parameters

*Ty*\
*`Ty`*\
The type of an element.

*N*\
*`N`*\
The size of the array.

*left*\
*`left`*\
The first array to swap.

*right*\
*`right`*\
The second array to swap.

### Remarks
Expand Down Expand Up @@ -149,4 +145,4 @@ int main()

## See also

[\<array>](../standard-library/array.md)
[`<array>`](../standard-library/array.md)
63 changes: 28 additions & 35 deletions docs/standard-library/array-operators.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,16 +6,9 @@ f1_keywords: ["array/std::array::operator!=", "array/std::array::operator<", "ar
---
# `<array>` operators

The \<array> header includes these **array** non-member comparison template functions.
The `<array>` header includes these **array** non-member comparison template functions.

[operator!=](#op_neq)\
[`operator>`](#op_gt)\
[`operator>=`](#op_gt_eq)\
[`operator<`](#op_lt)\
[`operator<=`](#op_lt_eq)\
[operator==](#op_eq_eq)

## <a name="op_neq"></a> operator!=
## <a name="op_neq"></a> `operator!=`

Array comparison, not equal.

Expand All @@ -28,16 +21,16 @@ bool operator!=(

### Parameters

*Ty*\
*`Ty`*\
The type of an element.

*N*\
*`N`*\
The size of the array.

*left*\
*`left`*\
Left container to compare.

*right*\
*`right`*\
Right container to compare.

### Remarks
Expand Down Expand Up @@ -101,16 +94,16 @@ bool operator<(

### Parameters

*Ty*\
*`Ty`*\
The type of an element.

*N*\
*`N`*\
The size of the array.

*left*\
*`left`*\
Left container to compare.

*right*\
*`right`*\
Right container to compare.

### Remarks
Expand Down Expand Up @@ -174,16 +167,16 @@ bool operator<=(

### Parameters

*Ty*\
*`Ty`*\
The type of an element.

*N*\
*`N`*\
The size of the array.

*left*\
*`left`*\
Left container to compare.

*right*\
*`right`*\
Right container to compare.

### Remarks
Expand Down Expand Up @@ -234,7 +227,7 @@ true
false
```

## <a name="op_eq_eq"></a> operator==
## <a name="op_eq_eq"></a> `operator==`

Array comparison, equal.

Expand All @@ -247,16 +240,16 @@ bool operator==(

### Parameters

*Ty*\
*`Ty`*\
The type of an element.

*N*\
*`N`*\
The size of the array.

*left*\
*`left`*\
Left container to compare.

*right*\
*`right`*\
Right container to compare.

### Remarks
Expand Down Expand Up @@ -320,16 +313,16 @@ bool operator>(

### Parameters

*Ty*\
*`Ty`*\
The type of an element.

*N*\
*`N`*\
The size of the array.

*left*\
*`left`*\
Left container to compare.

*right*\
*`right`*\
Right container to compare.

### Remarks
Expand Down Expand Up @@ -393,16 +386,16 @@ bool operator>=(

### Parameters

*Ty*\
*`Ty`*\
The type of an element.

*N*\
*`N`*\
The size of the array.

*left*\
*`left`*\
Left container to compare.

*right*\
*`right`*\
Right container to compare.

### Remarks
Expand Down Expand Up @@ -455,4 +448,4 @@ false

## See also

[\<array>](../standard-library/array.md)
[`<array>`](../standard-library/array.md)
Loading