FiniteFloatUnion
PackageReified.Refinements
Operations over floats that are known to be neither infinite nor <c>NaN</c>.
Specification
Kind
Union
Members
17
Examples
0
constraint'Signature
FiniteFloat.constraint'
refinementSignature
FiniteFloat.refinement
valueSignature
FiniteFloat.value input
createSignature
FiniteFloat.create value
ofFloatSignature
FiniteFloat.ofFloat value
Summary
| Name | Signature | Synopsis |
|---|---|---|
| Union cases | ||
| Value | this.Value | Returns the underlying value, which is always finite. |
| Operations | ||
| constraint' | FiniteFloat.constraint' | The portable constraint admitting only finite doubles. |
| refinement | FiniteFloat.refinement | No description available. |
| value | FiniteFloat.value input | Returns the underlying value. |
| create | FiniteFloat.create value | Admits a finite double, rejecting infinities and NaN. |
| ofFloat | FiniteFloat.ofFloat value | Returns the finite value, or None when it is infinite or NaN. |
| zero | FiniteFloat.zero | The additive identity. |
| one | FiniteFloat.one | The multiplicative identity. |
| negate | FiniteFloat.negate input | Negates the value. |
| abs | FiniteFloat.abs input | Returns the magnitude. |
| min | FiniteFloat.min left right | Returns the smaller value. |
| max | FiniteFloat.max left right | Returns the larger value. |
| compare | FiniteFloat.compare left right | Compares two finite doubles. |
| average | FiniteFloat.average values | Returns the arithmetic mean. |
| sum | FiniteFloat.sum values | Totals a non-empty list, failing when the total leaves the finite range. |
| minimum | FiniteFloat.minimum values | Returns the smallest value. |
| maximum | FiniteFloat.maximum values | Returns the largest value. |