Display the source code in std/math/hardware.d from which this page was generated on github.

If you spot a problem with this page, click here to create a Bugzilla issue.

Quickly fork, edit online, and submit a pull request for this page. Requires a signed-in GitHub account. This works well for small changes. If you'd like to make larger changes you may want to consider using local clone.

`std.math.hardware.IeeeFlags/ieeeFlags` - multiple declarations

Function ieeeFlags


						
				IeeeFlags ieeeFlags() pure nothrow @property @nogc @trusted;

Returns

snapshot of the current state of the floating-point status flags

Example

import std.math.traits : isNaN;

resetIeeeFlags();
real a = 3.5;

a /= 0.0L;
writeln(a); // real.infinity
assert(ieeeFlags.divByZero);

a *= 0.0L;
assert(isNaN(a));
assert(ieeeFlags.invalid);

Struct IeeeFlags

IEEE exception status flags ('sticky bits')


						
				struct IeeeFlags
				;

These flags indicate that an exceptional floating-point condition has occurred. They indicate that a NaN or an infinity has been generated, that a result is inexact, or that a signalling NaN has been encountered. If floating-point exceptions are enabled (unmasked), a hardware exception will be generated instead of setting these flags.

Properties

Name	Type	Description
`divByZero`[get]	`bool`	An infinity was generated by division by zero
`inexact`[get]	`bool`	The result cannot be represented exactly, so rounding occurred.
`invalid`[get]	`bool`	A machine NaN was generated.
`overflow`[get]	`bool`	An infinity was generated by overflow
`underflow`[get]	`bool`	A zero was generated by underflow

Example

import std.math.traits : isNaN;

static void func() {
    int a = 10 * 10;
}
real a = 3.5;
// Set all the flags to zero
resetIeeeFlags();
assert(!ieeeFlags.divByZero);
// Perform a division by zero.
a /= 0.0L;
writeln(a); // real.infinity
assert(ieeeFlags.divByZero);
// Create a NaN
a *= 0.0L;
assert(ieeeFlags.invalid);
assert(isNaN(a));

// Check that calling func() has no effect on the
// status flags.
IeeeFlags f = ieeeFlags;
func();
writeln(ieeeFlags); // f

Authors

Walter Bright, Don Clugston, Conversion of CEPHES math library to D by Iain Buclaw and David Nadlinger

License

Boost License 1.0.

API Documentation

std.math.hardware.IeeeFlags/ieeeFlags - multiple declarations

Function ieeeFlags

Returns

Example

Struct IeeeFlags

Properties

Example

Authors

License

`std.math.hardware.IeeeFlags/ieeeFlags` - multiple declarations