final class FiniteDouble extends AnyVal
An AnyVal
for finite Double
s.
Because FiniteDouble
is an AnyVal
it
will usually be as efficient as an Double
, being
boxed only when a Double
would have been boxed.
The FiniteDouble.apply
factory method is
implemented in terms of a macro that checks literals for
validity at compile time. Calling
FiniteDouble.apply
with a literal
Double
value will either produce a valid
FiniteDouble
instance at run time or an error at
compile time. Here's an example:
scala> import anyvals._ import anyvals._ scala> FiniteDouble(1.1) res1: org.scalactic.anyvals.FiniteDouble = FiniteDouble(1.1) scala> FiniteDouble(Finite.PositiveInfinity) <console>:14: error: FiniteDouble.apply can only be invoked on a finite (i != Double.NegativeInfinity && i != Double.PositiveInfinity && !i.isNaN) floating point literal, like FiniteDouble(1.1). FiniteDouble(Finite.PositiveInfinity) ^
FiniteDouble.apply
cannot be used if the value
being passed is a variable (i.e., not a literal),
because the macro cannot determine the validity of variables
at compile time (just literals). If you try to pass a
variable to FiniteDouble.apply
, you'll get a
compiler error that suggests you use a different factor
method, FiniteDouble.from
, instead:
scala> val x = 1.1 x: Double = 1.1 scala> FiniteDouble(x) <console>:15: error: FiniteDouble.apply can only be invoked on a floating point literal, like FiniteDouble(1.1). Please use FiniteDouble.from instead. FiniteDouble(x) ^
The FiniteDouble.from
factory method will inspect
the value at runtime and return an
Option[FiniteDouble]
. If the value is valid,
FiniteDouble.from
will return a
Some[FiniteDouble]
, else it will return a
None
. Here's an example:
scala> FiniteDouble.from(x) res4: Option[org.scalactic.anyvals.FiniteDouble] = Some(FiniteDouble(1.1)) scala> val y = Finite.PositiveInfinity y: Double = Finite.PositiveInfinity scala> FiniteDouble.from(y) res5: Option[org.scalactic.anyvals.FiniteDouble] = None
The FiniteDouble.apply
factory method is marked
implicit, so that you can pass literal Double
s
into methods that require FiniteDouble
, and get the
same compile-time checking you get when calling
FiniteDouble.apply
explicitly. Here's an example:
scala> def invert(pos: FiniteDouble): Double = Double.MaxValue - pos invert: (pos: org.scalactic.anyvals.FiniteDouble)Double scala> invert(1.1) res6: Double = 1.7976931348623157E308 scala> invert(Double.MaxValue) res8: Double = 0.0 scala> invert(Finite.PositiveInfinity) <console>:15: error: FiniteDouble.apply can only be invoked on a finite (i != Double.NegativeInfinity && i != Double.PositiveInfinity && !i.isNaN) floating point literal, like FiniteDouble(1.1). invert(Finite.PositiveInfinity) ^
This example also demonstrates that the
FiniteDouble
companion object also defines implicit
widening conversions when a similar conversion is provided in
Scala. This makes it convenient to use a
FiniteDouble
where a Double
is
needed. An example is the subtraction in the body of the
invert
method defined above,
Double.MaxValue - pos
. Although
Double.MaxValue
is a Double
, which
has no -
method that takes a
FiniteDouble
(the type of pos
), you
can still subtract pos
, because the
FiniteDouble
will be implicitly widened to
Double
.
- Source
- FiniteDouble.scala
- Alphabetic
- By Inheritance
- FiniteDouble
- AnyVal
- Any
- Hide All
- Show All
- Public
- Protected
Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- Any
- final def ##: Int
- Definition Classes
- Any
- def %(x: Double): Double
Returns the remainder of the division of this value by
x
. - def %(x: Float): Double
Returns the remainder of the division of this value by
x
. - def %(x: Long): Double
Returns the remainder of the division of this value by
x
. - def %(x: Int): Double
Returns the remainder of the division of this value by
x
. - def %(x: Char): Double
Returns the remainder of the division of this value by
x
. - def %(x: Short): Double
Returns the remainder of the division of this value by
x
. - def %(x: Byte): Double
Returns the remainder of the division of this value by
x
. - def *(x: Double): Double
Returns the product of this value and
x
. - def *(x: Float): Double
Returns the product of this value and
x
. - def *(x: Long): Double
Returns the product of this value and
x
. - def *(x: Int): Double
Returns the product of this value and
x
. - def *(x: Char): Double
Returns the product of this value and
x
. - def *(x: Short): Double
Returns the product of this value and
x
. - def *(x: Byte): Double
Returns the product of this value and
x
. - def +(x: Double): Double
Returns the sum of this value and
x
. - def +(x: Float): Double
Returns the sum of this value and
x
. - def +(x: Long): Double
Returns the sum of this value and
x
. - def +(x: Int): Double
Returns the sum of this value and
x
. - def +(x: Char): Double
Returns the sum of this value and
x
. - def +(x: Short): Double
Returns the sum of this value and
x
. - def +(x: Byte): Double
Returns the sum of this value and
x
. - def +(x: String): String
Converts this
FiniteDouble
's value to a string then concatenates the given string. - def -(x: Double): Double
Returns the difference of this value and
x
. - def -(x: Float): Double
Returns the difference of this value and
x
. - def -(x: Long): Double
Returns the difference of this value and
x
. - def -(x: Int): Double
Returns the difference of this value and
x
. - def -(x: Char): Double
Returns the difference of this value and
x
. - def -(x: Short): Double
Returns the difference of this value and
x
. - def -(x: Byte): Double
Returns the difference of this value and
x
. - def /(x: Double): Double
Returns the quotient of this value and
x
. - def /(x: Float): Double
Returns the quotient of this value and
x
. - def /(x: Long): Double
Returns the quotient of this value and
x
. - def /(x: Int): Double
Returns the quotient of this value and
x
. - def /(x: Char): Double
Returns the quotient of this value and
x
. - def /(x: Short): Double
Returns the quotient of this value and
x
. - def /(x: Byte): Double
Returns the quotient of this value and
x
. - def <(x: Double): Boolean
Returns
true
if this value is less than x,false
otherwise. - def <(x: Float): Boolean
Returns
true
if this value is less than x,false
otherwise. - def <(x: Long): Boolean
Returns
true
if this value is less than x,false
otherwise. - def <(x: Int): Boolean
Returns
true
if this value is less than x,false
otherwise. - def <(x: Char): Boolean
Returns
true
if this value is less than x,false
otherwise. - def <(x: Short): Boolean
Returns
true
if this value is less than x,false
otherwise. - def <(x: Byte): Boolean
Returns
true
if this value is less than x,false
otherwise. - def <=(x: Double): Boolean
Returns
true
if this value is less than or equal to x,false
otherwise. - def <=(x: Float): Boolean
Returns
true
if this value is less than or equal to x,false
otherwise. - def <=(x: Long): Boolean
Returns
true
if this value is less than or equal to x,false
otherwise. - def <=(x: Int): Boolean
Returns
true
if this value is less than or equal to x,false
otherwise. - def <=(x: Char): Boolean
Returns
true
if this value is less than or equal to x,false
otherwise. - def <=(x: Short): Boolean
Returns
true
if this value is less than or equal to x,false
otherwise. - def <=(x: Byte): Boolean
Returns
true
if this value is less than or equal to x,false
otherwise. - final def ==(arg0: Any): Boolean
- Definition Classes
- Any
- def >(x: Double): Boolean
Returns
true
if this value is greater than x,false
otherwise. - def >(x: Float): Boolean
Returns
true
if this value is greater than x,false
otherwise. - def >(x: Long): Boolean
Returns
true
if this value is greater than x,false
otherwise. - def >(x: Int): Boolean
Returns
true
if this value is greater than x,false
otherwise. - def >(x: Char): Boolean
Returns
true
if this value is greater than x,false
otherwise. - def >(x: Short): Boolean
Returns
true
if this value is greater than x,false
otherwise. - def >(x: Byte): Boolean
Returns
true
if this value is greater than x,false
otherwise. - def >=(x: Double): Boolean
Returns
true
if this value is greater than or equal to x,false
otherwise. - def >=(x: Float): Boolean
Returns
true
if this value is greater than or equal to x,false
otherwise. - def >=(x: Long): Boolean
Returns
true
if this value is greater than or equal to x,false
otherwise. - def >=(x: Int): Boolean
Returns
true
if this value is greater than or equal to x,false
otherwise. - def >=(x: Char): Boolean
Returns
true
if this value is greater than or equal to x,false
otherwise. - def >=(x: Short): Boolean
Returns
true
if this value is greater than or equal to x,false
otherwise. - def >=(x: Byte): Boolean
Returns
true
if this value is greater than or equal to x,false
otherwise. - final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def ceil: FiniteDouble
Returns the smallest (closest to 0)
FiniteDouble
that is greater than or equal to thisFiniteDouble
and represents a mathematical integer. - def ensuringValid(f: (Double) => Double): FiniteDouble
Applies the passed
Double => Double
function to the underlyingDouble
value, and if the result is positive, returns the result wrapped in aFiniteDouble
, else throwsAssertionError
.Applies the passed
Double => Double
function to the underlyingDouble
value, and if the result is positive, returns the result wrapped in aFiniteDouble
, else throwsAssertionError
.This method will inspect the result of applying the given function to this
FiniteDouble
's underlyingDouble
value and if the result is greater than0.0
, it will return aFiniteDouble
representing that value. Otherwise, theDouble
value returned by the given function is0.0
or negative, so this method will throwAssertionError
.This method differs from a vanilla
assert
orensuring
call in that you get something you didn't already have if the assertion succeeds: a type that promises anDouble
is positive. With this method, you are asserting that you are convinced the result of the computation represented by applying the given function to thisFiniteDouble
's value will not produce zero, a negative number, includingDouble.NegativeInfinity
, orDouble.NaN
. Instead of producing such invalid values, this method will throwAssertionError
.- f
the
Double => Double
function to apply to thisFiniteDouble
's underlyingDouble
value.- returns
the result of applying this
FiniteDouble
's underlyingDouble
value to to the passed function, wrapped in aFiniteDouble
if it is positive (else throwsAssertionError
).
- Exceptions thrown
AssertionError
if the result of applying thisFiniteDouble
's underlyingDouble
value to to the passed function is not positive.
- def floor: FiniteDouble
Returns the greatest (closest to infinity)
FiniteDouble
that is less than or equal to thisFiniteDouble
and represents a mathematical integer. - def getClass(): Class[_ <: AnyVal]
- Definition Classes
- AnyVal → Any
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- def isWhole: Boolean
Indicates whether this
FiniteDouble
has a value that is a whole number: it is finite and it has no fraction part. - def max(that: FiniteDouble): FiniteDouble
Returns
this
ifthis > that
orthat
otherwise. - def min(that: FiniteDouble): FiniteDouble
Returns
this
ifthis < that
orthat
otherwise. - def round: Long
Rounds this
FiniteDouble
value to the nearest whole number value that can be expressed as anLong
, returning the result as aLong
. - def toByte: Byte
Converts this
FiniteDouble
to aByte
. - def toChar: Char
Converts this
FiniteDouble
to aChar
. - def toDegrees: Double
Converts an angle measured in radians to an approximately equivalent angle measured in degrees.
Converts an angle measured in radians to an approximately equivalent angle measured in degrees.
- returns
the measurement of the angle x in degrees.
- def toDouble: Double
Converts this
FiniteDouble
to aDouble
. - def toFloat: Float
Converts this
FiniteDouble
to aFloat
. - def toInt: Int
Converts this
FiniteDouble
to anInt
. - def toLong: Long
Converts this
FiniteDouble
to aLong
. - def toRadians: Double
Converts an angle measured in degrees to an approximately equivalent angle measured in radians.
Converts an angle measured in degrees to an approximately equivalent angle measured in radians.
- returns
the measurement of the angle x in radians.
- def toShort: Short
Converts this
FiniteDouble
to aShort
. - def toString(): String
A string representation of this
FiniteDouble
.A string representation of this
FiniteDouble
.- Definition Classes
- FiniteDouble → Any
- def unary_+: FiniteDouble
Returns this value, unmodified.
- def unary_-: FiniteDouble
Returns the negation of this value.
- val value: Double