The companion object for PosFloat that offers
factory methods that produce PosFloats,
implicit widening conversions from PosFloat to
other numeric types, and maximum and minimum constant values
for PosFloat.
- Companion:
- class
- Source:
- PosFloat.scala
Value members
Concrete methods
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.
- Value parameters:
- value
the
Floatto inspect, and if positive, return wrapped in aPosFloat.
- Returns:
the specified
Floatvalue wrapped in aPosFloat, if it is positive, else throwsAssertionError.- Throws:
- AssertionError
if the passed value is not positive
- Source:
- PosFloat.scala
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.
- Value parameters:
- value
the
Floatto inspect, and if positive, return wrapped in aSome[PosFloat].
- Returns:
the specified
Floatvalue wrapped in aSome[PosFloat], if it is positive, elseNone.- Source:
- PosFloat.scala
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.
- Value parameters:
- default
the
PosFloatto return if the passedFloatvalue is not positive.- value
the
Floatto inspect, and if positive, return.
- Returns:
the specified
Floatvalue wrapped in aPosFloat, if it is positive, else thedefaultPosFloatvalue.- Source:
- PosFloat.scala
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.
- Value parameters:
- value
the
Floatto inspect, and if positive, return wrapped in aGood(PosFloat).
- Returns:
the specified
Floatvalue wrapped in aGood(PosFloat), if it is positive, else aBad(f(value)).- Source:
- PosFloat.scala
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.
- Value parameters:
- value
the
Floatto inspect, and if positive, return true.
- Returns:
true if the specified
Floatis positive, else false.- Source:
- PosFloat.scala
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.
- Value parameters:
- value
the
Floatto validate that it is positive.
- Returns:
a
Passif the specifiedFloatvalue is positive, else aFailcontaining an error value produced by passing the specifiedFloatto the given functionf.- Source:
- PosFloat.scala
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.
- Value parameters:
- value
the
Intto inspect, and if positive, return wrapped in aRight(PosFloat).
- Returns:
the specified
Intvalue wrapped in aRight(PosFloat), if it is positive, else aLeft(f(value)).- Source:
- PosFloat.scala
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.
- Value parameters:
- value
the
Floatto inspect, and if positive, return wrapped in aSuccess(PosFloat).
- Returns:
the specified
Floatvalue wrapped in aSuccess(PosFloat), if it is positive, else aFailure(AssertionError).- Source:
- PosFloat.scala
Concrete fields
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).
- Source:
- PosFloat.scala
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).
- Source:
- PosFloat.scala
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).
- Source:
- PosFloat.scala
The positive infinity value, which is PosFloat.ensuringValid(Float.PositiveInfinity).
The positive infinity value, which is PosFloat.ensuringValid(Float.PositiveInfinity).
- Source:
- PosFloat.scala
Deprecated fields
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.
- Deprecated
- Source:
- PosFloat.scala
Implicits
Implicits
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.
- Value parameters:
- value
the
Floatliteral expression to inspect at compile time, and if positive, to return wrapped in aPosFloatat run time.
- Returns:
the specified, valid
Floatliteral value wrapped in aPosFloat. (If the specified expression is not a validFloatliteral, the invocation of this method will not compile.)- Source:
- PosFloat.scala
Implicit widening conversion from PosFloat to
Double.
Implicit widening conversion from PosFloat to
Double.
- Value parameters:
- pos
the
PosFloatto widen
- Returns:
the
Floatvalue underlying the specifiedPosFloat, widened toDouble.- Source:
- PosFloat.scala
Implicit widening conversion from PosFloat to
Float.
Implicit widening conversion from PosFloat to
Float.
- Value parameters:
- pos
the
PosFloatto widen
- Returns:
the
Floatvalue underlying the specifiedPosFloat- Source:
- PosFloat.scala
Implicit widening conversion from PosFloat to NonZeroDouble.
Implicit widening conversion from PosFloat to NonZeroDouble.
- Value parameters:
- pos
the
PosFloatto widen
- Returns:
the
Floatvalue underlying the specifiedPosFloat, widened toDoubleand wrapped in aNonZeroDouble.- Source:
- PosFloat.scala
Implicit widening conversion from PosFloat to NonZeroFloat.
Implicit widening conversion from PosFloat to NonZeroFloat.
- Value parameters:
- pos
the
PosFloatto widen
- Returns:
the
Floatvalue underlying the specifiedPosFloat, widened toFloatand wrapped in aNonZeroFloat.- Source:
- PosFloat.scala
Implicit widening conversion from PosFloat to PosDouble.
Implicit widening conversion from PosFloat to PosDouble.
- Value parameters:
- pos
the
PosFloatto widen
- Returns:
the
Floatvalue underlying the specifiedPosFloat, widened toDoubleand wrapped in aPosDouble.- Source:
- PosFloat.scala
Implicit widening conversion from PosFloat to PosZDouble.
Implicit widening conversion from PosFloat to PosZDouble.
- Value parameters:
- pos
the
PosFloatto widen
- Returns:
the
Floatvalue underlying the specifiedPosFloat, widened toDoubleand wrapped in aPosZDouble.- Source:
- PosFloat.scala
Implicit widening conversion from PosFloat to PosZFloat.
Implicit widening conversion from PosFloat to PosZFloat.
- Value parameters:
- pos
the
PosFloatto widen
- Returns:
the
Floatvalue underlying the specifiedPosFloat, widened toFloatand wrapped in aPosZFloat.- Source:
- PosFloat.scala