PosFiniteFloat
Related Docs:
class PosFiniteFloat
| package anyvals
The largest value representable as a finite positive Float,
which is PosFiniteFloat(3.4028235E38).
The largest value representable as a finite positive Float,
which is PosFiniteFloat(3.4028235E38).
The smallest value representable as a finite positive
Float, which is PosFiniteFloat(1.4E-45).
The smallest value representable as a finite positive
Float, which is PosFiniteFloat(1.4E-45).
A factory method, implemented via a macro, that produces a
PosFiniteFloat if passed a valid Float
literal, otherwise a compile time error.
A factory method, implemented via a macro, that produces a
PosFiniteFloat 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 positive Float literal,
it will return a PosFiniteFloat representing that value.
Otherwise, the passed Float expression is either a literal
that is not finite positive, 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.
the Float literal expression to
inspect at compile time, and if finite positive, to return
wrapped in a PosFiniteFloat at run time.
the specified, valid Float literal
value wrapped in a PosFiniteFloat. (If the
specified expression is not a valid Float
literal, the invocation of this method will not
compile.)
A factory/assertion method that produces a PosFiniteFloat given a
valid Float value, or throws AssertionError,
if given an invalid Float value.
A factory/assertion method that produces a PosFiniteFloat 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 positive Float, it will return a PosFiniteFloat representing that value.
Otherwise, the passed Float value is not finite positive, 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.
the Float to inspect, and if finite positive, return
wrapped in a PosFiniteFloat.
the specified Float value wrapped in a
PosFiniteFloat, if it is finite positive, else
throws AssertionError.
AssertionError if the passed value is not finite positive
A factory method that produces an Option[PosFiniteFloat] given a
Float value.
A factory method that produces an Option[PosFiniteFloat] given a
Float value.
This method will inspect the passed Float value and if
it is a finite positive Float, it will return a PosFiniteFloat
representing that value wrapped in a Some. Otherwise, the passed Float
value is not finite positive, 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.
the Float to inspect, and if finite positive, return
wrapped in a Some[PosFiniteFloat].
the specified Float value wrapped in a
Some[PosFiniteFloat], if it is finite positive, else
None.
A factory method that produces a PosFiniteFloat given a
Float value and a default PosFiniteFloat.
A factory method that produces a PosFiniteFloat given a
Float value and a default PosFiniteFloat.
This method will inspect the passed Float value and if
it is a finite positive Float, it will return a PosFiniteFloat representing that value.
Otherwise, the passed Float value is not finite positive, 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.
the Float to inspect, and if finite positive, return.
the PosFiniteFloat to return if the passed
Float value is not finite positive.
the specified Float value wrapped in a
PosFiniteFloat, if it is finite positive, else the
default PosFiniteFloat value.
A factory/validation method that produces a PosFiniteFloat, 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.
A factory/validation method that produces a PosFiniteFloat, 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 positive Float, it will return a PosFiniteFloat
representing that value, wrapped in a Good.
Otherwise, the passed Float value is not finite positive, 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.
the Float to inspect, and if finite positive, return
wrapped in a Good(PosFiniteFloat).
the specified Float value wrapped
in a Good(PosFiniteFloat), if it is finite positive, else a Bad(f(value)).
A predicate method that returns true if a given
Float value is finite positive.
A predicate method that returns true if a given
Float value is finite positive.
the Float to inspect, and if finite positive, return true.
true if the specified Float is finite positive, else false.
Implicit Ordering instance.
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.
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 positive Float, it will return a Pass.
Otherwise, the passed Float value is finite positive, 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.
the Float to validate that it is finite positive.
a Pass if the specified Float value is finite positive,
else a Fail containing an error value produced by passing the
specified Float to the given function f.
A factory/validation method that produces a PosFiniteFloat, 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.
A factory/validation method that produces a PosFiniteFloat, 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 positive Int, it will return a PosFiniteFloat
representing that value, wrapped in a Right.
Otherwise, the passed Int value is not finite positive, 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.
the Int to inspect, and if finite positive, return
wrapped in a Right(PosFiniteFloat).
the specified Int value wrapped
in a Right(PosFiniteFloat), if it is finite positive, else a Left(f(value)).
A factory/validation method that produces a PosFiniteFloat, wrapped
in a Success, given a valid Float value, or if the
given Float is invalid, an AssertionError, wrapped
in a Failure.
A factory/validation method that produces a PosFiniteFloat, 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 positive Float, it will return a PosFiniteFloat
representing that value, wrapped in a Success.
Otherwise, the passed Float value is not finite positive, 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 Float to inspect, and if finite positive, return
wrapped in a Success(PosFiniteFloat).
the specified Float value wrapped
in a Success(PosFiniteFloat), if it is finite positive, else a Failure(AssertionError).
Implicit widening conversion from PosFiniteFloat to
Double.
Implicit widening conversion from PosFiniteFloat to
Double.
the PosFiniteFloat to widen
the Float value underlying the
specified PosFiniteFloat, widened to
Double.
Implicit widening conversion from PosFiniteFloat to FiniteDouble.
Implicit widening conversion from PosFiniteFloat to FiniteDouble.
the PosFiniteFloat to widen
the Float value underlying the specified PosFiniteFloat,
widened to Double and wrapped in a FiniteDouble.
Implicit widening conversion from PosFiniteFloat to FiniteFloat.
Implicit widening conversion from PosFiniteFloat to FiniteFloat.
the PosFiniteFloat to widen
the Float value underlying the specified PosFiniteFloat,
widened to Float and wrapped in a FiniteFloat.
Implicit widening conversion from PosFiniteFloat to
Float.
Implicit widening conversion from PosFiniteFloat to
Float.
the PosFiniteFloat to widen
the Float value underlying the
specified PosFiniteFloat
Implicit widening conversion from PosFiniteFloat to NonZeroDouble.
Implicit widening conversion from PosFiniteFloat to NonZeroDouble.
the PosFiniteFloat to widen
the Float value underlying the specified PosFiniteFloat,
widened to Double and wrapped in a NonZeroDouble.
Implicit widening conversion from PosFiniteFloat to NonZeroFloat.
Implicit widening conversion from PosFiniteFloat to NonZeroFloat.
the PosFiniteFloat to widen
the Float value underlying the specified PosFiniteFloat,
widened to Float and wrapped in a NonZeroFloat.
Implicit widening conversion from PosFiniteFloat to PosDouble.
Implicit widening conversion from PosFiniteFloat to PosDouble.
the PosFiniteFloat to widen
the Float value underlying the specified PosFiniteFloat,
widened to Double and wrapped in a PosDouble.
Implicit widening conversion from PosFiniteFloat to PosFiniteDouble.
Implicit widening conversion from PosFiniteFloat to PosFiniteDouble.
the PosFiniteFloat to widen
the Float value underlying the specified PosFiniteFloat,
widened to Double and wrapped in a PosFiniteDouble.
Implicit widening conversion from PosFiniteFloat to PosZDouble.
Implicit widening conversion from PosFiniteFloat to PosZDouble.
the PosFiniteFloat to widen
the Float value underlying the specified PosFiniteFloat,
widened to Double and wrapped in a PosZDouble.
Implicit widening conversion from PosFiniteFloat to PosZFiniteDouble.
Implicit widening conversion from PosFiniteFloat to PosZFiniteDouble.
the PosFiniteFloat to widen
the Float value underlying the specified PosFiniteFloat,
widened to Double and wrapped in a PosZFiniteDouble.
Implicit widening conversion from PosFiniteFloat to PosZFiniteFloat.
Implicit widening conversion from PosFiniteFloat to PosZFiniteFloat.
the PosFiniteFloat to widen
the Float value underlying the specified PosFiniteFloat,
widened to Float and wrapped in a PosZFiniteFloat.
Implicit widening conversion from PosFiniteFloat to PosZFloat.
Implicit widening conversion from PosFiniteFloat to PosZFloat.
the PosFiniteFloat to widen
the Float value underlying the specified PosFiniteFloat,
widened to Float and wrapped in a PosZFloat.
The companion object for
PosFiniteFloatthat offers factory methods that producePosFiniteFloats, implicit widening conversions fromPosFiniteFloatto other numeric types, and maximum and minimum constant values forPosFiniteFloat.