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