The companion object for FiniteDouble
that offers
factory methods that produce FiniteDouble
s,
implicit widening conversions from FiniteDouble
to
other numeric types, and maximum and minimum constant values
for FiniteDouble
.
- Companion:
- class
- Source:
- FiniteDouble.scala
Value members
Concrete methods
A factory/assertion method that produces a FiniteDouble
given a
valid Double
value, or throws AssertionError
,
if given an invalid Double
value.
A factory/assertion method that produces a FiniteDouble
given a
valid Double
value, or throws AssertionError
,
if given an invalid Double
value.
This method will inspect the passed Double
value and if
it is a finite Double
, it will return a FiniteDouble
representing that value. Otherwise, the passed Double
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 Double
literals at
compile time, whereas from
inspects
Double
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 Double
is finite.
- Value parameters:
- value
the
Double
to inspect, and if finite, return wrapped in aFiniteDouble
.
- Returns:
the specified
Double
value wrapped in aFiniteDouble
, if it is finite, else throwsAssertionError
.- Throws:
- AssertionError
if the passed value is not finite
- Source:
- FiniteDouble.scala
A factory method that produces an Option[FiniteDouble]
given a
Double
value.
A factory method that produces an Option[FiniteDouble]
given a
Double
value.
This method will inspect the passed Double
value and if
it is a finite Double
, it will return a FiniteDouble
representing that value, wrapped in a Some
. Otherwise, the passed Double
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 Double
literals at
compile time, whereas from
inspects
Double
values at run time.
- Value parameters:
- value
the
Double
to inspect, and if finite, return wrapped in aSome[FiniteDouble]
.
- Returns:
the specified
Double
value wrapped in aSome[FiniteDouble]
, if it is FiniteDouble, elseNone
.- Source:
- FiniteDouble.scala
A factory method that produces a FiniteDouble
given a
Double
value and a default FiniteDouble
.
A factory method that produces a FiniteDouble
given a
Double
value and a default FiniteDouble
.
This method will inspect the passed Double
value and if
it is a finite Double
, it will return a FiniteDouble
representing that value. Otherwise, the passed Double
value is 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 Double
literals at
compile time, whereas from
inspects
Double
values at run time.
- Value parameters:
- default
the
FiniteDouble
to return if the passedDouble
value is not finite.- value
the
Double
to inspect, and if finite, return.
- Returns:
the specified
Double
value wrapped in aFiniteDouble
, if it is finite, else thedefault
FiniteDouble
value.- Source:
- FiniteDouble.scala
A factory/validation method that produces a FiniteDouble
, wrapped
in a Good
, given a valid Double
value, or if the
given Double
is invalid, an error value of type B
produced by passing the given invalid Double
value
to the given function f
, wrapped in a Bad
.
A factory/validation method that produces a FiniteDouble
, wrapped
in a Good
, given a valid Double
value, or if the
given Double
is invalid, an error value of type B
produced by passing the given invalid Double
value
to the given function f
, wrapped in a Bad
.
This method will inspect the passed Double
value and if
it is a finite Double
, it will return a FiniteDouble
representing that value, wrapped in a Good
.
Otherwise, the passed Double
value is not finite, so this
method will return a result of type B
obtained by passing
the invalid Double
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
Double
literals at compile time, whereas this method inspects
Double
values at run time.
- Value parameters:
- value
the
Double
to inspect, and if finite, return wrapped in aGood(FiniteDouble)
.
- Returns:
the specified
Double
value wrapped in aGood(FiniteDouble)
, if it is finite, else aBad(f(value))
.- Source:
- FiniteDouble.scala
A predicate method that returns true if a given
Double
value is finite.
A predicate method that returns true if a given
Double
value is finite.
- Value parameters:
- value
the
Double
to inspect, and if finite, return true.
- Returns:
true if the specified
Double
is positive, else false.- Source:
- FiniteDouble.scala
A validation method that produces a Pass
given a valid Double
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 Double
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 Double
value and if
it is a finite Double
, it will return a Pass
.
Otherwise, the passed Double
value is finite, so this
method will return a result of type E
obtained by passing
the invalid Double
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
Double
literals at compile time, whereas this method inspects
Double
values at run time.
- Value parameters:
- value
the
Int
to validate that it is finite.
- Returns:
a
Pass
if the specifiedInt
value is finite, else aFail
containing an error value produced by passing the specifiedDouble
to the given functionf
.- Source:
- FiniteDouble.scala
A factory/validation method that produces a FiniteDouble
, wrapped
in a Right
, given a valid Double
value, or if the
given Double
is invalid, an error value of type L
produced by passing the given invalid Double
value
to the given function f
, wrapped in a Left
.
A factory/validation method that produces a FiniteDouble
, wrapped
in a Right
, given a valid Double
value, or if the
given Double
is invalid, an error value of type L
produced by passing the given invalid Double
value
to the given function f
, wrapped in a Left
.
This method will inspect the passed Double
value and if
it is a finite Double
, it will return a FiniteDouble
representing that value, wrapped in a Right
.
Otherwise, the passed Double
value is not finite, so this
method will return a result of type L
obtained by passing
the invalid Double
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
Double
literals at compile time, whereas this method inspects
Double
values at run time.
- Value parameters:
- value
the
Double
to inspect, and if finite, return wrapped in aRight(FiniteDouble)
.
- Returns:
the specified
Double
value wrapped in aRight(FiniteDouble)
, if it is finite, else aLeft(f(value))
.- Source:
- FiniteDouble.scala
A factory/validation method that produces a FiniteDouble
, 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 FiniteDouble
, wrapped
in a Success
, given a valid Float
value, or if the
given Float
is invalid, an AssertionError
, wrapped
in a Failure
.
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 FiniteDouble
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(FiniteDouble)
.
- Returns:
the specified
Float
value wrapped in aSuccess(FiniteDouble)
, if it is finite, else aFailure(AssertionError)
.- Source:
- FiniteDouble.scala
Concrete fields
The largest value representable as a finite Double
,
which is FiniteDouble(1.7976931348623157E308)
.
The largest value representable as a finite Double
,
which is FiniteDouble(1.7976931348623157E308)
.
- Source:
- FiniteDouble.scala
The smallest positive value greater than 0.0d representable as a FiniteDouble
, which is FiniteDouble(4.9E-324).
The smallest positive value greater than 0.0d representable as a FiniteDouble
, which is FiniteDouble(4.9E-324).
- Source:
- FiniteDouble.scala
The smallest value representable as a finite
Double
, which is FiniteDouble(-1.7976931348623157E308)
.
The smallest value representable as a finite
Double
, which is FiniteDouble(-1.7976931348623157E308)
.
- Source:
- FiniteDouble.scala
Implicits
Implicits
A factory method, implemented via a macro, that produces a
FiniteDouble
if passed a valid Double
literal, otherwise a compile time error.
A factory method, implemented via a macro, that produces a
FiniteDouble
if passed a valid Double
literal, otherwise a compile time error.
The macro that implements this method will inspect the
specified Double
expression at compile time. If
the expression is a finite Double
literal,
it will return a FiniteDouble
representing that value.
Otherwise, the passed Double
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 Double
literals at compile
time, whereas from
inspects Double
values at run time.
- Value parameters:
- value
the
Double
literal expression to inspect at compile time, and if finite, to return wrapped in aFiniteDouble
at run time.
- Returns:
the specified, valid
Double
literal value wrapped in aFiniteDouble
. (If the specified expression is not a validDouble
literal, the invocation of this method will not compile.)- Source:
- FiniteDouble.scala
Implicit widening conversion from FiniteDouble
to
Double
.
Implicit widening conversion from FiniteDouble
to
Double
.
- Value parameters:
- pos
the
FiniteDouble
to widen
- Returns:
the
Double
value underlying the specifiedFiniteDouble
- Source:
- FiniteDouble.scala