Skip to content

Commit 1034f30

Browse files
committed
formatting
1 parent be99628 commit 1034f30

20 files changed

Lines changed: 979 additions & 1074 deletions

docs/standard-library/algorithm-functions.md

Lines changed: 399 additions & 438 deletions
Large diffs are not rendered by default.

docs/standard-library/algorithm.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ The C++ Standard Library numeric algorithms that are provided for numerical proc
3636

3737
### Function templates
3838

39-
|Function template|Description|
39+
|||
4040
|-|-|
4141
|[adjacent_find](../standard-library/algorithm-functions.md#adjacent_find)|Searches for two adjacent elements that are either equal or satisfy a specified condition.|
4242
|[all_of](../standard-library/algorithm-functions.md#all_of)|Returns **true** when a condition is present at each element in the given range.|

docs/standard-library/complex-class.md

Lines changed: 28 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -30,42 +30,40 @@ In particular, no subtle differences may exist between copy construction and def
3030
3131
Explicit specializations of template class complex exist for the three floating-point types. In this implementation, a value of any other type `Type` is typecast to **double** for actual calculations, with the **double** result assigned back to the stored object of type `Type`.
3232
33+
## Members
34+
3335
### Constructors
3436
35-
|Constructor|Description|
37+
|||
3638
|-|-|
3739
|[complex](#complex)|Constructs a complex number with specified real and imaginary parts or as a copy of some other complex number.|
3840
3941
### Typedefs
4042
41-
|Type name|Description|
43+
|||
4244
|-|-|
4345
|[value_type](#value_type)|A type that represents the data type used to represent the real and imaginary parts of a complex number.|
4446
45-
### Member functions
47+
### Functions
4648
47-
|Member function|Description|
49+
|||
4850
|-|-|
4951
|[imag](#imag)|Extracts the imaginary component of a complex number.|
5052
|[real](#real)|Extracts the real component of a complex number.|
5153
5254
### Operators
5355
54-
|Operator|Description|
56+
|||
5557
|-|-|
5658
|[operator*=](#op_star_eq)|Multiplies a target complex number by a factor, which may be complex or be the same type as are the real and imaginary parts of the complex number.|
5759
|[operator+=](#op_add_eq)|Adds a number to a target complex number, where the number added may be complex or of the same type as are the real and imaginary parts of the complex number to which it is added.|
5860
|[operator-=](#operator-_eq)|Subtracts a number from a target complex number, where the number subtracted may be complex or of the same type as are the real and imaginary parts of the complex number to which it is added.|
5961
|[operator/=](#op_div_eq)|Divides a target complex number by a divisor, which may be complex or be the same type as are the real and imaginary parts of the complex number.|
6062
|[operator=](#op_eq)|Assigns a number to a target complex number, where the number assigned may be complex or of the same type as are the real and imaginary parts of the complex number to which it is being assigned.|
6163
62-
## Requirements
63-
64-
**Header**: \<complex>
6564
66-
**Namespace:** std
6765
68-
## <a name="complex"></a> complex::complex
66+
## <a name="complex"></a> complex
6967
7068
Constructs a complex number with specified real and imaginary parts or as a copy of some other complex number.
7169
@@ -81,13 +79,13 @@ constexpr complex(
8179

8280
### Parameters
8381

84-
*_RealVal*<br/>
82+
*_RealVal*\
8583
The value of the real part used to initialize the complex number being constructed.
8684

87-
*_ImagVal*<br/>
85+
*_ImagVal*\
8886
The value of the imaginary part used to initialize the complex number being constructed.
8987

90-
*complexNum*<br/>
88+
*complexNum*\
9189
The complex number whose real and imaginary parts are used to initialize the complex number being constructed.
9290

9391
### Remarks
@@ -149,7 +147,7 @@ int main( )
149147
}
150148
```
151149
152-
## <a name="imag"></a> complex::imag
150+
## <a name="imag"></a> imag
153151
154152
Extracts the imaginary component of a complex number.
155153
@@ -161,7 +159,7 @@ T imag(const T& right);
161159

162160
### Parameters
163161

164-
*right*<br/>
162+
*right*\
165163
A complex number whose imaginary value is to be extracted.
166164

167165
### Return Value
@@ -203,7 +201,7 @@ The real part of c1 is c1.real() = 4.
203201
The imaginary part of c1 is c1.imag() = 3.
204202
```
205203

206-
## <a name="op_star_eq"></a> complex::operator*=
204+
## <a name="op_star_eq"></a> operator*=
207205

208206
Multiplies a target complex number by a factor, which may be complex or be the same type as are the real and imaginary parts of the complex number.
209207

@@ -218,7 +216,7 @@ complex<Type>& operator*=(const complex<Type>& right);
218216

219217
### Parameters
220218

221-
*right*<br/>
219+
*right*\
222220
A complex number or a number that is of the same type as the parameter of the target complex number.
223221

224222
### Return Value
@@ -288,7 +286,7 @@ int main()
288286
}
289287
```
290288

291-
## <a name="op_add_eq"></a> complex::operator+=
289+
## <a name="op_add_eq"></a> operator+=
292290

293291
Adds a number to a target complex number, where the number added may be complex or of the same type as are the real and imaginary parts of the complex number to which it is added.
294292

@@ -303,7 +301,7 @@ complex<Type>& operator+=(const complex<Type>& right);
303301

304302
### Parameters
305303

306-
*right*<br/>
304+
*right*\
307305
A complex number or a number that is of the same type as the parameter of the target complex number.
308306

309307
### Return Value
@@ -391,7 +389,7 @@ The modulus of cl2 is: 5
391389
The argument of cl2 is: 0.927295 radians, which is 53.1301 degrees.
392390
```
393391

394-
## <a name="operator-_eq"></a> complex::operator-=
392+
## <a name="operator-_eq"></a> operator-=
395393

396394
Subtracts a number from a target complex number, where the number subtracted may be complex or of the same type as are the real and imaginary parts of the complex number to which it is added.
397395

@@ -406,10 +404,10 @@ complex<Type>& operator-=(const complex<Type>& complexNum);
406404

407405
### Parameters
408406

409-
*complexNum*<br/>
407+
*complexNum*\
410408
A complex number to be subtracted from the target complex number.
411409

412-
*_RealPart*<br/>
410+
*_RealPart*\
413411
A real number to be subtracted from the target complex number.
414412

415413
### Return Value
@@ -499,7 +497,7 @@ The modulus of cl2 is: 5
499497
The argument of cl2 is: 2.2143 radians, which is 126.87 degrees.
500498
```
501499

502-
## <a name="op_div_eq"></a> complex::operator/=
500+
## <a name="op_div_eq"></a> operator/=
503501

504502
Divides a target complex number by a divisor, which may be complex or be the same type as are the real and imaginary parts of the complex number.
505503

@@ -514,10 +512,10 @@ complex<Type>& operator/=(const complex<Type>& complexNum);
514512

515513
### Parameters
516514

517-
*complexNum*<br/>
515+
*complexNum*\
518516
A complex number to be subtracted from the target complex number.
519517

520-
*_RealPart*<br/>
518+
*_RealPart*\
521519
A real number to be subtracted from the target complex number.
522520

523521
### Return Value
@@ -603,7 +601,7 @@ The modulus of cl2 is: 0.6
603601
The argument of cl2 is: 0.523599 radians, which is 30 degrees.
604602
```
605603

606-
## <a name="op_eq"></a> complex::operator=
604+
## <a name="op_eq"></a> operator=
607605

608606
Assigns a number to a target complex number, where the number assigned may be complex or of the same type as are the real and imaginary parts of the complex number to which it is being assigned.
609607

@@ -616,7 +614,7 @@ complex<Type>& operator=(const Type& right);
616614

617615
### Parameters
618616

619-
*right*<br/>
617+
*right*\
620618
A complex number or a number that is of the same type as the parameter of the target complex number.
621619

622620
### Return Value
@@ -681,7 +679,7 @@ The complex number (3, 4) assigned to the complex number cl2 is:
681679
cl2 = (3,4)
682680
```
683681

684-
## <a name="real"></a> complex::real
682+
## <a name="real"></a> real
685683

686684
Gets or sets the real component of a complex number.
687685

@@ -693,7 +691,7 @@ T real(const T& right);
693691
694692
### Parameters
695693
696-
*right*<br/>
694+
*right*\
697695
A complex number whose real value is to be extracted.
698696
699697
### Return Value
@@ -735,7 +733,7 @@ The real part of c1 is c1.real() = 4.
735733
The imaginary part of c1 is c1.imag() = 3.
736734
```
737735

738-
## <a name="value_type"></a> complex::value_type
736+
## <a name="value_type"></a> value_type
739737

740738
A type that represents the data type used to represent the real and imaginary parts of a complex number.
741739

0 commit comments

Comments
 (0)