object FiniteDouble
The companion object for FiniteDouble that offers
factory methods that produce FiniteDoubles,
implicit widening conversions from FiniteDouble to
other numeric types, and maximum and minimum constant values
for FiniteDouble.
- Source
- FiniteDouble.scala
- Alphabetic
- By Inheritance
- FiniteDouble
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
Value Members
-
final
def
!=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
##(): Int
- Definition Classes
- AnyRef → Any
-
final
def
==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
val
MaxValue: FiniteDouble
The largest value representable as a finite
Double, which isFiniteDouble(1.7976931348623157E308). -
final
val
MinPositiveValue: FiniteDouble
The smallest positive value greater than 0.0d representable as a
FiniteDouble, which is FiniteDouble(4.9E-324). -
final
val
MinValue: FiniteDouble
The smallest value representable as a finite
Double, which isFiniteDouble(-1.7976931348623157E308). -
implicit macro
def
apply(value: Double): FiniteDouble
A factory method, implemented via a macro, that produces a
FiniteDoubleif passed a validDoubleliteral, otherwise a compile time error.A factory method, implemented via a macro, that produces a
FiniteDoubleif passed a validDoubleliteral, otherwise a compile time error.The macro that implements this method will inspect the specified
Doubleexpression at compile time. If the expression is a finiteDoubleliteral, it will return aFiniteDoublerepresenting that value. Otherwise, the passedDoubleexpression 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
fromfactory method in that this method is implemented via a macro that inspectsDoubleliterals at compile time, whereasfrominspectsDoublevalues at run time.- value
the
Doubleliteral expression to inspect at compile time, and if finite, to return wrapped in aFiniteDoubleat run time.- returns
the specified, valid
Doubleliteral value wrapped in aFiniteDouble. (If the specified expression is not a validDoubleliteral, the invocation of this method will not compile.)
-
final
def
asInstanceOf[T0]: T0
- Definition Classes
- Any
-
def
clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( ... ) @native()
-
def
ensuringValid(value: Double): FiniteDouble
A factory/assertion method that produces a
FiniteDoublegiven a validDoublevalue, or throwsAssertionError, if given an invalidDoublevalue.A factory/assertion method that produces a
FiniteDoublegiven a validDoublevalue, or throwsAssertionError, if given an invalidDoublevalue.This method will inspect the passed
Doublevalue and if it is a finiteDouble, it will return aFiniteDoublerepresenting that value. Otherwise, the passedDoublevalue is not finite, so this method will throwAssertionError.This factory method differs from the
applyfactory method in thatapplyis implemented via a macro that inspectsDoubleliterals at compile time, whereasfrominspectsDoublevalues at run time. It differs from a vanillaassertorensuringcall in that you get something you didn't already have if the assertion succeeds: a type that promises aDoubleis finite.- value
the
Doubleto inspect, and if finite, return wrapped in aFiniteDouble.- returns
the specified
Doublevalue wrapped in aFiniteDouble, if it is finite, else throwsAssertionError.
- Exceptions thrown
AssertionErrorif the passed value is not finite
-
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
def
equals(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
def
finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( classOf[java.lang.Throwable] )
-
def
from(value: Double): Option[FiniteDouble]
A factory method that produces an
Option[FiniteDouble]given aDoublevalue.A factory method that produces an
Option[FiniteDouble]given aDoublevalue.This method will inspect the passed
Doublevalue and if it is a finiteDouble, it will return aFiniteDoublerepresenting that value, wrapped in aSome. Otherwise, the passedDoublevalue is not finite, so this method will returnNone.This factory method differs from the
applyfactory method in thatapplyis implemented via a macro that inspectsDoubleliterals at compile time, whereasfrominspectsDoublevalues at run time.- value
the
Doubleto inspect, and if finite, return wrapped in aSome[FiniteDouble].- returns
the specified
Doublevalue wrapped in aSome[FiniteDouble], if it is FiniteDouble, elseNone.
-
def
fromOrElse(value: Double, default: ⇒ FiniteDouble): FiniteDouble
A factory method that produces a
FiniteDoublegiven aDoublevalue and a defaultFiniteDouble.A factory method that produces a
FiniteDoublegiven aDoublevalue and a defaultFiniteDouble.This method will inspect the passed
Doublevalue and if it is a finiteDouble, it will return aFiniteDoublerepresenting that value. Otherwise, the passedDoublevalue is finite, so this method will return the passeddefaultvalue.This factory method differs from the
applyfactory method in thatapplyis implemented via a macro that inspectsDoubleliterals at compile time, whereasfrominspectsDoublevalues at run time.- value
the
Doubleto inspect, and if finite, return.- default
the
FiniteDoubleto return if the passedDoublevalue is not finite.- returns
the specified
Doublevalue wrapped in aFiniteDouble, if it is finite, else thedefaultFiniteDoublevalue.
-
final
def
getClass(): Class[_]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
-
def
goodOrElse[B](value: Double)(f: (Double) ⇒ B): Or[FiniteDouble, B]
A factory/validation method that produces a
FiniteDouble, wrapped in aGood, given a validDoublevalue, or if the givenDoubleis invalid, an error value of typeBproduced by passing the given invalidDoublevalue to the given functionf, wrapped in aBad.A factory/validation method that produces a
FiniteDouble, wrapped in aGood, given a validDoublevalue, or if the givenDoubleis invalid, an error value of typeBproduced by passing the given invalidDoublevalue to the given functionf, wrapped in aBad.This method will inspect the passed
Doublevalue and if it is a finiteDouble, it will return aFiniteDoublerepresenting that value, wrapped in aGood. Otherwise, the passedDoublevalue is not finite, so this method will return a result of typeBobtained by passing the invalidDoublevalue to the given functionf, wrapped in aBad.This factory method differs from the
applyfactory method in thatapplyis implemented via a macro that inspectsDoubleliterals at compile time, whereas this method inspectsDoublevalues at run time.- value
the
Doubleto inspect, and if finite, return wrapped in aGood(FiniteDouble).- returns
the specified
Doublevalue wrapped in aGood(FiniteDouble), if it is finite, else aBad(f(value)).
-
def
hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
-
final
def
isInstanceOf[T0]: Boolean
- Definition Classes
- Any
-
def
isValid(value: Double): Boolean
A predicate method that returns true if a given
Doublevalue is finite.A predicate method that returns true if a given
Doublevalue is finite.- value
the
Doubleto inspect, and if finite, return true.- returns
true if the specified
Doubleis positive, else false.
-
final
def
ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
final
def
notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
-
final
def
notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
-
implicit
val
ordering: Ordering[FiniteDouble]
Implicit Ordering instance.
-
def
passOrElse[E](value: Double)(f: (Double) ⇒ E): Validation[E]
A validation method that produces a
Passgiven a validDoublevalue, or an error value of typeEproduced by passing the given invalidIntvalue to the given functionf, wrapped in aFail.A validation method that produces a
Passgiven a validDoublevalue, or an error value of typeEproduced by passing the given invalidIntvalue to the given functionf, wrapped in aFail.This method will inspect the passed
Doublevalue and if it is a finiteDouble, it will return aPass. Otherwise, the passedDoublevalue is finite, so this method will return a result of typeEobtained by passing the invalidDoublevalue to the given functionf, wrapped in aFail.This factory method differs from the
applyfactory method in thatapplyis implemented via a macro that inspectsDoubleliterals at compile time, whereas this method inspectsDoublevalues at run time.- value
the
Intto validate that it is finite.- returns
a
Passif the specifiedIntvalue is finite, else aFailcontaining an error value produced by passing the specifiedDoubleto the given functionf.
-
def
rightOrElse[L](value: Double)(f: (Double) ⇒ L): Either[L, FiniteDouble]
A factory/validation method that produces a
FiniteDouble, wrapped in aRight, given a validDoublevalue, or if the givenDoubleis invalid, an error value of typeLproduced by passing the given invalidDoublevalue to the given functionf, wrapped in aLeft.A factory/validation method that produces a
FiniteDouble, wrapped in aRight, given a validDoublevalue, or if the givenDoubleis invalid, an error value of typeLproduced by passing the given invalidDoublevalue to the given functionf, wrapped in aLeft.This method will inspect the passed
Doublevalue and if it is a finiteDouble, it will return aFiniteDoublerepresenting that value, wrapped in aRight. Otherwise, the passedDoublevalue is not finite, so this method will return a result of typeLobtained by passing the invalidDoublevalue to the given functionf, wrapped in aLeft.This factory method differs from the
applyfactory method in thatapplyis implemented via a macro that inspectsDoubleliterals at compile time, whereas this method inspectsDoublevalues at run time.- value
the
Doubleto inspect, and if finite, return wrapped in aRight(FiniteDouble).- returns
the specified
Doublevalue wrapped in aRight(FiniteDouble), if it is finite, else aLeft(f(value)).
-
final
def
synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
-
def
toString(): String
- Definition Classes
- AnyRef → Any
-
def
tryingValid(value: Double): Try[FiniteDouble]
A factory/validation method that produces a
FiniteDouble, wrapped in aSuccess, given a validFloatvalue, or if the givenFloatis invalid, anAssertionError, wrapped in aFailure.A factory/validation method that produces a
FiniteDouble, wrapped in aSuccess, given a validFloatvalue, or if the givenFloatis invalid, anAssertionError, wrapped in aFailure.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
ensuringValidcall will always succeed, you should use one of the other factory or validation methods provided on this object instead:isValid,tryingValid,passOrElse,goodOrElse, orrightOrElse.This method will inspect the passed
Floatvalue and if it is a finiteFloat, it will return aFiniteDoublerepresenting that value, wrapped in aSuccess. Otherwise, the passedFloatvalue is not finite, so this method will return anAssertionError, wrapped in aFailure.This factory method differs from the
applyfactory method in thatapplyis implemented via a macro that inspectsFloatliterals at compile time, whereas this method inspectsFloatvalues at run time.- value
the
Floatto inspect, and if finite, return wrapped in aSuccess(FiniteDouble).- returns
the specified
Floatvalue wrapped in aSuccess(FiniteDouble), if it is finite, else aFailure(AssertionError).
-
final
def
wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... ) @native()
-
implicit
def
widenToDouble(pos: FiniteDouble): Double
Implicit widening conversion from
FiniteDoubletoDouble.Implicit widening conversion from
FiniteDoubletoDouble.- pos
the
FiniteDoubleto widen- returns
the
Doublevalue underlying the specifiedFiniteDouble