Display the source code in std/math/remainder.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.

Function `std.math.remainder.fmod`

Calculates the remainder from the calculation x/y.


						
				real fmod
				(
				

				  real x,
				

				  real y
				

				) nothrow @nogc @trusted;

Returns

The value of x - i * y, where i is the number of times that y can be completely subtracted from x. The result has the same sign as x.

Special Values
x	y	fmod(x, y)	invalid?
±0.0	not 0.0	±0.0	no
±∞	anything	NAN	yes
anything	±0.0	NAN	yes
!=±∞	±∞	x	no

Example

import std.math.operations : feqrel;
import std.math.traits : isIdentical, isNaN;

assert(isIdentical(fmod(0.0, 1.0), 0.0));
assert(fmod(5.0, 3.0).feqrel(2.0) > 16);
assert(isNaN(fmod(5.0, 0.0)));

Authors

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

License

Boost License 1.0.