PosFloat
Related Docs:
class PosFloat
| package anyvals
The largest value representable as a positive Float,
which is PosFloat(3.4028235E38).
The largest value representable as a positive Float,
which is PosFloat(3.4028235E38).
The smallest positive value greater than 0.0d representable as a PosFloat, which is PosFloat(1.4E-45).
The smallest positive value greater than 0.0d representable as a PosFloat, 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 positive
Float, which is PosFloat(1.4E-45).
The positive infinity value, which is PosFloat.ensuringValid(Float.PositiveInfinity).
The positive infinity value, which is PosFloat.ensuringValid(Float.PositiveInfinity).
A factory method, implemented via a macro, that produces a
PosFloat if passed a valid Float
literal, otherwise a compile time error.
A factory method, implemented via a macro, that produces a
PosFloat 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 positive Float literal,
it will return a PosFloat representing that value.
Otherwise, the passed Float expression is either a literal
that is not positive, 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 positive, to return
wrapped in a PosFloat at run time.
the specified, valid Float literal
value wrapped in a PosFloat. (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 PosFloat given a
valid Float value, or throws AssertionError,
if given an invalid Float value.
A factory/assertion method that produces a PosFloat 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 positive Float, it will return a PosFloat representing that value.
Otherwise, the passed Float value is not positive, 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 positive, return
wrapped in a PosFloat.
the specified Float value wrapped in a
PosFloat, if it is positive, else
throws AssertionError.
AssertionError if the passed value is not positive
A factory method that produces an Option[PosFloat] given a
Float value.
A factory method that produces an Option[PosFloat] given a
Float value.
This method will inspect the passed Float value and if
it is a positive Float, it will return a PosFloat
representing that value wrapped in a Some. Otherwise, the passed Float
value is not positive, 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 positive, return
wrapped in a Some[PosFloat].
the specified Float value wrapped in a
Some[PosFloat], if it is positive, else
None.
A factory method that produces a PosFloat given a
Float value and a default PosFloat.
A factory method that produces a PosFloat given a
Float value and a default PosFloat.
This method will inspect the passed Float value and if
it is a positive Float, it will return a PosFloat representing that value.
Otherwise, the passed Float value is not positive, 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, return.
the PosFloat to return if the passed
Float value is not positive.
the specified Float value wrapped in a
PosFloat, if it is positive, else the
default PosFloat value.
A factory/validation method that produces a PosFloat, 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 PosFloat, 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 positive Float, it will return a PosFloat
representing that value, wrapped in a Good.
Otherwise, the passed Float value is not positive, 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 positive, return
wrapped in a Good(PosFloat).
the specified Float value wrapped
in a Good(PosFloat), if it is positive, else a Bad(f(value)).
A predicate method that returns true if a given
Float value is positive.
A predicate method that returns true if a given
Float value is positive.
the Float to inspect, and if positive, return true.
true if the specified Float is positive, 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 positive Float, it will return a Pass.
Otherwise, the passed Float value is positive, 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 positive.
a Pass if the specified Float value is positive,
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 PosFloat, 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 PosFloat, 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 positive Int, it will return a PosFloat
representing that value, wrapped in a Right.
Otherwise, the passed Int value is not positive, 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 positive, return
wrapped in a Right(PosFloat).
the specified Int value wrapped
in a Right(PosFloat), if it is positive, else a Left(f(value)).
A factory/validation method that produces a PosFloat, 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 PosFloat, 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 positive Float, it will return a PosFloat
representing that value, wrapped in a Success.
Otherwise, the passed Float value is not positive, 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 positive, return
wrapped in a Success(PosFloat).
the specified Float value wrapped
in a Success(PosFloat), if it is positive, else a Failure(AssertionError).
Implicit widening conversion from PosFloat to
Double.
Implicit widening conversion from PosFloat to
Double.
the PosFloat to widen
the Float value underlying the
specified PosFloat, widened to
Double.
Implicit widening conversion from PosFloat to
Float.
Implicit widening conversion from PosFloat to
Float.
the PosFloat to widen
the Float value underlying the
specified PosFloat
Implicit widening conversion from PosFloat to NonZeroDouble.
Implicit widening conversion from PosFloat to NonZeroDouble.
the PosFloat to widen
the Float value underlying the specified PosFloat,
widened to Double and wrapped in a NonZeroDouble.
Implicit widening conversion from PosFloat to NonZeroFloat.
Implicit widening conversion from PosFloat to NonZeroFloat.
the PosFloat to widen
the Float value underlying the specified PosFloat,
widened to Float and wrapped in a NonZeroFloat.
Implicit widening conversion from PosFloat to PosDouble.
Implicit widening conversion from PosFloat to PosDouble.
the PosFloat to widen
the Float value underlying the specified PosFloat,
widened to Double and wrapped in a PosDouble.
Implicit widening conversion from PosFloat to PosZDouble.
Implicit widening conversion from PosFloat to PosZDouble.
the PosFloat to widen
the Float value underlying the specified PosFloat,
widened to Double and wrapped in a PosZDouble.
Implicit widening conversion from PosFloat to PosZFloat.
Implicit widening conversion from PosFloat to PosZFloat.
the PosFloat to widen
the Float value underlying the specified PosFloat,
widened to Float and wrapped in a PosZFloat.
The formerly implicit posFloatOrd field has been deprecated and will be removed in a future version of ScalaTest. Please use the ordering field instead.
The formerly implicit posFloatOrd field has been deprecated and will be removed in a future version of ScalaTest. Please use the ordering field instead.
The formerly implicit posFloatOrd field has been deprecated and will be removed in a future version of ScalaTest. Please use the ordering field instead.
The companion object for
PosFloatthat offers factory methods that producePosFloats, implicit widening conversions fromPosFloatto other numeric types, and maximum and minimum constant values forPosFloat.