final class NegFiniteDouble extends AnyVal
An AnyVal
for finite negative Double
s.
Because NegFiniteDouble
is an AnyVal
it
will usually be as efficient as an Double
, being
boxed only when a Double
would have been boxed.
The NegFiniteDouble.apply
factory method is
implemented in terms of a macro that checks literals for
validity at compile time. Calling
NegFiniteDouble.apply
with a literal
Double
value will either produce a valid
NegFiniteDouble
instance at run time or an error at
compile time. Here's an example:
scala> import anyvals._ import anyvals._ scala> NegFiniteDouble(-1.1) res1: org.scalactic.anyvals.NegFiniteDouble = NegFiniteDouble(-1.1) scala> NegFiniteDouble(1.1) <console>:14: error: NegFiniteDouble.apply can only be invoked on a finite negative (i < 0.0 && i != Double.NegativeInfinity) floating point literal, like NegFiniteDouble(-1.1). NegFiniteDouble(1.1) ^
NegFiniteDouble.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 NegFiniteDouble.apply
, you'll get a
compiler error that suggests you use a different factor
method, NegFiniteDouble.from
, instead:
scala> val x = -1.1 x: Double = -1.1 scala> NegFiniteDouble(x) <console>:15: error: NegFiniteDouble.apply can only be invoked on a floating point literal, like NegFiniteDouble(-1.1). Please use NegFiniteDouble.from instead. NegFiniteDouble(x) ^
The NegFiniteDouble.from
factory method will inspect
the value at runtime and return an
Option[NegFiniteDouble]
. If the value is valid,
NegFiniteDouble.from
will return a
Some[NegFiniteDouble]
, else it will return a
None
. Here's an example:
scala> NegFiniteDouble.from(x) res4: Option[org.scalactic.anyvals.NegFiniteDouble] = Some(NegFiniteDouble(-1.1)) scala> val y = 1.1 y: Double = 1.1 scala> NegFiniteDouble.from(y) res5: Option[org.scalactic.anyvals.NegFiniteDouble] = None
The NegFiniteDouble.apply
factory method is marked
implicit, so that you can pass literal Double
s
into methods that require NegFiniteDouble
, and get the
same compile-time checking you get when calling
NegFiniteDouble.apply
explicitly. Here's an example:
scala> def invert(pos: NegFiniteDouble): Double = Double.MaxValue - pos invert: (pos: org.scalactic.anyvals.NegFiniteDouble)Double scala> invert(1.1) res6: Double = 1.7976931348623157E308 scala> invert(Double.MaxValue) res8: Double = 0.0 scala> invert(1.1) <console>:15: error: NegFiniteDouble.apply can only be invoked on a finite negative (i < 0.0 && i != Double.NegativeInfinity) floating point literal, like NegFiniteDouble(-1.1). invert(1.1) ^
This example also demonstrates that the
NegFiniteDouble
companion object also defines implicit
widening conversions when a similar conversion is provided in
Scala. This makes it convenient to use a
NegFiniteDouble
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
NegFiniteDouble
(the type of pos
), you
can still subtract pos
, because the
NegFiniteDouble
will be implicitly widened to
Double
.
- Source
- NegFiniteDouble.scala
- Alphabetic
- By Inheritance
- NegFiniteDouble
- 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
NegFiniteDouble
'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: NegZFiniteDouble
Returns the smallest (closest to 0)
NegZFiniteDouble
that is greater than or equal to thisNegZFiniteDouble
and represents a mathematical integer. - def ensuringValid(f: (Double) => Double): NegFiniteDouble
Applies the passed
Double => Double
function to the underlyingDouble
value, and if the result is positive, returns the result wrapped in aNegFiniteDouble
, else throwsAssertionError
.Applies the passed
Double => Double
function to the underlyingDouble
value, and if the result is positive, returns the result wrapped in aNegFiniteDouble
, else throwsAssertionError
.This method will inspect the result of applying the given function to this
NegFiniteDouble
's underlyingDouble
value and if the result is greater than0.0
, it will return aNegFiniteDouble
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 thisNegFiniteDouble
'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 thisNegFiniteDouble
's underlyingDouble
value.- returns
the result of applying this
NegFiniteDouble
's underlyingDouble
value to to the passed function, wrapped in aNegFiniteDouble
if it is positive (else throwsAssertionError
).
- Exceptions thrown
AssertionError
if the result of applying thisNegFiniteDouble
's underlyingDouble
value to to the passed function is not positive.
- def floor: NegFiniteDouble
Returns the greatest (closest to infinity)
NegFiniteDouble
that is less than or equal to thisNegFiniteDouble
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
NegFiniteDouble
has a value that is a whole number: it is finite and it has no fraction part. - def max(that: NegFiniteDouble): NegFiniteDouble
Returns
this
ifthis > that
orthat
otherwise. - def min(that: NegFiniteDouble): NegFiniteDouble
Returns
this
ifthis < that
orthat
otherwise. - def round: NegZLong
Rounds this
NegFiniteDouble
value to the nearest whole number value that can be expressed as anNegZLong
, returning the result as aNegZLong
. - def toByte: Byte
Converts this
NegFiniteDouble
to aByte
. - def toChar: Char
Converts this
NegFiniteDouble
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
NegFiniteDouble
to aDouble
. - def toFloat: Float
Converts this
NegFiniteDouble
to aFloat
. - def toInt: Int
Converts this
NegFiniteDouble
to anInt
. - def toLong: Long
Converts this
NegFiniteDouble
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
NegFiniteDouble
to aShort
. - def toString(): String
A string representation of this
NegFiniteDouble
.A string representation of this
NegFiniteDouble
.- Definition Classes
- NegFiniteDouble → Any
- def unary_+: NegFiniteDouble
Returns this value, unmodified.
- def unary_-: PosFiniteDouble
Returns the negation of this value.
- val value: Double