PosZFiniteDouble
Related Docs:
class PosZFiniteDouble
| package anyvals
The largest value representable as a finite non-negative Double,
which is PosZFiniteDouble(1.7976931348623157E308).
The largest value representable as a finite non-negative Double,
which is PosZFiniteDouble(1.7976931348623157E308).
The smallest positive value greater than 0.0d representable as a PosZFiniteDouble, which is PosZFiniteDouble(4.9E-324).
The smallest positive value greater than 0.0d representable as a PosZFiniteDouble, which is PosZFiniteDouble(4.9E-324).
The smallest value representable as a finite non-negative
Double, which is PosZFiniteDouble(0.0).
The smallest value representable as a finite non-negative
Double, which is PosZFiniteDouble(0.0).
A factory method, implemented via a macro, that produces a
PosZFiniteDouble if passed a valid Double
literal, otherwise a compile time error.
A factory method, implemented via a macro, that produces a
PosZFiniteDouble if passed a valid Double
literal, otherwise a compile time error.
The macro that implements this method will inspect the
specified Double expression at compile time. If
the expression is a finite non-negative Double literal,
it will return a PosZFiniteDouble representing that value.
Otherwise, the passed Double expression is either a literal
that is not finite non-negative, 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 Double literals at compile
time, whereas from inspects Double
values at run time.
the Double literal expression to
inspect at compile time, and if finite non-negative, to return
wrapped in a PosZFiniteDouble at run time.
the specified, valid Double literal
value wrapped in a PosZFiniteDouble. (If the
specified expression is not a valid Double
literal, the invocation of this method will not
compile.)
A factory/assertion method that produces a PosZFiniteDouble given a
valid Double value, or throws AssertionError,
if given an invalid Double value.
A factory/assertion method that produces a PosZFiniteDouble given a
valid Double value, or throws AssertionError,
if given an invalid Double value.
This method will inspect the passed Double value and if
it is a finite non-negative Double, it will return a PosZFiniteDouble
representing that value. Otherwise, the passed Double value is not finite non-negative,
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 Double literals at
compile time, whereas from inspects
Double 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 Double is finite non-negative.
the Double to inspect, and if finite non-negative, return
wrapped in a PosZFiniteDouble.
the specified Double value wrapped in a
PosZFiniteDouble, if it is finite non-negative, else
throws AssertionError.
AssertionError if the passed value is not finite non-negative
A factory method that produces an Option[PosZFiniteDouble] given a
Double value.
A factory method that produces an Option[PosZFiniteDouble] given a
Double value.
This method will inspect the passed Double value and if
it is a finite non-negative Double, it will return a PosZFiniteDouble
representing that value, wrapped in a Some. Otherwise, the passed Double
value is not finite non-negative, 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 Double literals at
compile time, whereas from inspects
Double values at run time.
the Double to inspect, and if finite non-negative, return
wrapped in a Some[PosZFiniteDouble].
the specified Double value wrapped in a
Some[PosZFiniteDouble], if it is PosZFiniteDouble, else
None.
A factory method that produces a PosZFiniteDouble given a
Double value and a default PosZFiniteDouble.
A factory method that produces a PosZFiniteDouble given a
Double value and a default PosZFiniteDouble.
This method will inspect the passed Double value and if
it is a finite non-negative Double, it will return a PosZFiniteDouble
representing that value. Otherwise, the passed Double value is finite non-negative,
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 Double literals at
compile time, whereas from inspects
Double values at run time.
the Double to inspect, and if finite non-negative, return.
the PosZFiniteDouble to return if the passed
Double value is not finite non-negative.
the specified Double value wrapped in a
PosZFiniteDouble, if it is finite non-negative, else the
default PosZFiniteDouble value.
A factory/validation method that produces a PosZFiniteDouble, wrapped
in a Good, given a valid Double value, or if the
given Double is invalid, an error value of type B
produced by passing the given invalid Double value
to the given function f, wrapped in a Bad.
A factory/validation method that produces a PosZFiniteDouble, wrapped
in a Good, given a valid Double value, or if the
given Double is invalid, an error value of type B
produced by passing the given invalid Double value
to the given function f, wrapped in a Bad.
This method will inspect the passed Double value and if
it is a finite non-negative Double, it will return a PosZFiniteDouble
representing that value, wrapped in a Good.
Otherwise, the passed Double value is not finite non-negative, so this
method will return a result of type B obtained by passing
the invalid Double 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
Double literals at compile time, whereas this method inspects
Double values at run time.
the Double to inspect, and if finite non-negative, return
wrapped in a Good(PosZFiniteDouble).
the specified Double value wrapped
in a Good(PosZFiniteDouble), if it is finite non-negative, else a Bad(f(value)).
A predicate method that returns true if a given
Double value is finite non-negative.
A predicate method that returns true if a given
Double value is finite non-negative.
the Double to inspect, and if finite non-negative, return true.
true if the specified Double is positive, else false.
Implicit Ordering instance.
A validation method that produces a Pass
given a valid Double 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 Double 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 Double value and if
it is a finite non-negative Double, it will return a Pass.
Otherwise, the passed Double value is finite non-negative, so this
method will return a result of type E obtained by passing
the invalid Double 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
Double literals at compile time, whereas this method inspects
Double values at run time.
the Int to validate that it is finite non-negative.
a Pass if the specified Int value is finite non-negative,
else a Fail containing an error value produced by passing the
specified Double to the given function f.
A factory/validation method that produces a PosZFiniteDouble, wrapped
in a Right, given a valid Double value, or if the
given Double is invalid, an error value of type L
produced by passing the given invalid Double value
to the given function f, wrapped in a Left.
A factory/validation method that produces a PosZFiniteDouble, wrapped
in a Right, given a valid Double value, or if the
given Double is invalid, an error value of type L
produced by passing the given invalid Double value
to the given function f, wrapped in a Left.
This method will inspect the passed Double value and if
it is a finite non-negative Double, it will return a PosZFiniteDouble
representing that value, wrapped in a Right.
Otherwise, the passed Double value is not finite non-negative, so this
method will return a result of type L obtained by passing
the invalid Double 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
Double literals at compile time, whereas this method inspects
Double values at run time.
the Double to inspect, and if finite non-negative, return
wrapped in a Right(PosZFiniteDouble).
the specified Double value wrapped
in a Right(PosZFiniteDouble), if it is finite non-negative, else a Left(f(value)).
A factory/validation method that produces a PosZFiniteDouble, 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 PosZFiniteDouble, wrapped
in a Success, given a valid Float value, or if the
given Float is invalid, an AssertionError, wrapped
in a Failure.
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 non-negative Float, it will return a PosZFiniteDouble
representing that value, wrapped in a Success.
Otherwise, the passed Float value is not finite non-negative, 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 non-negative, return
wrapped in a Success(PosZFiniteDouble).
the specified Float value wrapped
in a Success(PosZFiniteDouble), if it is finite non-negative, else a Failure(AssertionError).
Implicit widening conversion from PosZFiniteDouble to
Double.
Implicit widening conversion from PosZFiniteDouble to
Double.
the PosZFiniteDouble to widen
the Double value underlying the specified
PosZFiniteDouble
Implicit widening conversion from PosZFiniteDouble to PosZDouble.
Implicit widening conversion from PosZFiniteDouble to PosZDouble.
the PosZFiniteDouble to widen
the Double value underlying the specified PosZFiniteDouble,
widened to Double and wrapped in a PosZDouble.
The companion object for
PosZFiniteDoublethat offers factory methods that producePosZFiniteDoubles, implicit widening conversions fromPosZFiniteDoubleto other numeric types, and maximum and minimum constant values forPosZFiniteDouble.