Skip to content

Commit 33d0fe3

Browse files
authored
Merge pull request #5809 from Rageking8/resolve-issues-and-clean-up-floating-point-primitives-topic
Resolve issues and clean up "Floating-point primitives" topic
2 parents e748111 + 6b8aaa1 commit 33d0fe3

File tree

1 file changed

+18
-18
lines changed

1 file changed

+18
-18
lines changed

docs/c-runtime-library/reference/floating-point-primitives.md

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
2-
description: "Learn more about: Floating-point primitives"
32
title: "Floating-point primitives"
4-
ms.date: "4/2/2020"
3+
description: "Learn more about: Floating-point primitives"
4+
ms.date: 4/2/2020
55
api_name: ["_dclass", "_ldclass", "_fdclass", "_dsign", "_ldsign", "_fdsign", "_dpcomp", "_ldpcomp", "_fdpcomp", "_dtest", "_ldtest", "_fdtest", "_d_int", "_ld_int", "_fd_int", "_dscale", "_ldscale", "_fdscale", "_dunscale", "_ldunscale", "_fdunscale", "_dexp", "_ldexp", "_fdexp", "_dnorm", "_fdnorm", "_dpoly", "_ldpoly", "_fdpoly", "_dlog", "_ldlog", "_fdlog", "_dsin", "_ldsin", "_fdsin", "_o__d_int", "_o__dclass", "_o__dlog", "_o__dnorm", "_o__dpcomp", "_o__dpoly", "_o__dscale", "_o__dsign", "_o__dsin", "_o__dtest", "_o__dunscale", "_o__fd_int", "_o__fdclass", "_o__fdexp", "_o__fdlog", "_o__fdpcomp", "_o__fdpoly", "_o__fdscale", "_o__fdsign", "_o__fdsin", "_o__ld_int", "_o__ldclass", "_o__ldexp", "_o__ldlog", "_o__ldpcomp", "_o__ldpoly", "_o__ldscale", "_o__ldsign", "_o__ldsin", "_o__ldtest", "_o__ldunscale"]
66
api_location: ["msvcrt.dll", "msvcr80.dll", "msvcr90.dll", "msvcr100.dll", "msvcr100_clr0400.dll", "msvcr110.dll", "msvcr110_clr0400.dll", "msvcr120.dll", "msvcr120_clr0400.dll", "ucrtbase.dll", "api-ms-win-crt-math-l1-1-0.dll"]
77
api_type: ["DLLExport"]
@@ -32,7 +32,7 @@ Floating-point function argument.
3232
3333
### Remarks
3434
35-
These floating-point primitives implement the C versions of the CRT macro [`fpclassify`](fpclassify.md) for floating-point types. The classification of the argument *`x`* is returned as one of these constants, defined in math.h:
35+
These floating-point primitives implement the C versions of the CRT macro [`fpclassify`](fpclassify.md) for floating-point types. The classification of the argument *`x`* is returned as one of these constants, defined in `math.h`:
3636
3737
| Value | Description |
3838
|---|---|
@@ -63,7 +63,7 @@ Floating-point function argument.
6363

6464
These floating-point primitives implement the [`signbit`](signbit.md) macro or function in the CRT. They return a non-zero value if the sign bit is set in the significand (mantissa) of the argument *`x`*. Otherwise, they return 0 if the sign bit isn't set.
6565

66-
## _dpcomp, _ldpcomp, _fdpcomp
66+
## `_dpcomp`, `_ldpcomp`, `_fdpcomp`
6767

6868
### Syntax
6969

@@ -80,7 +80,7 @@ Floating-point function arguments.
8080
8181
### Remarks
8282
83-
These floating-point primitives take two arguments, *`x`* and *`y`*, and return a value that shows their ordering relationship, expressed as the bitwise or of these constants, defined in math.h:
83+
These floating-point primitives take two arguments, *`x`* and *`y`*, and return a value that shows their ordering relationship, expressed as the bitwise or of these constants, defined in `math.h`:
8484
8585
| Value | Description |
8686
|------------|-----------------|
@@ -90,7 +90,7 @@ These floating-point primitives take two arguments, *`x`* and *`y`*, and return
9090
9191
These primitives implement the [`isgreater`, `isgreaterequal`, `isless`, `islessequal`, `islessgreater`, and `isunordered`](floating-point-ordering.md) macros and functions in the CRT.
9292
93-
## _dtest, _ldtest, _fdtest
93+
## `_dtest`, `_ldtest`, `_fdtest`
9494
9595
### Syntax
9696
@@ -107,7 +107,7 @@ Pointer to a floating-point argument.
107107

108108
### Remarks
109109

110-
These floating-point primitives implement the C++ versions of the CRT function [`fpclassify`](fpclassify.md) for floating-point types. The argument *`x`* is evaluated and the classification is returned as one of these constants, defined in math.h:
110+
These floating-point primitives implement the C++ versions of the CRT function [`fpclassify`](fpclassify.md) for floating-point types. The argument *`x`* is evaluated and the classification is returned as one of these constants, defined in `math.h`:
111111

112112
| Value | Description |
113113
|---|---|
@@ -119,7 +119,7 @@ These floating-point primitives implement the C++ versions of the CRT function [
119119

120120
For more detail, you can use the Microsoft-specific [`_fpclass`, `_fpclassf`](fpclass-fpclassf.md) functions. Use the [`fpclassify`](fpclassify.md) function for portability.
121121

122-
## _d_int, _ld_int, _fd_int
122+
## `_d_int`, `_ld_int`, `_fd_int`
123123

124124
### Syntax
125125

@@ -141,7 +141,7 @@ An exponent as an integral type.
141141
142142
These floating-point primitives take a pointer to a floating-point value *`px`* and an exponent value *`exp`*, and remove the fractional part of the floating-point value below the given exponent, if possible. The value returned is the result of `fpclassify` on the input value in *`px`* if it's a NaN or infinity, and on the output value in *`px`* otherwise.
143143
144-
## _dscale, _ldscale, _fdscale
144+
## `_dscale`, `_ldscale`, `_fdscale`
145145
146146
### Syntax
147147
@@ -163,7 +163,7 @@ An exponent as an integral type.
163163

164164
These floating-point primitives take a pointer to a floating-point value *`px`* and an exponent value *`exp`*, and scale the value in *`px`* by 2<sup>*`exp`*</sup>, if possible. The value returned is the result of `fpclassify` on the input value in *`px`* if it's a NaN or infinity, and on the output value in *`px`* otherwise. For portability, prefer the [`ldexp`, `ldexpf`, `ldexpl`](ldexp.md) functions.
165165

166-
## _dunscale, _ldunscale, _fdunscale
166+
## `_dunscale`, `_ldunscale`, `_fdunscale`
167167

168168
### Syntax
169169

@@ -185,7 +185,7 @@ Pointer to a floating-point argument.
185185
186186
These floating-point primitives break down the floating-point value pointed at by *`px`* into a significand (mantissa) and an exponent, if possible. The significand is scaled such that the absolute value is greater than or equal to 0.5 and less than 1.0. The exponent is the value *`n`*, where the original floating-point value is equal to the scaled significand times 2<sup>n</sup>. This integer exponent *`n`* is stored at the location pointed to by *`pexp`*. The value returned is the result of `fpclassify` on the input value in *`px`* if it's a NaN or infinity, and on the output value otherwise. For portability, prefer the [`frexp`, `frexpf`, `frexpl`](frexp.md) functions.
187187
188-
## _dexp, _ldexp, _fdexp
188+
## `_dexp`, `_ldexp`, `_fdexp`
189189
190190
### Syntax
191191
@@ -210,7 +210,7 @@ An exponent as an integral type.
210210

211211
These floating-point primitives construct a floating-point value in the location pointed at by *`px`* equal to *`y`* * 2<sup>exp</sup>. The value returned is the result of `fpclassify` on the input value in *`y`* if it's a NaN or infinity, and on the output value in *`px`* otherwise. For portability, prefer the [`ldexp`, `ldexpf`, `ldexpl`](ldexp.md) functions.
212212

213-
## _dnorm, _fdnorm
213+
## `_dnorm`, `_fdnorm`
214214

215215
### Syntax
216216

@@ -226,16 +226,16 @@ Pointer to the bitwise representation of a floating-point value expressed as an
226226
227227
### Remarks
228228
229-
These floating-point primitives normalize the fractional part of an underflowed floating-point value and adjust the *characteristic*, or biased exponent, to match. The value is passed as the bitwise representation of the floating-point type converted to an array of **`unsigned short`** through the `_double_val`, `_ldouble_val`, or `_float_val` type-punning union declared in math.h. The return value is the result of `fpclassify` on the input floating-point value if it's a NaN or infinity, and on the output value otherwise.
229+
These floating-point primitives normalize the fractional part of an underflowed floating-point value and adjust the *characteristic*, or biased exponent, to match. The value is passed as the bitwise representation of the floating-point type converted to an array of **`unsigned short`** through the `_double_val`, `_ldouble_val`, or `_float_val` type-punning union declared in `math.h`. The return value is the result of `fpclassify` on the input floating-point value if it's a NaN or infinity, and on the output value otherwise.
230230
231-
## _dpoly, _ldpoly, _fdpoly
231+
## `_dpoly`, `_ldpoly`, `_fdpoly`
232232
233233
### Syntax
234234
235235
```C
236236
double __cdecl _dpoly(double x, double const* table, int n);
237237
long double __cdecl _ldpoly(long double x, long double const* table, int n);
238-
float __cdecl _fdpoly(float x, _float const* table, int n);
238+
float __cdecl _fdpoly(float x, float const* table, int n);
239239
```
240240

241241
### Parameters
@@ -253,7 +253,7 @@ Order of the polynomial to evaluate.
253253

254254
These floating-point primitives return the evaluation of *`x`* in the polynomial of order *`n`* whose coefficients are represented by the corresponding constant values in *`table`*. For example, if *`table[0]`* = 3.0, *`table[1]`* = 4.0, *`table[2]`* = 5.0, and *`n`* = 2, it represents the polynomial 5.0x<sup>2</sup> + 4.0x + 3.0. If this polynomial is evaluated for *`x`* of 2.0, the result is 31.0. These functions aren't used internally.
255255

256-
## _dlog, _dlog, _dlog
256+
## `_dlog`, `_ldlog`, `_fdlog`
257257

258258
### Syntax
259259

@@ -275,7 +275,7 @@ Flag that controls the base to use, 0 for base *e* and non-zero for base 10.
275275
276276
These floating-point primitives return the natural log of *`x`* (ln(x) or log<sub>*e*</sub>(x)), when *`base_flag`* is 0. They return the log base 10 of *`x`*, or log<sub>10</sub>(x), when *`base_flag`* is non-zero. These functions aren't used internally. For portability, prefer the functions [`log`, `logf`, `logl`, `log10`, `log10f`, and `log10l`](log-logf-log10-log10f.md).
277277
278-
## _dsin, _ldsin, _fdsin
278+
## `_dsin`, `_ldsin`, `_fdsin`
279279
280280
### Syntax
281281
@@ -299,7 +299,7 @@ These floating-point primitives return the sine of *`x`* offset by the *`quadran
299299

300300
## Requirements
301301

302-
Header: \<math.h>
302+
Header: `<math.h>`
303303

304304
For more compatibility information, see [Compatibility](../compatibility.md).
305305

0 commit comments

Comments
 (0)