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 PosZDouble
's value to a string then concatenates the given string.
Converts this PosZDouble
'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) PosZDouble
that is greater than or equal to this PosZDouble
and represents a mathematical integer.
Applies the passed Double => Double
function to the underlying Double
value, and if the result is positive or zero, returns the result wrapped in a PosZDouble
,
else throws AssertionError
.
Applies the passed Double => Double
function to the underlying Double
value, and if the result is positive or zero, returns the result wrapped in a PosZDouble
,
else throws AssertionError
.
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 a different method
on this class that returns a Double
result instead.
This method will inspect the result of applying the given function to this
PosZDouble
's underlying Double
value and if the result
is positive or zero, i.e., a value greater
than or equal to 0.0
, it will return a PosZDouble
representing that value.
Otherwise, the Double
value returned by the given function is
negative, 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 Double
is positive or zero.
With this method, you are asserting that you are convinced the result of
the computation represented by applying the given function to this PosZDouble
's
value will not produce a negative number, including Double.NegativeInfinity
, or Double.NaN
.
Instead of producing such invalid values, this method will throw AssertionError
.
the Double => Double
function to apply to this PosZDouble
's
underlying Double
value.
the result of applying this PosZDouble
's underlying Double
value to
to the passed function, wrapped in a PosZDouble
if it is positive or zero (else throws AssertionError
).
if the result of applying this PosZDouble
's underlying Double
value to
to the passed function is not positive or zero.
Returns the greatest (closest to positive infinity) PosZDouble
that is less than or equal to
this PosZDouble
and represents a mathematical integer.
Indicates whether this PosZDouble
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 PosZDouble
sum of this value and x
.
Returns the PosZDouble
sum of this value and x
.
This method will always succeed (not throw an exception) because adding a positive or zero Double to another positive or zero Double will always result in another positive or zero Double value (though the result may be positive infinity).
Rounds this PosZDouble
value to the nearest whole number value that can be expressed as a Long
, returning the result as a PosZLong
.
Create an inclusive Range
from this PosZDouble
value
to the specified end
with the specified step
value.
Create an inclusive Range
from this PosZDouble
value
to the specified end
with the specified step
value.
The final bound of the range to make.
The number to increase by for each step of the range.
A scala.collection.immutable.NumericRange.Inclusive[Double] from this
up to
and including end
.
Create an inclusive Range
from this PosZDouble
value
to the specified end
with step value 1.
Create an inclusive Range
from this PosZDouble
value
to the specified end
with step value 1.
The final bound of the range to make.
A NumericRange[Double]] from this
up to
and including end
.
Converts this PosZDouble
to a Byte
.
Converts this PosZDouble
to a Byte
.
Converts this PosZDouble
to a Char
.
Converts this PosZDouble
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 PosZDouble
to a Double
.
Converts this PosZDouble
to a Double
.
Converts this PosZDouble
to a Float
.
Converts this PosZDouble
to a Float
.
Converts this PosZDouble
to an Int
.
Converts this PosZDouble
to an Int
.
Converts this PosZDouble
to a Long
.
Converts this PosZDouble
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 PosZDouble
to a Short
.
Converts this PosZDouble
to a Short
.
A string representation of this PosZDouble
.
A string representation of this PosZDouble
.
Returns this value, unmodified.
Returns the negation of this value.
Create a Range
from this PosZDouble
value
until the specified end
(exclusive) with the specified step
value.
Create a Range
from this PosZDouble
value
until the specified end
(exclusive) with the specified step
value.
The final bound of the range to make.
The number to increase by for each step of the range.
A scala.collection.immutable.NumericRange.Exclusive[Double] from this
up to but
not including end
.
Create a Range
from this PosZDouble
value
until the specified end
(exclusive) with step value 1.
Create a Range
from this PosZDouble
value
until the specified end
(exclusive) with step value 1.
The final bound of the range to make.
A NumericRange[Double]] from this
up to but
not including end
.
The Double
value underlying this
PosZDouble
.
The Double
value underlying this
PosZDouble
.
An
AnyVal
for non-negativeDouble
s.Note: A
PosZDouble
may have valueDouble.PositiveInfinity
, but cannot have valueDouble.NegativeInfinity
orDouble.NaN
.Because
PosZDouble
is anAnyVal
it will usually be as efficient as anDouble
, being boxed only when aDouble
would have been boxed.The
PosZDouble.apply
factory method is implemented in terms of a macro that checks literals for validity at compile time. CallingPosZDouble.apply
with a literalDouble
value will either produce a validPosZDouble
instance at run time or an error at compile time. Here's an example:PosZDouble.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 toPosZDouble.apply
, you'll get a compiler error that suggests you use a different factor method,PosZDouble.from
, instead:The
PosZDouble.from
factory method will inspect the value at runtime and return anOption[PosZDouble]
. If the value is valid,PosZDouble.from
will return aSome[PosZDouble]
, else it will return aNone
. Here's an example:The
PosZDouble.apply
factory method is marked implicit, so that you can pass literalDouble
s into methods that requirePosZDouble
, and get the same compile-time checking you get when callingPosZDouble.apply
explicitly. Here's an example:This example also demonstrates that the
PosZDouble
companion object also defines implicit widening conversions when a similar conversion is provided in Scala. This makes it convenient to use aPosZDouble
where aDouble
or wider type is needed. An example is the subtraction in the body of theinvert
method defined above,Double.MaxValue - pos
. AlthoughDouble.MaxValue
is aDouble
, which has no-
method that takes aPosZDouble
(the type ofpos
), you can still subtractpos
, because thePosZDouble
will be implicitly widened toDouble
.