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