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

Returns the positive difference between x and y.


						
				real fdim
				(
				

				  real x,
				

				  real y
				

				) pure nothrow @nogc @safe;

Equivalent to fmax(x-y, 0).

Returns

Special Values
x, y	fdim(x, y)
x > y	x - y
x <= y	+0.0

Example

import std.math.traits : isNaN;

writeln(fdim(2.0, 0.0)); // 2.0
writeln(fdim(-2.0, 0.0)); // 0.0
writeln(fdim(real.infinity, 2.0)); // real.infinity
assert(isNaN(fdim(real.nan, 2.0)));
assert(isNaN(fdim(2.0, real.nan)));
assert(isNaN(fdim(real.nan, real.nan)));

Authors

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

License

Boost License 1.0.