Returns the remainder of the division of this value by x
.
Returns the remainder of the division of this value by x
.
Returns the remainder of the division of this value by x
.
Returns the remainder of the division of this value by x
.
Returns the remainder of the division of this value by x
.
Returns the remainder of the division of this value by x
.
Returns the remainder of the division of this value by x
.
Returns the product of this value and x
.
Returns the product of this value and x
.
Returns the product of this value and x
.
Returns the product of this value and x
.
Returns the product of this value and x
.
Returns the product of this value and x
.
Returns the product of this value and x
.
Returns the sum of this value and x
.
Returns the sum of this value and x
.
Returns the sum of this value and x
.
Returns the sum of this value and x
.
Returns the sum of this value and x
.
Returns the sum of this value and x
.
Returns the sum of this value and x
.
Converts this PosFloat
's value to a string then concatenates the given string.
Converts this PosFloat
's value to a string then concatenates the given string.
Returns the difference of this value and x
.
Returns the difference of this value and x
.
Returns the difference of this value and x
.
Returns the difference of this value and x
.
Returns the difference of this value and x
.
Returns the difference of this value and x
.
Returns the difference of this value and x
.
Returns the quotient of this value and x
.
Returns the quotient of this value and x
.
Returns the quotient of this value and x
.
Returns the quotient of this value and x
.
Returns the quotient of this value and x
.
Returns the quotient of this value and x
.
Returns the quotient of this value and x
.
Returns true
if this value is less than x, false
otherwise.
Returns true
if this value is less than x, false
otherwise.
Returns true
if this value is less than x, false
otherwise.
Returns true
if this value is less than x, false
otherwise.
Returns true
if this value is less than x, false
otherwise.
Returns true
if this value is less than x, false
otherwise.
Returns true
if this value is less than x, false
otherwise.
Returns true
if this value is less than or equal to x, false
otherwise.
Returns true
if this value is less than or equal to x, false
otherwise.
Returns true
if this value is less than or equal to x, false
otherwise.
Returns true
if this value is less than or equal to x, false
otherwise.
Returns true
if this value is less than or equal to x, false
otherwise.
Returns true
if this value is less than or equal to x, false
otherwise.
Returns true
if this value is less than or equal to x, false
otherwise.
Returns true
if this value is greater than x, false
otherwise.
Returns true
if this value is greater than x, false
otherwise.
Returns true
if this value is greater than x, false
otherwise.
Returns true
if this value is greater than x, false
otherwise.
Returns true
if this value is greater than x, false
otherwise.
Returns true
if this value is greater than x, false
otherwise.
Returns true
if this value is greater than x, false
otherwise.
Returns true
if this value is greater than or equal to x, false
otherwise.
Returns true
if this value is greater than or equal to x, false
otherwise.
Returns true
if this value is greater than or equal to x, false
otherwise.
Returns true
if this value is greater than or equal to x, false
otherwise.
Returns true
if this value is greater than or equal to x, false
otherwise.
Returns true
if this value is greater than or equal to x, false
otherwise.
Returns true
if this value is greater than or equal to x, false
otherwise.
Returns the smallest (closest to 0) PosFloat
that is greater than or equal to this PosFloat
and represents a mathematical integer.
Applies the passed Float => Float
function to the underlying Float
value, and if the result is positive, returns the result wrapped in a PosFloat
,
else throws AssertionError
.
Applies the passed Float => Float
function to the underlying Float
value, and if the result is positive, returns the result wrapped in a PosFloat
,
else throws AssertionError
.
This method will inspect the result of applying the given function to this
PosFloat
's underlying Float
value and if the result
is positive, it will return a PosFloat
representing that value.
Otherwise, the Float
value returned by the given function is
not positive, so this method will throw AssertionError
.
This method 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 an Float
is positive.
With this method, you are asserting that you are convinced the result of
the computation represented by applying the given function to this PosFloat
's
value will not produce invalid value.
Instead of producing such invalid values, this method will throw AssertionError
.
the Float => Float
function to apply to this PosFloat
's
underlying Float
value.
the result of applying this PosFloat
's underlying Float
value to
to the passed function, wrapped in a PosFloat
if it is positive (else throws AssertionError
).
if the result of applying this PosFloat
's underlying Float
value to
to the passed function is not positive.
Returns the greatest (closest to infinity) PosZFloat
that is less than or equal to
this PosZFloat
and represents a mathematical integer.
True if this PosFloat
value is any finite value (i.
True if this PosFloat
value is any finite value (i.e., it is neither positive nor negative infinity), else false.
True if this PosFloat
value represents positive infinity, else false.
True if this PosFloat
value represents positive infinity, else false.
Indicates whether this PosFloat
has a value that is a whole number: it is finite and it has no fraction part.
Returns this
if this > that
or that
otherwise.
Returns this
if this > that
or that
otherwise.
Returns this
if this < that
or that
otherwise.
Returns this
if this < that
or that
otherwise.
Returns the PosFloat
sum of this PosFloat
's value and the given PosZFloat
value.
Returns the PosFloat
sum of this PosFloat
's value and the given PosZFloat
value.
This method will always succeed (not throw an exception) because adding a positive Float and non-negative Float and another positive Float will always result in another positive Float value (though the result may be infinity).
Rounds this PosFloat
value to the nearest whole number value that can be expressed as an PosZInt
, returning the result as a PosZInt
.
Converts this PosFloat
to a Byte
.
Converts this PosFloat
to a Byte
.
Converts this PosFloat
to a Char
.
Converts this PosFloat
to a Char
.
Converts an angle measured in radians to an approximately equivalent angle measured in degrees.
Converts an angle measured in radians to an approximately equivalent angle measured in degrees.
the measurement of the angle x in degrees.
Converts this PosFloat
to a Double
.
Converts this PosFloat
to a Double
.
Converts this PosFloat
to a Float
.
Converts this PosFloat
to a Float
.
Converts this PosFloat
to an Int
.
Converts this PosFloat
to an Int
.
Converts this PosFloat
to a Long
.
Converts this PosFloat
to a Long
.
Converts an angle measured in degrees to an approximately equivalent angle measured in radians.
Converts an angle measured in degrees to an approximately equivalent angle measured in radians.
the measurement of the angle x in radians.
Converts this PosFloat
to a Short
.
Converts this PosFloat
to a Short
.
A string representation of this PosFloat
.
A string representation of this PosFloat
.
Returns this value, unmodified.
Returns the negation of this value.
The Float
value underlying this PosFloat
.
The Float
value underlying this PosFloat
.
An
AnyVal
for positiveFloat
s.Note: a
PosFloat
may not equal 0.0. If you want positive number or 0, use PosZFloat.Because
PosFloat
is anAnyVal
it will usually be as efficient as anFloat
, being boxed only when anFloat
would have been boxed.The
PosFloat.apply
factory method is implemented in terms of a macro that checks literals for validity at compile time. CallingPosFloat.apply
with a literalFloat
value will either produce a validPosFloat
instance at run time or an error at compile time. Here's an example:PosFloat.apply
cannot be used if the value being passed is a variable (i.e., not a literal), because the macro cannot determine the validity of variables at compile time (just literals). If you try to pass a variable toPosFloat.apply
, you'll get a compiler error that suggests you use a different factor method,PosFloat.from
, instead:The
PosFloat.from
factory method will inspect the value at runtime and return anOption[PosFloat]
. If the value is valid,PosFloat.from
will return aSome[PosFloat]
, else it will return aNone
. Here's an example:The
PosFloat.apply
factory method is marked implicit, so that you can pass literalFloat
s into methods that requirePosFloat
, and get the same compile-time checking you get when callingPosFloat.apply
explicitly. Here's an example:This example also demonstrates that the
PosFloat
companion object also defines implicit widening conversions when no loss of precision will occur. This makes it convenient to use aPosFloat
where aFloat
or wider type is needed. An example is the subtraction in the body of theinvert
method defined above,Float.MaxValue - pos
. AlthoughFloat.MaxValue
is aFloat
, which has no-
method that takes aPosFloat
(the type ofpos
), you can still subtractpos
, because thePosFloat
will be implicitly widened toFloat
.