The companion object for NegFiniteFloat that offers
factory methods that produce NegFiniteFloats,
implicit widening conversions from NegFiniteFloat to
other numeric types, and maximum and minimum constant values
for NegFiniteFloat.
- Companion:
- class
- Source:
- NegFiniteFloat.scala
Value members
Concrete methods
A factory/assertion method that produces a NegFiniteFloat given a
valid Float value, or throws AssertionError,
if given an invalid Float value.
A factory/assertion method that produces a NegFiniteFloat 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 finite negative Float, it will return a NegFiniteFloat representing that value.
Otherwise, the passed Float value is not finite 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 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 finite negative, return wrapped in aNegFiniteFloat.
- Returns:
the specified
Floatvalue wrapped in aNegFiniteFloat, if it is finite negative, else throwsAssertionError.- Throws:
- AssertionError
if the passed value is not finite negative
- Source:
- NegFiniteFloat.scala
A factory method that produces an Option[NegFiniteFloat] given a
Float value.
A factory method that produces an Option[NegFiniteFloat] given a
Float value.
This method will inspect the passed Float value and if
it is a finite negative Float, it will return a NegFiniteFloat
representing that value wrapped in a Some. Otherwise, the passed Float
value is not finite 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 Float literals at
compile time, whereas from inspects
Float values at run time.
- Value parameters:
- value
the
Floatto inspect, and if finite negative, return wrapped in aSome[NegFiniteFloat].
- Returns:
the specified
Floatvalue wrapped in aSome[NegFiniteFloat], if it is finite negative, elseNone.- Source:
- NegFiniteFloat.scala
A factory method that produces a NegFiniteFloat given a
Float value and a default NegFiniteFloat.
A factory method that produces a NegFiniteFloat given a
Float value and a default NegFiniteFloat.
This method will inspect the passed Float value and if
it is a finite negative Float, it will return a NegFiniteFloat representing that value.
Otherwise, the passed Float value is not finite 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 Float literals at
compile time, whereas from inspects
Float values at run time.
- Value parameters:
- default
the
NegFiniteFloatto return if the passedFloatvalue is not finite negative.- value
the
Floatto inspect, and if finite negative, return.
- Returns:
the specified
Floatvalue wrapped in aNegFiniteFloat, if it is finite negative, else thedefaultNegFiniteFloatvalue.- Source:
- NegFiniteFloat.scala
A factory/validation method that produces a NegFiniteFloat, 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 NegFiniteFloat, 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 finite negative Float, it will return a NegFiniteFloat
representing that value, wrapped in a Good.
Otherwise, the passed Float value is not finite negative, 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 finite negative, return wrapped in aGood(NegFiniteFloat).
- Returns:
the specified
Floatvalue wrapped in aGood(NegFiniteFloat), if it is finite negative, else aBad(f(value)).- Source:
- NegFiniteFloat.scala
A predicate method that returns true if a given
Float value is finite negative.
A predicate method that returns true if a given
Float value is finite negative.
- Value parameters:
- value
the
Floatto inspect, and if finite negative, return true.
- Returns:
true if the specified
Floatis finite negative, else false.- Source:
- NegFiniteFloat.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 finite negative Float, it will return a Pass.
Otherwise, the passed Float value is finite negative, 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 finite negative.
- Returns:
a
Passif the specifiedFloatvalue is finite negative, else aFailcontaining an error value produced by passing the specifiedFloatto the given functionf.- Source:
- NegFiniteFloat.scala
A factory/validation method that produces a NegFiniteFloat, 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 NegFiniteFloat, 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 finite negative Int, it will return a NegFiniteFloat
representing that value, wrapped in a Right.
Otherwise, the passed Int value is not finite negative, 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 finite negative, return wrapped in aRight(NegFiniteFloat).
- Returns:
the specified
Intvalue wrapped in aRight(NegFiniteFloat), if it is finite negative, else aLeft(f(value)).- Source:
- NegFiniteFloat.scala
A factory/validation method that produces a NegFiniteFloat, 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 NegFiniteFloat, 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 finite negative Float, it will return a NegFiniteFloat
representing that value, wrapped in a Success.
Otherwise, the passed Float value is not finite 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.
- Value parameters:
- value
the
Floatto inspect, and if finite negative, return wrapped in aSuccess(NegFiniteFloat).
- Returns:
the specified
Floatvalue wrapped in aSuccess(NegFiniteFloat), if it is finite negative, else aFailure(AssertionError).- Source:
- NegFiniteFloat.scala
Concrete fields
The largest value representable as a finite negative Float,
which is NegFiniteFloat(-1.4E-45).
The largest value representable as a finite negative Float,
which is NegFiniteFloat(-1.4E-45).
- Source:
- NegFiniteFloat.scala
The smallest value representable as a finite negative
Float, which is NegFiniteFloat(-3.4028235E38).
The smallest value representable as a finite negative
Float, which is NegFiniteFloat(-3.4028235E38).
- Source:
- NegFiniteFloat.scala
Implicits
Implicits
A factory method, implemented via a macro, that produces a
NegFiniteFloat if passed a valid Float
literal, otherwise a compile time error.
A factory method, implemented via a macro, that produces a
NegFiniteFloat 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 finite negative Float literal,
it will return a NegFiniteFloat representing that value.
Otherwise, the passed Float expression is either a literal
that is not finite 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 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 finite negative, to return wrapped in aNegFiniteFloatat run time.
- Returns:
the specified, valid
Floatliteral value wrapped in aNegFiniteFloat. (If the specified expression is not a validFloatliteral, the invocation of this method will not compile.)- Source:
- NegFiniteFloat.scala
Implicit widening conversion from NegFiniteFloat to
Double.
Implicit widening conversion from NegFiniteFloat to
Double.
- Value parameters:
- pos
the
NegFiniteFloatto widen
- Returns:
the
Floatvalue underlying the specifiedNegFiniteFloat, widened toDouble.- Source:
- NegFiniteFloat.scala
Implicit widening conversion from NegFiniteFloat to FiniteDouble.
Implicit widening conversion from NegFiniteFloat to FiniteDouble.
- Value parameters:
- pos
the
NegFiniteFloatto widen
- Returns:
the
Floatvalue underlying the specifiedNegFiniteFloat, widened toDoubleand wrapped in aFiniteDouble.- Source:
- NegFiniteFloat.scala
Implicit widening conversion from NegFiniteFloat to FiniteFloat.
Implicit widening conversion from NegFiniteFloat to FiniteFloat.
- Value parameters:
- pos
the
NegFiniteFloatto widen
- Returns:
the
Floatvalue underlying the specifiedNegFiniteFloat, widened toFloatand wrapped in aFiniteFloat.- Source:
- NegFiniteFloat.scala
Implicit widening conversion from NegFiniteFloat to
Float.
Implicit widening conversion from NegFiniteFloat to
Float.
- Value parameters:
- pos
the
NegFiniteFloatto widen
- Returns:
the
Floatvalue underlying the specifiedNegFiniteFloat- Source:
- NegFiniteFloat.scala
Implicit widening conversion from NegFiniteFloat to NegDouble.
Implicit widening conversion from NegFiniteFloat to NegDouble.
- Value parameters:
- pos
the
NegFiniteFloatto widen
- Returns:
the
Floatvalue underlying the specifiedNegFiniteFloat, widened toDoubleand wrapped in aNegDouble.- Source:
- NegFiniteFloat.scala
Implicit widening conversion from NegFiniteFloat to NegFiniteDouble.
Implicit widening conversion from NegFiniteFloat to NegFiniteDouble.
- Value parameters:
- pos
the
NegFiniteFloatto widen
- Returns:
the
Floatvalue underlying the specifiedNegFiniteFloat, widened toDoubleand wrapped in aNegFiniteDouble.- Source:
- NegFiniteFloat.scala
Implicit widening conversion from NegFiniteFloat to NegFloat.
Implicit widening conversion from NegFiniteFloat to NegFloat.
- Value parameters:
- pos
the
NegFiniteFloatto widen
- Returns:
the
Floatvalue underlying the specifiedNegFiniteFloat, widened toFloatand wrapped in aNegFloat.- Source:
- NegFiniteFloat.scala
Implicit widening conversion from NegFiniteFloat to NegZDouble.
Implicit widening conversion from NegFiniteFloat to NegZDouble.
- Value parameters:
- pos
the
NegFiniteFloatto widen
- Returns:
the
Floatvalue underlying the specifiedNegFiniteFloat, widened toDoubleand wrapped in aNegZDouble.- Source:
- NegFiniteFloat.scala
Implicit widening conversion from NegFiniteFloat to NegZFiniteDouble.
Implicit widening conversion from NegFiniteFloat to NegZFiniteDouble.
- Value parameters:
- pos
the
NegFiniteFloatto widen
- Returns:
the
Floatvalue underlying the specifiedNegFiniteFloat, widened toDoubleand wrapped in aNegZFiniteDouble.- Source:
- NegFiniteFloat.scala
Implicit widening conversion from NegFiniteFloat to NegZFiniteFloat.
Implicit widening conversion from NegFiniteFloat to NegZFiniteFloat.
- Value parameters:
- pos
the
NegFiniteFloatto widen
- Returns:
the
Floatvalue underlying the specifiedNegFiniteFloat, widened toFloatand wrapped in aNegZFiniteFloat.- Source:
- NegFiniteFloat.scala
Implicit widening conversion from NegFiniteFloat to NegZFloat.
Implicit widening conversion from NegFiniteFloat to NegZFloat.
- Value parameters:
- pos
the
NegFiniteFloatto widen
- Returns:
the
Floatvalue underlying the specifiedNegFiniteFloat, widened toFloatand wrapped in aNegZFloat.- Source:
- NegFiniteFloat.scala
Implicit widening conversion from NegFiniteFloat to NonZeroDouble.
Implicit widening conversion from NegFiniteFloat to NonZeroDouble.
- Value parameters:
- pos
the
NegFiniteFloatto widen
- Returns:
the
Floatvalue underlying the specifiedNegFiniteFloat, widened toDoubleand wrapped in aNonZeroDouble.- Source:
- NegFiniteFloat.scala
Implicit widening conversion from NegFiniteFloat to NonZeroFloat.
Implicit widening conversion from NegFiniteFloat to NonZeroFloat.
- Value parameters:
- pos
the
NegFiniteFloatto widen
- Returns:
the
Floatvalue underlying the specifiedNegFiniteFloat, widened toFloatand wrapped in aNonZeroFloat.- Source:
- NegFiniteFloat.scala