org.scalactic.anyvals

PosZDouble

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, NotNull, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. PosZDouble
  2. AnyVal
  3. NotNull
  4. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Value Members

  1. final def !=(arg0: Any): Boolean

    Definition Classes
    Any

  2. final def ##(): Int

    Definition Classes
    Any

  3. def %(x: Double): Double

    Returns the remainder of the division of this value by x.

  4. def %(x: Float): Double

    Returns the remainder of the division of this value by x.

  5. def %(x: Long): Double

    Returns the remainder of the division of this value by x.

  6. def %(x: Int): Double

    Returns the remainder of the division of this value by x.

  7. def %(x: Char): Double

    Returns the remainder of the division of this value by x.

  8. def %(x: Short): Double

    Returns the remainder of the division of this value by x.

  9. def %(x: Byte): Double

    Returns the remainder of the division of this value by x.

  10. def *(x: Double): Double

    Returns the product of this value and x.

  11. def *(x: Float): Double

    Returns the product of this value and x.

  12. def *(x: Long): Double

    Returns the product of this value and x.

  13. def *(x: Int): Double

    Returns the product of this value and x.

  14. def *(x: Char): Double

    Returns the product of this value and x.

  15. def *(x: Short): Double

    Returns the product of this value and x.

  16. def *(x: Byte): Double

    Returns the product of this value and x.

  17. def +(x: Double): Double

    Returns the sum of this value and x.

  18. def +(x: Float): Double

    Returns the sum of this value and x.

  19. def +(x: Long): Double

    Returns the sum of this value and x.

  20. def +(x: Int): Double

    Returns the sum of this value and x.

  21. def +(x: Char): Double

    Returns the sum of this value and x.

  22. def +(x: Short): Double

    Returns the sum of this value and x.

  23. def +(x: Byte): Double

    Returns the sum of this value and x.

  24. def +(x: String): String

    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.

  25. def -(x: Double): Double

    Returns the difference of this value and x.

  26. def -(x: Float): Double

    Returns the difference of this value and x.

  27. def -(x: Long): Double

    Returns the difference of this value and x.

  28. def -(x: Int): Double

    Returns the difference of this value and x.

  29. def -(x: Char): Double

    Returns the difference of this value and x.

  30. def -(x: Short): Double

    Returns the difference of this value and x.

  31. def -(x: Byte): Double

    Returns the difference of this value and x.

  32. def /(x: Double): Double

    Returns the quotient of this value and x.

  33. def /(x: Float): Double

    Returns the quotient of this value and x.

  34. def /(x: Long): Double

    Returns the quotient of this value and x.

  35. def /(x: Int): Double

    Returns the quotient of this value and x.

  36. def /(x: Char): Double

    Returns the quotient of this value and x.

  37. def /(x: Short): Double

    Returns the quotient of this value and x.

  38. def /(x: Byte): Double

    Returns the quotient of this value and x.

  39. def <(x: Double): Boolean

    Returns true if this value is less than x, false otherwise.

  40. def <(x: Float): Boolean

    Returns true if this value is less than x, false otherwise.

  41. def <(x: Long): Boolean

    Returns true if this value is less than x, false otherwise.

  42. def <(x: Int): Boolean

    Returns true if this value is less than x, false otherwise.

  43. def <(x: Char): Boolean

    Returns true if this value is less than x, false otherwise.

  44. def <(x: Short): Boolean

    Returns true if this value is less than x, false otherwise.

  45. def <(x: Byte): Boolean

    Returns true if this value is less than x, false otherwise.

  46. def <=(x: Double): Boolean

    Returns true if this value is less than or equal to x, false otherwise.

  47. def <=(x: Float): Boolean

    Returns true if this value is less than or equal to x, false otherwise.

  48. def <=(x: Long): Boolean

    Returns true if this value is less than or equal to x, false otherwise.

  49. def <=(x: Int): Boolean

    Returns true if this value is less than or equal to x, false otherwise.

  50. def <=(x: Char): Boolean

    Returns true if this value is less than or equal to x, false otherwise.

  51. def <=(x: Short): Boolean

    Returns true if this value is less than or equal to x, false otherwise.

  52. def <=(x: Byte): Boolean

    Returns true if this value is less than or equal to x, false otherwise.

  53. final def ==(arg0: Any): Boolean

    Definition Classes
    Any

  54. def >(x: Double): Boolean

    Returns true if this value is greater than x, false otherwise.

  55. def >(x: Float): Boolean

    Returns true if this value is greater than x, false otherwise.

  56. def >(x: Long): Boolean

    Returns true if this value is greater than x, false otherwise.

  57. def >(x: Int): Boolean

    Returns true if this value is greater than x, false otherwise.

  58. def >(x: Char): Boolean

    Returns true if this value is greater than x, false otherwise.

  59. def >(x: Short): Boolean

    Returns true if this value is greater than x, false otherwise.

  60. def >(x: Byte): Boolean

    Returns true if this value is greater than x, false otherwise.

  61. def >=(x: Double): Boolean

    Returns true if this value is greater than or equal to x, false otherwise.

  62. def >=(x: Float): Boolean

    Returns true if this value is greater than or equal to x, false otherwise.

  63. def >=(x: Long): Boolean

    Returns true if this value is greater than or equal to x, false otherwise.

  64. def >=(x: Int): Boolean

    Returns true if this value is greater than or equal to x, false otherwise.

  65. def >=(x: Char): Boolean

    Returns true if this value is greater than or equal to x, false otherwise.

  66. def >=(x: Short): Boolean

    Returns true if this value is greater than or equal to x, false otherwise.

  67. def >=(x: Byte): Boolean

    Returns true if this value is greater than or equal to x, false otherwise.

  68. final def asInstanceOf[T0]: T0

    Definition Classes
    Any

  69. def ceil: PosZDouble

  70. def floor: PosZDouble

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

    Definition Classes
    AnyVal → Any

  72. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any

  73. def isPosInfinity: Boolean

  74. def isWhole: Boolean

  75. def max(that: PosZDouble): PosZDouble

    Returns this if this > that or that otherwise.

    Returns this if this > that or that otherwise.

  76. def min(that: PosZDouble): PosZDouble

    Returns this if this < that or that otherwise.

    Returns this if this < that or that otherwise.

  77. def round: PosZLong

  78. def to(end: Double, step: Double): Inclusive[Double]

    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.

  79. def to(end: Double): Partial[Double, NumericRange[Double]]

    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.

  80. def toByte: Byte

    Converts this PosZDouble to a Byte.

    Converts this PosZDouble to a Byte.

  81. def toChar: Char

    Converts this PosZDouble to a Char.

    Converts this PosZDouble to a Char.

  82. 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.

  83. def toDouble: Double

    Converts this PosZDouble to a Double.

    Converts this PosZDouble to a Double.

  84. def toFloat: Float

    Converts this PosZDouble to a Float.

    Converts this PosZDouble to a Float.

  85. def toInt: Int

    Converts this PosZDouble to an Int.

    Converts this PosZDouble to an Int.

  86. def toLong: Long

    Converts this PosZDouble to a Long.

    Converts this PosZDouble to a Long.

  87. 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.

  88. def toShort: Short

    Converts this PosZDouble to a Short.

    Converts this PosZDouble to a Short.

  89. def toString(): String

    A string representation of this PosZDouble.

    A string representation of this PosZDouble.

    Definition Classes
    PosZDouble → Any

  90. def unary_+: PosZDouble

    Returns this value, unmodified.

  91. def unary_-: Double

    Returns the negation of this value.

  92. def until(end: Double, step: Double): Exclusive[Double]

    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.

  93. def until(end: Double): Partial[Double, NumericRange[Double]]

    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.

  94. val value: Double

    The Double value underlying this PosZDouble.

    The Double value underlying this PosZDouble.

Inherited from AnyVal

Inherited from NotNull

Inherited from Any

Ungrouped