An AnyVal for non-positive Doubles.
Because NegZDouble is an AnyVal it
will usually be as efficient as an Double, being
boxed only when a Double would have been boxed.
The NegZDouble.apply factory method is
implemented in terms of a macro that checks literals for
validity at compile time. Calling
NegZDouble.apply with a literal
Double value will either produce a valid
NegZDouble instance at run time or an error at
compile time. Here's an example:
scala> import anyvals._
import anyvals._
scala> NegZDouble(-1.1)
res1: org.scalactic.anyvals.NegZDouble = NegZDouble(-1.1)
scala> NegZDouble(1.1)
<console>:14: error: NegZDouble.apply can only be invoked on a non-positive (i <= 0.0) floating point literal, like NegZDouble(-1.1).
NegZDouble(1.1)
^
NegZDouble.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 NegZDouble.apply, you'll get a
compiler error that suggests you use a different factor
method, NegZDouble.from, instead:
scala> val x = -1.1
x: Double = -1.1
scala> NegZDouble(x)
<console>:15: error: NegZDouble.apply can only be invoked on a floating point literal, like NegZDouble(-1.1). Please use NegZDouble.from instead.
NegZDouble(x)
^
The NegZDouble.from factory method will inspect
the value at runtime and return an
Option[NegZDouble]. If the value is valid,
NegZDouble.from will return a
Some[NegZDouble], else it will return a
None. Here's an example:
scala> NegZDouble.from(x) res4: Option[org.scalactic.anyvals.NegZDouble] = Some(NegZDouble(-1.1)) scala> val y = 1.1 y: Double = 1.1 scala> NegZDouble.from(y) res5: Option[org.scalactic.anyvals.NegZDouble] = None
The NegZDouble.apply factory method is marked
implicit, so that you can pass literal Doubles
into methods that require NegZDouble, and get the
same compile-time checking you get when calling
NegZDouble.apply explicitly. Here's an example:
scala> def invert(pos: NegZDouble): Double = Double.MaxValue - pos
invert: (pos: org.scalactic.anyvals.NegZDouble)Double
scala> invert(1.1)
res6: Double = 1.7976931348623157E308
scala> invert(Double.MaxValue)
res8: Double = 0.0
scala> invert(1.1)
<console>:15: error: NegZDouble.apply can only be invoked on a non-positive (i <= 0.0) floating point literal, like NegZDouble(-1.1).
invert(1.1)
^
This example also demonstrates that the
NegZDouble companion object also defines implicit
widening conversions when a similar conversion is provided in
Scala. This makes it convenient to use a
NegZDouble 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
NegZDouble (the type of pos), you
can still subtract pos, because the
NegZDouble will be implicitly widened to
Double.
- Value parameters:
- value
The
Doublevalue underlying thisNegZDouble.
- Companion:
- object
- Source:
- NegZDouble.scala
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.
- Source:
- NegZDouble.scala
Returns the remainder of the division of this value by x.
Returns the remainder of the division of this value by x.
- Source:
- NegZDouble.scala
Returns the remainder of the division of this value by x.
Returns the remainder of the division of this value by x.
- Source:
- NegZDouble.scala
Returns the remainder of the division of this value by x.
Returns the remainder of the division of this value by x.
- Source:
- NegZDouble.scala
Returns the remainder of the division of this value by x.
Returns the remainder of the division of this value by x.
- Source:
- NegZDouble.scala
Returns the remainder of the division of this value by x.
Returns the remainder of the division of this value by x.
- Source:
- NegZDouble.scala
Returns the remainder of the division of this value by x.
Returns the remainder of the division of this value by x.
- Source:
- NegZDouble.scala
Returns the product of this value and x.
Returns the product of this value and x.
- Source:
- NegZDouble.scala
Returns the product of this value and x.
Returns the product of this value and x.
- Source:
- NegZDouble.scala
Returns the product of this value and x.
Returns the product of this value and x.
- Source:
- NegZDouble.scala
Returns the product of this value and x.
Returns the product of this value and x.
- Source:
- NegZDouble.scala
Returns the product of this value and x.
Returns the product of this value and x.
- Source:
- NegZDouble.scala
Returns the product of this value and x.
Returns the product of this value and x.
- Source:
- NegZDouble.scala
Returns the product of this value and x.
Returns the product of this value and x.
- Source:
- NegZDouble.scala
Converts this NegZDouble's value to a string then concatenates the given string.
Converts this NegZDouble's value to a string then concatenates the given string.
- Source:
- NegZDouble.scala
Returns the difference of this value and x.
Returns the difference of this value and x.
- Source:
- NegZDouble.scala
Returns the difference of this value and x.
Returns the difference of this value and x.
- Source:
- NegZDouble.scala
Returns the difference of this value and x.
Returns the difference of this value and x.
- Source:
- NegZDouble.scala
Returns the difference of this value and x.
Returns the difference of this value and x.
- Source:
- NegZDouble.scala
Returns the difference of this value and x.
Returns the difference of this value and x.
- Source:
- NegZDouble.scala
Returns the difference of this value and x.
Returns the difference of this value and x.
- Source:
- NegZDouble.scala
Returns the difference of this value and x.
Returns the difference of this value and x.
- Source:
- NegZDouble.scala
Returns the quotient of this value and x.
Returns the quotient of this value and x.
- Source:
- NegZDouble.scala
Returns the quotient of this value and x.
Returns the quotient of this value and x.
- Source:
- NegZDouble.scala
Returns the quotient of this value and x.
Returns the quotient of this value and x.
- Source:
- NegZDouble.scala
Returns the quotient of this value and x.
Returns the quotient of this value and x.
- Source:
- NegZDouble.scala
Returns the quotient of this value and x.
Returns the quotient of this value and x.
- Source:
- NegZDouble.scala
Returns the quotient of this value and x.
Returns the quotient of this value and x.
- Source:
- NegZDouble.scala
Returns the quotient of this value and x.
Returns the quotient of this value and x.
- Source:
- NegZDouble.scala
Returns true if this value is less than x, false otherwise.
Returns true if this value is less than x, false otherwise.
- Source:
- NegZDouble.scala
Returns true if this value is less than x, false otherwise.
Returns true if this value is less than x, false otherwise.
- Source:
- NegZDouble.scala
Returns true if this value is less than x, false otherwise.
Returns true if this value is less than x, false otherwise.
- Source:
- NegZDouble.scala
Returns true if this value is less than x, false otherwise.
Returns true if this value is less than x, false otherwise.
- Source:
- NegZDouble.scala
Returns true if this value is less than x, false otherwise.
Returns true if this value is less than x, false otherwise.
- Source:
- NegZDouble.scala
Returns true if this value is less than x, false otherwise.
Returns true if this value is less than x, false otherwise.
- Source:
- NegZDouble.scala
Returns true if this value is less than x, false otherwise.
Returns true if this value is less than x, false otherwise.
- Source:
- NegZDouble.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.
- Source:
- NegZDouble.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.
- Source:
- NegZDouble.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.
- Source:
- NegZDouble.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.
- Source:
- NegZDouble.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.
- Source:
- NegZDouble.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.
- Source:
- NegZDouble.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.
- Source:
- NegZDouble.scala
Returns true if this value is greater than x, false otherwise.
Returns true if this value is greater than x, false otherwise.
- Source:
- NegZDouble.scala
Returns true if this value is greater than x, false otherwise.
Returns true if this value is greater than x, false otherwise.
- Source:
- NegZDouble.scala
Returns true if this value is greater than x, false otherwise.
Returns true if this value is greater than x, false otherwise.
- Source:
- NegZDouble.scala
Returns true if this value is greater than x, false otherwise.
Returns true if this value is greater than x, false otherwise.
- Source:
- NegZDouble.scala
Returns true if this value is greater than x, false otherwise.
Returns true if this value is greater than x, false otherwise.
- Source:
- NegZDouble.scala
Returns true if this value is greater than x, false otherwise.
Returns true if this value is greater than x, false otherwise.
- Source:
- NegZDouble.scala
Returns true if this value is greater than x, false otherwise.
Returns true if this value is greater than x, false otherwise.
- Source:
- NegZDouble.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.
- Source:
- NegZDouble.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.
- Source:
- NegZDouble.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.
- Source:
- NegZDouble.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.
- Source:
- NegZDouble.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.
- Source:
- NegZDouble.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.
- Source:
- NegZDouble.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.
- Source:
- NegZDouble.scala
Returns the smallest (closest to 0) NegZDouble that is greater than or equal to this NegZDouble
and represents a mathematical integer.
Returns the smallest (closest to 0) NegZDouble that is greater than or equal to this NegZDouble
and represents a mathematical integer.
- Source:
- NegZDouble.scala
Applies the passed Double => Double function to the underlying Double
value, and if the result is positive, returns the result wrapped in a NegZDouble,
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 NegZDouble,
else throws AssertionError.
This method will inspect the result of applying the given function to this
NegZDouble's underlying Double value and if the result
is greater than 0.0, it will return a NegZDouble 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 NegZDouble'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 => Doublefunction to apply to thisNegZDouble's underlyingDoublevalue.
- Returns:
the result of applying this
NegZDouble's underlyingDoublevalue to to the passed function, wrapped in aNegZDoubleif it is positive (else throwsAssertionError).- Throws:
- AssertionError
if the result of applying this
NegZDouble's underlyingDoublevalue to to the passed function is not positive.
- Source:
- NegZDouble.scala
Returns the greatest (closest to infinity) NegZDouble that is less than or equal to
this NegZDouble and represents a mathematical integer.
Returns the greatest (closest to infinity) NegZDouble that is less than or equal to
this NegZDouble and represents a mathematical integer.
- Source:
- NegZDouble.scala
True if this NegZDouble value is any finite value (i.e., it is neither positive nor negative infinity), else false.
True if this NegZDouble value is any finite value (i.e., it is neither positive nor negative infinity), else false.
- Source:
- NegZDouble.scala
True if this NegZDouble value represents negative infinity, else false.
True if this NegZDouble value represents negative infinity, else false.
- Source:
- NegZDouble.scala
Indicates whether this NegZDouble has a value that is a whole number: it is finite and it has no fraction part.
Indicates whether this NegZDouble has a value that is a whole number: it is finite and it has no fraction part.
- Source:
- NegZDouble.scala
Returns this if this > that or that otherwise.
Returns this if this > that or that otherwise.
- Source:
- NegZDouble.scala
Returns this if this < that or that otherwise.
Returns this if this < that or that otherwise.
- Source:
- NegZDouble.scala
Returns the NegZDouble sum of this value and x.
Returns the NegZDouble sum of this value and x.
This method will always succeed (not throw an exception) because adding a non-positive Double to another non-positive Double will always result in another non-positive Double value (though the result may be infinity).
- Source:
- NegZDouble.scala
Rounds this NegZDouble value to the nearest whole number value that can be expressed as an NegZLong, returning the result as a NegZLong.
Rounds this NegZDouble value to the nearest whole number value that can be expressed as an NegZLong, returning the result as a NegZLong.
- Source:
- NegZDouble.scala
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.
- Source:
- NegZDouble.scala
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.
- Source:
- NegZDouble.scala
A string representation of this NegZDouble.
A string representation of this NegZDouble.
- Definition Classes
- Any
- Source:
- NegZDouble.scala