NonZeroFloat
Related Docs:
class NonZeroFloat
| package anyvals
The largest value representable as a non-zero Float,
which is NonZeroFloat(3.4028235E38).
The largest value representable as a non-zero Float,
which is NonZeroFloat(3.4028235E38).
The smallest positive value greater than 0.0d representable as a NonZeroFloat, which is NonZeroFloat(1.4E-45).
The smallest positive value greater than 0.0d representable as a NonZeroFloat, which is NonZeroFloat(1.4E-45).
The smallest value representable as a non-zero
Float, which is NonZeroFloat(-3.4028235E38).
The smallest value representable as a non-zero
Float, which is NonZeroFloat(-3.4028235E38).
The negative infinity value, which is NonZeroFloat.ensuringValid(Float.NegativeInfinity).
The negative infinity value, which is NonZeroFloat.ensuringValid(Float.NegativeInfinity).
The positive infinity value, which is NonZeroFloat.ensuringValid(Float.PositiveInfinity).
The positive infinity value, which is NonZeroFloat.ensuringValid(Float.PositiveInfinity).
A factory method, implemented via a macro, that produces a
NonZeroFloat if passed a valid Float
literal, otherwise a compile time error.
A factory method, implemented via a macro, that produces a
NonZeroFloat 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 non-zero Float literal,
it will return a NonZeroFloat representing that value.
Otherwise, the passed Float expression is either a literal
that is not non-zero, 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 non-zero, to return
wrapped in a NonZeroFloat at run time.
the specified, valid Float literal
value wrapped in a NonZeroFloat. (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 NonZeroFloat given a
valid Float value, or throws AssertionError,
if given an invalid Float value.
A factory/assertion method that produces a NonZeroFloat 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 non-zero Float, it will return a NonZeroFloat representing that value.
Otherwise, the passed Float value is not non-zero, 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 non-zero, return
wrapped in a NonZeroFloat.
the specified Float value wrapped in a
NonZeroFloat, if it is non-zero, else
throws AssertionError.
AssertionError if the passed value is not non-zero
A factory method that produces an Option[NonZeroFloat] given a
Float value.
A factory method that produces an Option[NonZeroFloat] given a
Float value.
This method will inspect the passed Float value and if
it is a non-zero Float, it will return a NonZeroFloat
representing that value wrapped in a Some. Otherwise, the passed Float
value is not non-zero, 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 non-zero, return
wrapped in a Some[NonZeroFloat].
the specified Float value wrapped in a
Some[NonZeroFloat], if it is non-zero, else
None.
A factory method that produces a NonZeroFloat given a
Float value and a default NonZeroFloat.
A factory method that produces a NonZeroFloat given a
Float value and a default NonZeroFloat.
This method will inspect the passed Float value and if
it is a non-zero Float, it will return a NonZeroFloat representing that value.
Otherwise, the passed Float value is not non-zero, 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 non-zero, return.
the NonZeroFloat to return if the passed
Float value is not non-zero.
the specified Float value wrapped in a
NonZeroFloat, if it is non-zero, else the
default NonZeroFloat value.
A factory/validation method that produces a NonZeroFloat, 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 NonZeroFloat, 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 non-zero Float, it will return a NonZeroFloat
representing that value, wrapped in a Good.
Otherwise, the passed Float value is not non-zero, 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 non-zero, return
wrapped in a Good(NonZeroFloat).
the specified Float value wrapped
in a Good(NonZeroFloat), if it is non-zero, else a Bad(f(value)).
A predicate method that returns true if a given
Float value is non-zero.
A predicate method that returns true if a given
Float value is non-zero.
the Float to inspect, and if non-zero, return true.
true if the specified Float is non-zero, 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 non-zero Float, it will return a Pass.
Otherwise, the passed Float value is non-zero, 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 non-zero.
a Pass if the specified Float value is non-zero,
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 NonZeroFloat, 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 NonZeroFloat, 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 non-zero Int, it will return a NonZeroFloat
representing that value, wrapped in a Right.
Otherwise, the passed Int value is not non-zero, 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 non-zero, return
wrapped in a Right(NonZeroFloat).
the specified Int value wrapped
in a Right(NonZeroFloat), if it is non-zero, else a Left(f(value)).
A factory/validation method that produces a NonZeroFloat, 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 NonZeroFloat, 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 non-zero Float, it will return a NonZeroFloat
representing that value, wrapped in a Success.
Otherwise, the passed Float value is not non-zero, 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 non-zero, return
wrapped in a Success(NonZeroFloat).
the specified Float value wrapped
in a Success(NonZeroFloat), if it is non-zero, else a Failure(AssertionError).
Implicit widening conversion from NonZeroFloat to
Double.
Implicit widening conversion from NonZeroFloat to
Double.
the NonZeroFloat to widen
the Float value underlying the
specified NonZeroFloat, widened to
Double.
Implicit widening conversion from NonZeroFloat to
Float.
Implicit widening conversion from NonZeroFloat to
Float.
the NonZeroFloat to widen
the Float value underlying the
specified NonZeroFloat
Implicit widening conversion from NonZeroFloat to NonZeroDouble.
Implicit widening conversion from NonZeroFloat to NonZeroDouble.
the NonZeroFloat to widen
the Float value underlying the specified NonZeroFloat,
widened to Double and wrapped in a NonZeroDouble.
The companion object for
NonZeroFloatthat offers factory methods that produceNonZeroFloats, implicit widening conversions fromNonZeroFloatto other numeric types, and maximum and minimum constant values forNonZeroFloat.