The largest value representable as a non-negative Double
,
which is PosZDouble(1.7976931348623157E308)
.
The largest value representable as a non-negative Double
,
which is PosZDouble(1.7976931348623157E308)
.
The smallest value representable as a non-negative
Double
, which is PosZDouble(0.0)
.
The smallest value representable as a non-negative
Double
, which is PosZDouble(0.0)
.
The positive infinity value, which is PosZDouble.ensuringValid(Double.PositiveInfinity)
.
The positive infinity value, which is PosZDouble.ensuringValid(Double.PositiveInfinity)
.
A factory method, implemented via a macro, that produces a
PosZDouble
if passed a valid Double
literal, otherwise a compile time error.
A factory method, implemented via a macro, that produces a
PosZDouble
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 non-negative Double
literal,
it will return a PosZDouble
representing that value.
Otherwise, the passed Double
expression is either a literal
that is not 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 non-negative, to return
wrapped in a PosZDouble
at run time.
the specified, valid Double
literal
value wrapped in a PosZDouble
. (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 PosZDouble
given a
valid Double
value, or throws AssertionError
,
if given an invalid Double
value.
A factory/assertion method that produces a PosZDouble
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 non-negative Double
, it will return a PosZDouble
representing that value. Otherwise, the passed Double
value is not 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 non-negative.
the Double
to inspect, and if non-negative, return
wrapped in a PosZDouble
.
the specified Double
value wrapped in a
PosZDouble
, if it is non-negative, else
throws AssertionError
.
AssertionError
if the passed value is not non-negative
A factory method that produces an Option[PosZDouble]
given a
Double
value.
A factory method that produces an Option[PosZDouble]
given a
Double
value.
This method will inspect the passed Double
value and if
it is a non-negative Double
, it will return a PosZDouble
representing that value, wrapped in a Some
. Otherwise, the passed Double
value is not 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 non-negative, return
wrapped in a Some[PosZDouble]
.
the specified Double
value wrapped in a
Some[PosZDouble]
, if it is PosZDouble, else
None
.
A factory method that produces a PosZDouble
given a
Double
value and a default PosZDouble
.
A factory method that produces a PosZDouble
given a
Double
value and a default PosZDouble
.
This method will inspect the passed Double
value and if
it is a non-negative Double
, it will return a PosZDouble
representing that value. Otherwise, the passed Double
value is 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 non-negative, return.
the PosZDouble
to return if the passed
Double
value is not non-negative.
the specified Double
value wrapped in a
PosZDouble
, if it is non-negative, else the
default
PosZDouble
value.
A factory/validation method that produces a PosZDouble
, 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 PosZDouble
, 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 non-negative Double
, it will return a PosZDouble
representing that value, wrapped in a Good
.
Otherwise, the passed Double
value is not 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 non-negative, return
wrapped in a Good(PosZDouble)
.
the specified Double
value wrapped
in a Good(PosZDouble)
, if it is non-negative, else a Bad(f(value))
.
A predicate method that returns true if a given
Double
value is non-negative.
A predicate method that returns true if a given
Double
value is non-negative.
the Double
to inspect, and if 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 non-negative Double
, it will return a Pass
.
Otherwise, the passed Double
value is 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 non-negative.
a Pass
if the specified Int
value is 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 PosZDouble
, 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 PosZDouble
, 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 non-negative Double
, it will return a PosZDouble
representing that value, wrapped in a Right
.
Otherwise, the passed Double
value is not 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 non-negative, return
wrapped in a Right(PosZDouble)
.
the specified Double
value wrapped
in a Right(PosZDouble)
, if it is non-negative, else a Left(f(value))
.
Returns the PosZDouble
sum of the passed PosZDouble
values first
and
value second
, and the PosZDouble
values passed as varargs rest
.
Returns the PosZDouble
sum of the passed PosZDouble
values first
and
value second
, and the PosZDouble
values passed as varargs rest
.
This method will always succeed (not throw an exception) because adding a non-negative Double to another non-negative Double will always result in another non-negative Double value (though the result may be 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 PosZDouble
sum of the passed PosZDouble
values x
and y
.
Returns the PosZDouble
sum of the passed PosZDouble
values x
and y
.
This method will always succeed (not throw an exception) because adding a non-negative Double to another non-negative Double will always result in another PosZDouble Double value (though the result may be 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
PosZDouble
starting at the third parameter can sum more than two
values, but will entail boxing and may therefore be less efficient.
A factory/validation method that produces a PosZDouble
, 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 PosZDouble
, 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 non-negative Float
, it will return a PosZDouble
representing that value, wrapped in a Success
.
Otherwise, the passed Float
value is not 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 non-negative, return
wrapped in a Success(PosZDouble)
.
the specified Float
value wrapped
in a Success(PosZDouble)
, if it is non-negative, else a Failure(AssertionError)
.
Implicit widening conversion from PosZDouble
to
Double
.
Implicit widening conversion from PosZDouble
to
Double
.
the PosZDouble
to widen
the Double
value underlying the specified
PosZDouble
The companion object for
PosZDouble
that offers factory methods that producePosZDouble
s, implicit widening conversions fromPosZDouble
to other numeric types, and maximum and minimum constant values forPosZDouble
.