FiniteFloat

A factory/assertion method that produces a FiniteFloat given a valid Float value, or throws AssertionError, if given an invalid Float value.

Note: you should use this method only when you are convinced that it will always succeed, i.e., never throw an exception. It is good practice to add a comment near the invocation of this method indicating ''why'' you think it will always succeed to document your reasoning. If you are not sure an ensuringValid call will always succeed, you should use one of the other factory or validation methods provided on this object instead: isValid, tryingValid, passOrElse, goodOrElse, or rightOrElse.

This method will inspect the passed Float value and if it is a finite Float, it will return a FiniteFloat representing that value. Otherwise, the passed Float value is not finite, so this method will throw AssertionError.

This factory method differs from the apply factory method in that apply is implemented via a macro that inspects Float literals at compile time, whereas from inspects Float values at run time. It differs from a vanilla assert or ensuring call in that you get something you didn't already have if the assertion succeeds: a type that promises a Float is positive.

A factory method that produces an Option[FiniteFloat] given a Float value.

This method will inspect the passed Float value and if it is a finite Float, it will return a FiniteFloat representing that value wrapped in a Some. Otherwise, the passed Float value is not finite, so this method will return None.

This factory method differs from the apply factory method in that apply is implemented via a macro that inspects Float literals at compile time, whereas from inspects Float values at run time.

A factory method that produces a FiniteFloat given a Float value and a default FiniteFloat.

This method will inspect the passed Float value and if it is a finite Float, it will return a FiniteFloat representing that value. Otherwise, the passed Float value is not finite, so this method will return the passed default value.

This factory method differs from the apply factory method in that apply is implemented via a macro that inspects Float literals at compile time, whereas from inspects Float values at run time.

A factory/validation method that produces a FiniteFloat, wrapped in a Good, given a valid Float value, or if the given Float is invalid, an error value of type B produced by passing the given invalid Float value to the given function f, wrapped in a Bad.

This method will inspect the passed Float value and if it is a finite Float, it will return a FiniteFloat representing that value, wrapped in a Good. Otherwise, the passed Float value is not finite, so this method will return a result of type B obtained by passing the invalid Float value to the given function f, wrapped in a Bad.

This factory method differs from the apply factory method in that apply is implemented via a macro that inspects Float literals at compile time, whereas this method inspects Float values at run time.

A predicate method that returns true if a given Float value is finite.

A validation method that produces a Pass given a valid Float value, or an error value of type E produced by passing the given invalid Int value to the given function f, wrapped in a Fail.

This method will inspect the passed Float value and if it is a finite Float, it will return a Pass. Otherwise, the passed Float value is finite, so this method will return a result of type E obtained by passing the invalid Float value to the given function f, wrapped in a Fail.

This factory method differs from the apply factory method in that apply is implemented via a macro that inspects Float literals at compile time, whereas this method inspects Float values at run time.

A factory/validation method that produces a FiniteFloat, wrapped in a Right, given a valid Int value, or if the given Int is invalid, an error value of type L produced by passing the given invalid Int value to the given function f, wrapped in a Left.

This method will inspect the passed Int value and if it is a finite Int, it will return a FiniteFloat representing that value, wrapped in a Right. Otherwise, the passed Int value is not finite, so this method will return a result of type L obtained by passing the invalid Int value to the given function f, wrapped in a Left.

This factory method differs from the apply factory method in that apply is implemented via a macro that inspects Int literals at compile time, whereas this method inspects Int values at run time.

A factory/validation method that produces a FiniteFloat, wrapped in a Success, given a valid Float value, or if the given Float is invalid, an AssertionError, wrapped in a Failure.

This method will inspect the passed Float value and if it is a finite Float, it will return a FiniteFloat representing that value, wrapped in a Success. Otherwise, the passed Float value is not finite, so this method will return an AssertionError, wrapped in a Failure.

This factory method differs from the apply factory method in that apply is implemented via a macro that inspects Float literals at compile time, whereas this method inspects Float values at run time.

The largest value representable as a finite Float, which is FiniteFloat(3.4028235E38).

The smallest positive value greater than 0.0d representable as a FiniteFloat, which is FiniteFloat(1.4E-45).

The smallest value representable as a finite Float, which is FiniteFloat(-3.4028235E38).

A factory method, implemented via a macro, that produces a FiniteFloat if passed a valid Float literal, otherwise a compile time error.

The macro that implements this method will inspect the specified Float expression at compile time. If the expression is a finite Float literal, it will return a FiniteFloat representing that value. Otherwise, the passed Float expression is either a literal that is not finite, or is not a literal, so this method will give a compiler error.

This factory method differs from the from factory method in that this method is implemented via a macro that inspects Float literals at compile time, whereas from inspects Float values at run time.

Implicit Ordering instance.

Implicit widening conversion from FiniteFloat to Double.

Implicit widening conversion from FiniteFloat to FiniteDouble.

Implicit widening conversion from FiniteFloat to Float.