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
.
Value parameters
- value
-
The
Double
value underlying thisNonZeroDouble
.
Attributes
- Companion
- object
- Source
- NonZeroDouble.scala
- Graph
-
- Supertypes
-
class AnyValtrait Matchableclass Any
Members list
Value members
Concrete methods
Returns the remainder of the division of this value by x
.
Returns the remainder of the division of this value by x
.
Returns the remainder of the division of this value by x
.
Returns the remainder of the division of this value by x
.
Returns the remainder of the division of this value by x
.
Returns the remainder of the division of this value by x
.
Returns the remainder of the division of this value by x
.
Returns the product of this value and x
.
Returns the product of this value and x
.
Returns the product of this value and x
.
Returns the product of this value and x
.
Returns the product of this value and x
.
Returns the product of this value and x
.
Returns the product of this value and x
.
Converts this NonZeroDouble
's value to a string then concatenates the given string.
Converts this NonZeroDouble
's value to a string then concatenates the given string.
Attributes
- Source
- NonZeroDouble.scala
Returns the sum of this value and x
.
Returns the sum of this value and x
.
Returns the sum of this value and x
.
Returns the sum of this value and x
.
Returns the sum of this value and x
.
Returns the sum of this value and x
.
Returns the sum of this value and x
.
Returns the difference of this value and x
.
Returns the difference of this value and x
.
Returns the difference of this value and x
.
Returns the difference of this value and x
.
Returns the difference of this value and x
.
Returns the difference of this value and x
.
Returns the difference of this value and x
.
Returns the quotient of this value and x
.
Returns the quotient of this value and x
.
Returns the quotient of this value and x
.
Returns the quotient of this value and x
.
Returns the quotient of this value and x
.
Returns the quotient of this value and x
.
Returns the quotient of this value and x
.
Returns true
if this value is less than x, false
otherwise.
Returns true
if this value is less than x, false
otherwise.
Returns true
if this value is less than x, false
otherwise.
Returns true
if this value is less than x, false
otherwise.
Returns true
if this value is less than x, false
otherwise.
Returns true
if this value is less than x, false
otherwise.
Returns true
if this value is less than x, false
otherwise.
Returns true
if this value is less than or equal to x, false
otherwise.
Returns true
if this value is less than or equal to x, false
otherwise.
Attributes
- Source
- NonZeroDouble.scala
Returns true
if this value is less than or equal to x, false
otherwise.
Returns true
if this value is less than or equal to x, false
otherwise.
Attributes
- Source
- NonZeroDouble.scala
Returns true
if this value is less than or equal to x, false
otherwise.
Returns true
if this value is less than or equal to x, false
otherwise.
Attributes
- Source
- NonZeroDouble.scala
Returns true
if this value is less than or equal to x, false
otherwise.
Returns true
if this value is less than or equal to x, false
otherwise.
Attributes
- Source
- NonZeroDouble.scala
Returns true
if this value is less than or equal to x, false
otherwise.
Returns true
if this value is less than or equal to x, false
otherwise.
Attributes
- Source
- NonZeroDouble.scala
Returns true
if this value is less than or equal to x, false
otherwise.
Returns true
if this value is less than or equal to x, false
otherwise.
Attributes
- Source
- NonZeroDouble.scala
Returns true
if this value is less than or equal to x, false
otherwise.
Returns true
if this value is less than or equal to x, false
otherwise.
Attributes
- Source
- NonZeroDouble.scala
Returns true
if this value is greater than x, false
otherwise.
Returns true
if this value is greater than x, false
otherwise.
Attributes
- Source
- NonZeroDouble.scala
Returns true
if this value is greater than x, false
otherwise.
Returns true
if this value is greater than x, false
otherwise.
Attributes
- Source
- NonZeroDouble.scala
Returns true
if this value is greater than x, false
otherwise.
Returns true
if this value is greater than x, false
otherwise.
Attributes
- Source
- NonZeroDouble.scala
Returns true
if this value is greater than x, false
otherwise.
Returns true
if this value is greater than x, false
otherwise.
Attributes
- Source
- NonZeroDouble.scala
Returns true
if this value is greater than x, false
otherwise.
Returns true
if this value is greater than x, false
otherwise.
Attributes
- Source
- NonZeroDouble.scala
Returns true
if this value is greater than x, false
otherwise.
Returns true
if this value is greater than x, false
otherwise.
Attributes
- Source
- NonZeroDouble.scala
Returns true
if this value is greater than x, false
otherwise.
Returns true
if this value is greater than x, false
otherwise.
Attributes
- Source
- NonZeroDouble.scala
Returns true
if this value is greater than or equal to x, false
otherwise.
Returns true
if this value is greater than or equal to x, false
otherwise.
Attributes
- Source
- NonZeroDouble.scala
Returns true
if this value is greater than or equal to x, false
otherwise.
Returns true
if this value is greater than or equal to x, false
otherwise.
Attributes
- Source
- NonZeroDouble.scala
Returns true
if this value is greater than or equal to x, false
otherwise.
Returns true
if this value is greater than or equal to x, false
otherwise.
Attributes
- Source
- NonZeroDouble.scala
Returns true
if this value is greater than or equal to x, false
otherwise.
Returns true
if this value is greater than or equal to x, false
otherwise.
Attributes
- Source
- NonZeroDouble.scala
Returns true
if this value is greater than or equal to x, false
otherwise.
Returns true
if this value is greater than or equal to x, false
otherwise.
Attributes
- Source
- NonZeroDouble.scala
Returns true
if this value is greater than or equal to x, false
otherwise.
Returns true
if this value is greater than or equal to x, false
otherwise.
Attributes
- Source
- NonZeroDouble.scala
Returns true
if this value is greater than or equal to x, false
otherwise.
Returns true
if this value is greater than or equal to x, false
otherwise.
Attributes
- Source
- NonZeroDouble.scala
Applies the passed Double => Double
function to the underlying Double
value, and if the result is positive, returns the result wrapped in a NonZeroDouble
, else throws AssertionError
.
Applies the passed Double => Double
function to the underlying Double
value, and if the result is positive, returns the result wrapped in a NonZeroDouble
, else throws AssertionError
.
This method will inspect the result of applying the given function to this NonZeroDouble
's underlying Double
value and if the result is greater than 0.0
, it will return a NonZeroDouble
representing that value. Otherwise, the Double
value returned by the given function is 0.0
or negative, so this method will throw AssertionError
.
This method 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 an Double
is positive. With this method, you are asserting that you are convinced the result of the computation represented by applying the given function to this NonZeroDouble
's value will not produce zero, a negative number, including Double.NegativeInfinity
, or Double.NaN
. Instead of producing such invalid values, this method will throw AssertionError
.
Value parameters
- f
-
the
Double => Double
function to apply to thisNonZeroDouble
's underlyingDouble
value.
Attributes
- Returns
-
the result of applying this
NonZeroDouble
's underlyingDouble
value to to the passed function, wrapped in aNonZeroDouble
if it is positive (else throwsAssertionError
). - Throws
-
AssertionError
if the result of applying this
NonZeroDouble
's underlyingDouble
value to to the passed function is not positive. - Source
- NonZeroDouble.scala
True if this NonZeroDouble
value is any finite value (i.e., it is neither positive nor negative infinity), else false.
True if this NonZeroDouble
value is any finite value (i.e., it is neither positive nor negative infinity), else false.
Attributes
- Source
- NonZeroDouble.scala
True if this NonZeroDouble
value represents positive or negative infinity, else false.
True if this NonZeroDouble
value represents positive or negative infinity, else false.
Attributes
- Source
- NonZeroDouble.scala
True if this NonZeroDouble
value represents negative infinity, else false.
True if this NonZeroDouble
value represents negative infinity, else false.
Attributes
- Source
- NonZeroDouble.scala
True if this NonZeroDouble
value represents positive infinity, else false.
True if this NonZeroDouble
value represents positive infinity, else false.
Attributes
- Source
- NonZeroDouble.scala
Indicates whether this NonZeroDouble
has a value that is a whole number: it is finite and it has no fraction part.
Indicates whether this NonZeroDouble
has a value that is a whole number: it is finite and it has no fraction part.
Attributes
- Source
- NonZeroDouble.scala
Returns this
if this > that
or that
otherwise.
Returns this
if this < that
or that
otherwise.
Converts this NonZeroDouble
to a Byte
.
Converts this NonZeroDouble
to a Char
.
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.
Attributes
- Returns
-
the measurement of the angle x in degrees.
- Source
- NonZeroDouble.scala
Converts this NonZeroDouble
to a Double
.
Converts this NonZeroDouble
to a Float
.
Converts this NonZeroDouble
to an Int
.
Converts this NonZeroDouble
to a Long
.
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.
Attributes
- Returns
-
the measurement of the angle x in radians.
- Source
- NonZeroDouble.scala
Converts this NonZeroDouble
to a Short
.
A string representation of this NonZeroDouble
.
A string representation of this NonZeroDouble
.
Attributes
- Definition Classes
-
Any
- Source
- NonZeroDouble.scala
Returns this value, unmodified.
Returns the negation of this value.
Concrete fields
Attributes
- Source
- NonZeroDouble.scala