final class PosZDouble extends AnyVal

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)
res0: org.scalactic.anyvals.PosZDouble = PosZDouble(1.1)
scala> PosZDouble(0.0)
res1: org.scalactic.anyvals.PosZDouble = PosZDouble(0.0)
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(42.0).
 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(42.0). 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(0.0)
res6: Double = 1.7976931348623157E308
scala> invert(Double.MaxValue)
res7: 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(42.0).
 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 or wider type 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.

Source: PosZDouble.scala

Linear Supertypes

AnyVal, Any

Ordering

Alphabetic
By Inheritance

Inherited

PosZDouble
AnyVal
Any

Hide All
Show All

Visibility

Public
All

Value Members

final def !=(arg0: Any): Boolean
Permalink

Definition Classes
Any
final def ##(): Int
Permalink

Definition Classes
Any
def %(x: Double): Double
Permalink
Returns the remainder of the division of this value by x.
def %(x: Float): Double
Permalink
Returns the remainder of the division of this value by x.
def %(x: Long): Double
Permalink
Returns the remainder of the division of this value by x.
def %(x: Int): Double
Permalink
Returns the remainder of the division of this value by x.
def %(x: Char): Double
Permalink
Returns the remainder of the division of this value by x.
def %(x: Short): Double
Permalink
Returns the remainder of the division of this value by x.
def %(x: Byte): Double
Permalink
Returns the remainder of the division of this value by x.
def *(x: Double): Double
Permalink
Returns the product of this value and x.
def *(x: Float): Double
Permalink
Returns the product of this value and x.
def *(x: Long): Double
Permalink
Returns the product of this value and x.
def *(x: Int): Double
Permalink
Returns the product of this value and x.
def *(x: Char): Double
Permalink
Returns the product of this value and x.
def *(x: Short): Double
Permalink
Returns the product of this value and x.
def *(x: Byte): Double
Permalink
Returns the product of this value and x.
def +(x: Double): Double
Permalink
Returns the sum of this value and x.
def +(x: Float): Double
Permalink
Returns the sum of this value and x.
def +(x: Long): Double
Permalink
Returns the sum of this value and x.
def +(x: Int): Double
Permalink
Returns the sum of this value and x.
def +(x: Char): Double
Permalink
Returns the sum of this value and x.
def +(x: Short): Double
Permalink
Returns the sum of this value and x.
def +(x: Byte): Double
Permalink
Returns the sum of this value and x.
def +(x: String): String
Permalink
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.
def -(x: Double): Double
Permalink
Returns the difference of this value and x.
def -(x: Float): Double
Permalink
Returns the difference of this value and x.
def -(x: Long): Double
Permalink
Returns the difference of this value and x.
def -(x: Int): Double
Permalink
Returns the difference of this value and x.
def -(x: Char): Double
Permalink
Returns the difference of this value and x.
def -(x: Short): Double
Permalink
Returns the difference of this value and x.
def -(x: Byte): Double
Permalink
Returns the difference of this value and x.
def /(x: Double): Double
Permalink
Returns the quotient of this value and x.
def /(x: Float): Double
Permalink
Returns the quotient of this value and x.
def /(x: Long): Double
Permalink
Returns the quotient of this value and x.
def /(x: Int): Double
Permalink
Returns the quotient of this value and x.
def /(x: Char): Double
Permalink
Returns the quotient of this value and x.
def /(x: Short): Double
Permalink
Returns the quotient of this value and x.
def /(x: Byte): Double
Permalink
Returns the quotient of this value and x.
def <(x: Double): Boolean
Permalink
Returns true if this value is less than x, false otherwise.
def <(x: Float): Boolean
Permalink
Returns true if this value is less than x, false otherwise.
def <(x: Long): Boolean
Permalink
Returns true if this value is less than x, false otherwise.
def <(x: Int): Boolean
Permalink
Returns true if this value is less than x, false otherwise.
def <(x: Char): Boolean
Permalink
Returns true if this value is less than x, false otherwise.
def <(x: Short): Boolean
Permalink
Returns true if this value is less than x, false otherwise.
def <(x: Byte): Boolean
Permalink
Returns true if this value is less than x, false otherwise.
def <=(x: Double): Boolean
Permalink
Returns true if this value is less than or equal to x, false otherwise.
def <=(x: Float): Boolean
Permalink
Returns true if this value is less than or equal to x, false otherwise.
def <=(x: Long): Boolean
Permalink
Returns true if this value is less than or equal to x, false otherwise.
def <=(x: Int): Boolean
Permalink
Returns true if this value is less than or equal to x, false otherwise.
def <=(x: Char): Boolean
Permalink
Returns true if this value is less than or equal to x, false otherwise.
def <=(x: Short): Boolean
Permalink
Returns true if this value is less than or equal to x, false otherwise.
def <=(x: Byte): Boolean
Permalink
Returns true if this value is less than or equal to x, false otherwise.
final def ==(arg0: Any): Boolean
Permalink

Definition Classes
Any
def >(x: Double): Boolean
Permalink
Returns true if this value is greater than x, false otherwise.
def >(x: Float): Boolean
Permalink
Returns true if this value is greater than x, false otherwise.
def >(x: Long): Boolean
Permalink
Returns true if this value is greater than x, false otherwise.
def >(x: Int): Boolean
Permalink
Returns true if this value is greater than x, false otherwise.
def >(x: Char): Boolean
Permalink
Returns true if this value is greater than x, false otherwise.
def >(x: Short): Boolean
Permalink
Returns true if this value is greater than x, false otherwise.
def >(x: Byte): Boolean
Permalink
Returns true if this value is greater than x, false otherwise.
def >=(x: Double): Boolean
Permalink
Returns true if this value is greater than or equal to x, false otherwise.
def >=(x: Float): Boolean
Permalink
Returns true if this value is greater than or equal to x, false otherwise.
def >=(x: Long): Boolean
Permalink
Returns true if this value is greater than or equal to x, false otherwise.
def >=(x: Int): Boolean
Permalink
Returns true if this value is greater than or equal to x, false otherwise.
def >=(x: Char): Boolean
Permalink
Returns true if this value is greater than or equal to x, false otherwise.
def >=(x: Short): Boolean
Permalink
Returns true if this value is greater than or equal to x, false otherwise.
def >=(x: Byte): Boolean
Permalink
Returns true if this value is greater than or equal to x, false otherwise.
final def asInstanceOf[T0]: T0
Permalink

Definition Classes
Any
def ceil: PosZDouble
Permalink
def floor: PosZDouble
Permalink
def getClass(): Class[_ <: AnyVal]
Permalink

Definition Classes
AnyVal → Any
final def isInstanceOf[T0]: Boolean
Permalink

Definition Classes
Any
def isPosInfinity: Boolean
Permalink
def isWhole: Boolean
Permalink
def max(that: PosZDouble ): PosZDouble
Permalink
Returns this if this > that or that otherwise.
Returns this if this > that or that otherwise.
def min(that: PosZDouble ): PosZDouble
Permalink
Returns this if this < that or that otherwise.
Returns this if this < that or that otherwise.
def round: PosZLong
Permalink
def to(end: Double, step: Double): Inclusive[Double]
Permalink
Create an inclusive Range from this PosZDouble value to the specified end with the specified step value.
Create an inclusive Range from this PosZDouble value to the specified end with the specified step value.
end
The final bound of the range to make.
step
The number to increase by for each step of the range.
returns
A scala.collection.immutable.NumericRange.Inclusive[Double] from this up to and including end.
def to(end: Double): Partial[Double, NumericRange[Double]]
Permalink
Create an inclusive Range from this PosZDouble value to the specified end with step value 1.
Create an inclusive Range from this PosZDouble value to the specified end with step value 1.
end
The final bound of the range to make.
returns
A NumericRange[Double]] from this up to and including end.
def toByte: Byte
Permalink
Converts this PosZDouble to a Byte.
Converts this PosZDouble to a Byte.
def toChar: Char
Permalink
Converts this PosZDouble to a Char.
Converts this PosZDouble to a Char.
def toDegrees: Double
Permalink
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
Permalink
Converts this PosZDouble to a Double.
Converts this PosZDouble to a Double.
def toFloat: Float
Permalink
Converts this PosZDouble to a Float.
Converts this PosZDouble to a Float.
def toInt: Int
Permalink
Converts this PosZDouble to an Int.
Converts this PosZDouble to an Int.
def toLong: Long
Permalink
Converts this PosZDouble to a Long.
Converts this PosZDouble to a Long.
def toRadians: Double
Permalink
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
Permalink
Converts this PosZDouble to a Short.
Converts this PosZDouble to a Short.
def toString(): String
Permalink
A string representation of this PosZDouble.
A string representation of this PosZDouble.

Definition Classes
PosZDouble → Any
def unary_+: PosZDouble
Permalink
Returns this value, unmodified.
def unary_-: Double
Permalink
Returns the negation of this value.
def until(end: Double, step: Double): Exclusive[Double]
Permalink
Create a Range from this PosZDouble value until the specified end (exclusive) with the specified step value.
Create a Range from this PosZDouble value until the specified end (exclusive) with the specified step value.
end
The final bound of the range to make.
step
The number to increase by for each step of the range.
returns
A scala.collection.immutable.NumericRange.Exclusive[Double] from this up to but not including end.
def until(end: Double): Partial[Double, NumericRange[Double]]
Permalink
Create a Range from this PosZDouble value until the specified end (exclusive) with step value 1.
Create a Range from this PosZDouble value until the specified end (exclusive) with step value 1.
end
The final bound of the range to make.
returns
A NumericRange[Double]] from this up to but not including end.
val value: Double
Permalink
The Double value underlying this PosZDouble.
The Double value underlying this PosZDouble.

PosZDouble

Related Docs: object PosZDouble | package anyvals

final class PosZDouble extends AnyVal

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

def %(x: Double): Double

def %(x: Float): Double

def %(x: Long): Double

def %(x: Int): Double

def %(x: Char): Double

def %(x: Short): Double

def %(x: Byte): Double

def *(x: Double): Double

def *(x: Float): Double

def *(x: Long): Double

def *(x: Int): Double

def *(x: Char): Double

def *(x: Short): Double

def *(x: Byte): Double

def +(x: Double): Double

def +(x: Float): Double

def +(x: Long): Double

def +(x: Int): Double

def +(x: Char): Double

def +(x: Short): Double

def +(x: Byte): Double

def +(x: String): String

def -(x: Double): Double

def -(x: Float): Double

def -(x: Long): Double

def -(x: Int): Double

def -(x: Char): Double

def -(x: Short): Double

def -(x: Byte): Double

def /(x: Double): Double

def /(x: Float): Double

def /(x: Long): Double

def /(x: Int): Double

def /(x: Char): Double

def /(x: Short): Double

def /(x: Byte): Double

def <(x: Double): Boolean

def <(x: Float): Boolean

def <(x: Long): Boolean

def <(x: Int): Boolean

def <(x: Char): Boolean

def <(x: Short): Boolean

def <(x: Byte): Boolean

def <=(x: Double): Boolean

def <=(x: Float): Boolean

def <=(x: Long): Boolean

def <=(x: Int): Boolean

def <=(x: Char): Boolean

def <=(x: Short): Boolean

def <=(x: Byte): Boolean

final def ==(arg0: Any): Boolean

def >(x: Double): Boolean

def >(x: Float): Boolean

def >(x: Long): Boolean

def >(x: Int): Boolean

def >(x: Char): Boolean

def >(x: Short): Boolean

def >(x: Byte): Boolean

def >=(x: Double): Boolean

def >=(x: Float): Boolean

def >=(x: Long): Boolean

def >=(x: Int): Boolean

def >=(x: Char): Boolean

def >=(x: Short): Boolean

def >=(x: Byte): Boolean

final def asInstanceOf[T0]: T0

def ceil: PosZDouble

def floor: PosZDouble

def getClass(): Class[_ <: AnyVal]

final def isInstanceOf[T0]: Boolean

def isPosInfinity: Boolean

def isWhole: Boolean

def max(that: PosZDouble ): PosZDouble

def min(that: PosZDouble ): PosZDouble