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