Click or drag to resize

PrecisionCoerceZero(Double, Double) Method

Forces small numbers near zero to zero, according to the specified absolute accuracy.

Namespace: Altaxo.Calc
Assembly: AltaxoCore (in AltaxoCore.dll) Version: 4.8.3179.0 (4.8.3179.0)
Syntax
C#
Copy
public static double CoerceZero(
	this double a,
	double maximumAbsoluteError
)

Parameters

a  Double
The real number to coerce to zero, if it is almost zero.
maximumAbsoluteError  Double
The absolute threshold for a to consider it as zero.

Return Value

Double
Zero if |a| is smaller than maximumAbsoluteError, a otherwise.

Usage Note

In Visual Basic and C#, you can call this method as an instance method on any object of type Double. When you use instance method syntax to call this method, omit the first parameter. For more information, see Extension Methods (Visual Basic) or Extension Methods (C# Programming Guide).
Exceptions
ExceptionCondition
ArgumentOutOfRangeException Thrown if maximumAbsoluteError is smaller than zero.
See Also