The largest value representable as a non-negative Float,
which is PosZFloat(3.4028235E38).
The largest value representable as a non-negative Float,
which is PosZFloat(3.4028235E38).
The smallest value representable as a positive
Float, which is PosFloat(1.4E-45).
The smallest value representable as a positive
Float, which is PosFloat(1.4E-45).
The smallest value representable as a non-negative Float,
which is PosZFloat(0.0F).
The smallest value representable as a non-negative Float,
which is PosZFloat(0.0F).
The positive infinity value, which is PosZFloat.ensuringValid(Float.PositiveInfinity).
The positive infinity value, which is PosZFloat.ensuringValid(Float.PositiveInfinity).
A factory method, implemented via a macro, that produces a
PosZFloat if passed a valid Float
literal, otherwise a compile time error.
A factory method, implemented via a macro, that produces a
PosZFloat 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-negative Float literal,
i.e., with a value greater than or equal to 0, it will return
a PosZFloat representing that value. Otherwise,
the passed Float expression is either a literal
that is 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 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-negative, to return wrapped in a
PosZFloat at run time.
the specified, valid Float literal
value wrapped in a PosZFloat. (If the
specified expression is not a valid Float
literal, the invocation of this method will not
compile.)
A factory/assertion method that produces an PosZFloat given a
valid Float value, or throws AssertionError,
if given an invalid Float value.
A factory/assertion method that produces an PosZFloat 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-negative Float,
i.e., a value greater than or equal to 0, it will
return a PosZFloat representing that value.
Otherwise, the passed * Float value is 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 Float literals at
compile time, whereas this method 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 or zero.
the Float to inspect, and if non-negative, return
wrapped in a PosZFloat.
the specified Float value wrapped
in a PosZFloat, if it is positive, else
throws AssertionError.
if the passed value is not zero or positive
A factory method that produces an Option[PosZFloat] given a
Float value.
A factory method that produces an Option[PosZFloat] given a
Float value.
This method will inspect the passed Float value
and if it is a non-negative Float,
i.e., a value greater than or equal to 0, it will
return a PosZFloat representing that value,
wrapped in a Some. Otherwise, the passed
Float value is 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 Float literals at
compile time, whereas from inspects
Float values at run time.
the Float to inspect, and if non-negative, return
wrapped in a Some[PosZFloat].
the specified Float value wrapped
in a Some[PosZFloat], if it is positive, else
None.
A factory method that produces a PosZFloat given a
Float value and a default PosZFloat.
A factory method that produces a PosZFloat given a
Float value and a default PosZFloat.
This method will inspect the passed Float value and if
it is a positive or zero Float, i.e., a value greater
than or equal to 0.0f, it will return a PosZFloat representing that value.
Otherwise, the passed Float value is 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 Float literals at
compile time, whereas from inspects
Float values at run time.
the Float to inspect, and if positive or zero, return.
the PosZFloat to return if the passed
Float value is not positive or zero.
the specified Float value wrapped in a
PosZFloat, if it is positive or zero, else the
default PosZFloat value.
A predicate method that returns true if a given
Float value is positive or zero.
A predicate method that returns true if a given
Float value is positive or zero.
the Float to inspect, and if positive or zero, return true.
true if the specified Float is positive or zero, else false.
Implicit Ordering instance.
Returns the PosZFloat sum of the passed PosZFloat values first and
value second, and the PosZFloat values passed as varargs rest.
Returns the PosZFloat sum of the passed PosZFloat values first and
value second, and the PosZFloat values passed as varargs rest.
This method will always succeed (not throw an exception) because adding a positive or zero Float to another positive or zero Float will always result in another positive or zero Float value (though the result may be positive infinity).
This overloaded form of the sumOf method can sum more than two
values, but unlike its two-arg sibling, will entail boxing.
Returns the PosZFloat sum of the passed PosZFloat values x and y.
Returns the PosZFloat sum of the passed PosZFloat values x and y.
This method will always succeed (not throw an exception) because adding a positive or zero Float to another positive or zero Float will always result in another positive or zero Float value (though the result may be positive infinity).
This overloaded form of the method is used when there are just two arguments so that
boxing is avoided. The overloaded sumOf that takes a varargs of
PosZFloat starting at the third parameter can sum more than two
values, but will entail boxing and may therefore be less efficient.
Implicit widening conversion from PosZFloat to
Double.
Implicit widening conversion from PosZFloat to
Double.
the Float value underlying the specified
PosZFloat, widened to Double.
Implicit widening conversion from PosZFloat to
Float.
Implicit widening conversion from PosZFloat to
Float.
the Float value underlying the specified
PosZFloat.
Implicit widening conversion from PosZFloat to
PosZDouble.
Implicit widening conversion from PosZFloat to
PosZDouble.
the Float value underlying the specified
PosZFloat, widened to Double
and wrapped in a PosZDouble.
The companion object for
PosZFloatthat offers factory methods that producePosZFloats, implicit widening conversions fromPosZFloatto other numeric types, and maximum and minimum constant values forPosZFloat.