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