The companion object for NegZFiniteFloat
that offers
factory methods that produce NegZFiniteFloat
s,
implicit widening conversions from NegZFiniteFloat
to
other numeric types, and maximum and minimum constant values
for NegZFiniteFloat
.
- Companion:
- class
- Source:
- NegZFiniteFloat.scala
Value members
Concrete methods
A factory/assertion method that produces a NegZFiniteFloat
given a
valid Float
value, or throws AssertionError
,
if given an invalid Float
value.
A factory/assertion method that produces a NegZFiniteFloat
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 non-positive Float
, it will return a NegZFiniteFloat
representing that value.
Otherwise, the passed Float
value is not finite non-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
Float
to inspect, and if finite non-positive, return wrapped in aNegZFiniteFloat
.
- Returns:
the specified
Float
value wrapped in aNegZFiniteFloat
, if it is finite non-positive, else throwsAssertionError
.- Throws:
- AssertionError
if the passed value is not finite non-positive
- Source:
- NegZFiniteFloat.scala
A factory method that produces an Option[NegZFiniteFloat]
given a
Float
value.
A factory method that produces an Option[NegZFiniteFloat]
given a
Float
value.
This method will inspect the passed Float
value and if
it is a finite non-positive Float
, it will return a NegZFiniteFloat
representing that value wrapped in a Some
. Otherwise, the passed Float
value is not finite non-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
Float
to inspect, and if finite non-positive, return wrapped in aSome[NegZFiniteFloat]
.
- Returns:
the specified
Float
value wrapped in aSome[NegZFiniteFloat]
, if it is finite non-positive, elseNone
.- Source:
- NegZFiniteFloat.scala
A factory method that produces a NegZFiniteFloat
given a
Float
value and a default NegZFiniteFloat
.
A factory method that produces a NegZFiniteFloat
given a
Float
value and a default NegZFiniteFloat
.
This method will inspect the passed Float
value and if
it is a finite non-positive Float
, it will return a NegZFiniteFloat
representing that value.
Otherwise, the passed Float
value is not finite non-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
NegZFiniteFloat
to return if the passedFloat
value is not finite non-positive.- value
the
Float
to inspect, and if finite non-positive, return.
- Returns:
the specified
Float
value wrapped in aNegZFiniteFloat
, if it is finite non-positive, else thedefault
NegZFiniteFloat
value.- Source:
- NegZFiniteFloat.scala
A factory/validation method that produces a NegZFiniteFloat
, 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 NegZFiniteFloat
, 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 non-positive Float
, it will return a NegZFiniteFloat
representing that value, wrapped in a Good
.
Otherwise, the passed Float
value is not finite non-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
Float
to inspect, and if finite non-positive, return wrapped in aGood(NegZFiniteFloat)
.
- Returns:
the specified
Float
value wrapped in aGood(NegZFiniteFloat)
, if it is finite non-positive, else aBad(f(value))
.- Source:
- NegZFiniteFloat.scala
A predicate method that returns true if a given
Float
value is finite non-positive.
A predicate method that returns true if a given
Float
value is finite non-positive.
- Value parameters:
- value
the
Float
to inspect, and if finite non-positive, return true.
- Returns:
true if the specified
Float
is finite non-positive, else false.- Source:
- NegZFiniteFloat.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 non-positive Float
, it will return a Pass
.
Otherwise, the passed Float
value is finite non-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
Float
to validate that it is finite non-positive.
- Returns:
a
Pass
if the specifiedFloat
value is finite non-positive, else aFail
containing an error value produced by passing the specifiedFloat
to the given functionf
.- Source:
- NegZFiniteFloat.scala
A factory/validation method that produces a NegZFiniteFloat
, 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 NegZFiniteFloat
, 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 non-positive Int
, it will return a NegZFiniteFloat
representing that value, wrapped in a Right
.
Otherwise, the passed Int
value is not finite non-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
Int
to inspect, and if finite non-positive, return wrapped in aRight(NegZFiniteFloat)
.
- Returns:
the specified
Int
value wrapped in aRight(NegZFiniteFloat)
, if it is finite non-positive, else aLeft(f(value))
.- Source:
- NegZFiniteFloat.scala
A factory/validation method that produces a NegZFiniteFloat
, 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 NegZFiniteFloat
, 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 non-positive Float
, it will return a NegZFiniteFloat
representing that value, wrapped in a Success
.
Otherwise, the passed Float
value is not finite non-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
Float
to inspect, and if finite non-positive, return wrapped in aSuccess(NegZFiniteFloat)
.
- Returns:
the specified
Float
value wrapped in aSuccess(NegZFiniteFloat)
, if it is finite non-positive, else aFailure(AssertionError)
.- Source:
- NegZFiniteFloat.scala
Concrete fields
The largest value representable as a finite non-positive Float
,
which is NegZFiniteFloat(0.0f)
.
The largest value representable as a finite non-positive Float
,
which is NegZFiniteFloat(0.0f)
.
- Source:
- NegZFiniteFloat.scala
The smallest value representable as a finite non-positive
Float
, which is NegZFiniteFloat(-3.4028235E38)
.
The smallest value representable as a finite non-positive
Float
, which is NegZFiniteFloat(-3.4028235E38)
.
- Source:
- NegZFiniteFloat.scala
Implicits
Implicits
A factory method, implemented via a macro, that produces a
NegZFiniteFloat
if passed a valid Float
literal, otherwise a compile time error.
A factory method, implemented via a macro, that produces a
NegZFiniteFloat
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 non-positive Float
literal,
it will return a NegZFiniteFloat
representing that value.
Otherwise, the passed Float
expression is either a literal
that is not finite non-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
Float
literal expression to inspect at compile time, and if finite non-positive, to return wrapped in aNegZFiniteFloat
at run time.
- Returns:
the specified, valid
Float
literal value wrapped in aNegZFiniteFloat
. (If the specified expression is not a validFloat
literal, the invocation of this method will not compile.)- Source:
- NegZFiniteFloat.scala
Implicit widening conversion from NegZFiniteFloat
to
Double
.
Implicit widening conversion from NegZFiniteFloat
to
Double
.
- Value parameters:
- pos
the
NegZFiniteFloat
to widen
- Returns:
the
Float
value underlying the specifiedNegZFiniteFloat
, widened toDouble
.- Source:
- NegZFiniteFloat.scala
Implicit widening conversion from NegZFiniteFloat
to FiniteDouble
.
Implicit widening conversion from NegZFiniteFloat
to FiniteDouble
.
- Value parameters:
- pos
the
NegZFiniteFloat
to widen
- Returns:
the
Float
value underlying the specifiedNegZFiniteFloat
, widened toDouble
and wrapped in aFiniteDouble
.- Source:
- NegZFiniteFloat.scala
Implicit widening conversion from NegZFiniteFloat
to
Float
.
Implicit widening conversion from NegZFiniteFloat
to
Float
.
- Value parameters:
- pos
the
NegZFiniteFloat
to widen
- Returns:
the
Float
value underlying the specifiedNegZFiniteFloat
- Source:
- NegZFiniteFloat.scala
Implicit widening conversion from NegZFiniteFloat
to NegZDouble
.
Implicit widening conversion from NegZFiniteFloat
to NegZDouble
.
- Value parameters:
- pos
the
NegZFiniteFloat
to widen
- Returns:
the
Float
value underlying the specifiedNegZFiniteFloat
, widened toDouble
and wrapped in aNegZDouble
.- Source:
- NegZFiniteFloat.scala
Implicit widening conversion from NegZFiniteFloat
to NegZFiniteDouble
.
Implicit widening conversion from NegZFiniteFloat
to NegZFiniteDouble
.
- Value parameters:
- pos
the
NegZFiniteFloat
to widen
- Returns:
the
Float
value underlying the specifiedNegZFiniteFloat
, widened toDouble
and wrapped in aNegZFiniteDouble
.- Source:
- NegZFiniteFloat.scala
Implicit widening conversion from NegZFiniteFloat
to NegZFloat
.
Implicit widening conversion from NegZFiniteFloat
to NegZFloat
.
- Value parameters:
- pos
the
NegZFiniteFloat
to widen
- Returns:
the
Float
value underlying the specifiedNegZFiniteFloat
, widened toFloat
and wrapped in aNegZFloat
.- Source:
- NegZFiniteFloat.scala