Packages

final class PosDouble extends AnyVal

An AnyVal for positive Doubles.

Note: a PosDouble may not equal 0. If you want positive number or 0, use PosZDouble.

Because PosDouble is an AnyVal it will usually be as efficient as an Double, being boxed only when a Double would have been boxed.

The PosDouble.apply factory method is implemented in terms of a macro that checks literals for validity at compile time. Calling PosDouble.apply with a literal Double value will either produce a valid PosDouble instance at run time or an error at compile time. Here's an example:

scala> import anyvals._
import anyvals._

scala> PosDouble(1.0)
res1: org.scalactic.anyvals.PosDouble = PosDouble(1.0)

scala> PosDouble(0.0)
<console>:14: error: PosDouble.apply can only be invoked on a positive (i > 0.0) floating point literal, like PosDouble(42.0).
              PosDouble(0.0)
                       ^

PosDouble.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 PosDouble.apply, you'll get a compiler error that suggests you use a different factor method, PosDouble.from, instead:

scala> val x = 1.0
x: Double = 1.0

scala> PosDouble(x)
<console>:15: error: PosDouble.apply can only be invoked on a floating point literal, like PosDouble(42.0). Please use PosDouble.from instead.
              PosDouble(x)
                       ^

The PosDouble.from factory method will inspect the value at runtime and return an Option[PosDouble]. If the value is valid, PosDouble.from will return a Some[PosDouble], else it will return a None. Here's an example:

scala> PosDouble.from(x)
res4: Option[org.scalactic.anyvals.PosDouble] = Some(PosDouble(1.0))

scala> val y = 0.0
y: Double = 0.0

scala> PosDouble.from(y)
res5: Option[org.scalactic.anyvals.PosDouble] = None

The PosDouble.apply factory method is marked implicit, so that you can pass literal Doubles into methods that require PosDouble, and get the same compile-time checking you get when calling PosDouble.apply explicitly. Here's an example:

scala> def invert(pos: PosDouble): Double = Double.MaxValue - pos
invert: (pos: org.scalactic.anyvals.PosDouble)Double

scala> invert(1.1)
res6: Double = 1.7976931348623157E308

scala> invert(Double.MaxValue)
res8: Double = 0.0

scala> invert(0.0)
<console>:15: error: PosDouble.apply can only be invoked on a positive (i > 0.0) floating point literal, like PosDouble(42.0).
              invert(0.0)
                     ^

scala> invert(-1.0)
<console>:15: error: PosDouble.apply can only be invoked on a positive (i > 0.0) floating point literal, like PosDouble(42.0).
              invert(-1.0)
                      ^

This example also demonstrates that the PosDouble companion object also defines implicit widening conversions when a similar conversion is provided in Scala. This makes it convenient to use a PosDouble 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 PosDouble (the type of pos), you can still subtract pos, because the PosDouble will be implicitly widened to Double.

Source
PosDouble.scala
Linear Supertypes
AnyVal, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. PosDouble
  2. AnyVal
  3. Any
  1. Hide All
  2. Show All
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 PosDouble'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: PosDouble
  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: PosDouble): PosDouble

    Returns this if this > that or that otherwise.

  76. def min(that: PosDouble): PosDouble

    Returns this if this < that or that otherwise.

  77. def round: PosZLong
  78. def toByte: Byte

    Converts this PosDouble to a Byte.

  79. def toChar: Char

    Converts this PosDouble to a Char.

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

  81. def toDouble: Double

    Converts this PosDouble to a Double.

  82. def toFloat: Float

    Converts this PosDouble to a Float.

  83. def toInt: Int

    Converts this PosDouble to an Int.

  84. def toLong: Long

    Converts this PosDouble to a Long.

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

  86. def toShort: Short

    Converts this PosDouble to a Short.

  87. def toString(): String

    A string representation of this PosDouble.

    A string representation of this PosDouble.

    Definition Classes
    PosDouble → Any
  88. def unary_+: PosDouble

    Returns this value, unmodified.

  89. def unary_-: Double

    Returns the negation of this value.

  90. val value: Double

Deprecated Value Members

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

    Create an inclusive Range from this PosDouble value to the specified end with the specified step value.

    Create an inclusive Range from this PosDouble 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.

    Annotations
    @deprecated
    Deprecated

    This function will be removed in future version of Scalactic, use BigDecimal's to function instead

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

    Create an inclusive Range.Partial from this PosDouble value to the specified end with step value 1.

    Create an inclusive Range.Partial from this PosDouble 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.

    Annotations
    @deprecated
    Deprecated

    This function will be removed in future version of Scalactic, use BigDecimal's to function instead

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

    Create a Range from this PosDouble value until the specified end (exclusive) with the specified step value.

    Create a Range from this PosDouble 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.

    Annotations
    @deprecated
    Deprecated

    This function will be removed in future version of Scalactic, use BigDecimal's until's function instead

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

    Create a Range.Partial from this PosDouble value until the specified end (exclusive) with step value 1.

    Create a Range.Partial from this PosDouble 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.

    Annotations
    @deprecated
    Deprecated

    This function will be removed in future version of Scalactic, use BigDecimal's until function instead

Inherited from AnyVal

Inherited from Any

Ungrouped