PosDouble

An AnyVal for positive Doubles.

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.1)
res1: org.scalactic.anyvals.PosDouble = PosDouble(1.1)

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

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.1
x: Double = 1.1

scala> PosDouble(x)
<console>:15: error: PosDouble.apply can only be invoked on a floating point literal, like PosDouble(1.1). 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.1))

scala> val y = -1.1
y: Double = -1.1

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(-1.1)
<console>:15: error: PosDouble.apply can only be invoked on a positive (i > 0.0) floating point literal, like PosDouble(1.1).
              invert(-1.1)
                     ^

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

Value Members

final def !=(arg0: Any): Boolean

Definition Classes
Any
final def ##(): Int

Definition Classes
Any
def %(x: Double): Double

Returns the remainder of the division of this value by x.
def %(x: Float): Double

Returns the remainder of the division of this value by x.
def %(x: Long): Double

Returns the remainder of the division of this value by x.
def %(x: Int): Double

Returns the remainder of the division of this value by x.
def %(x: Char): Double

Returns the remainder of the division of this value by x.
def %(x: Short): Double

Returns the remainder of the division of this value by x.
def %(x: Byte): Double

Returns the remainder of the division of this value by x.
def *(x: Double): Double

Returns the product of this value and x.
def *(x: Float): Double

Returns the product of this value and x.
def *(x: Long): Double

Returns the product of this value and x.
def *(x: Int): Double

Returns the product of this value and x.
def *(x: Char): Double

Returns the product of this value and x.
def *(x: Short): Double

Returns the product of this value and x.
def *(x: Byte): Double

Returns the product of this value and x.
def +(x: Double): Double

Returns the sum of this value and x.
def +(x: Float): Double

Returns the sum of this value and x.
def +(x: Long): Double

Returns the sum of this value and x.
def +(x: Int): Double

Returns the sum of this value and x.
def +(x: Char): Double

Returns the sum of this value and x.
def +(x: Short): Double

Returns the sum of this value and x.
def +(x: Byte): Double

Returns the sum of this value and x.
def +(x: String): String

Converts this PosDouble's value to a string then concatenates the given string.
Converts this PosDouble's value to a string then concatenates the given string.
def -(x: Double): Double

Returns the difference of this value and x.
def -(x: Float): Double

Returns the difference of this value and x.
def -(x: Long): Double

Returns the difference of this value and x.
def -(x: Int): Double

Returns the difference of this value and x.
def -(x: Char): Double

Returns the difference of this value and x.
def -(x: Short): Double

Returns the difference of this value and x.
def -(x: Byte): Double

Returns the difference of this value and x.
def /(x: Double): Double

Returns the quotient of this value and x.
def /(x: Float): Double

Returns the quotient of this value and x.
def /(x: Long): Double

Returns the quotient of this value and x.
def /(x: Int): Double

Returns the quotient of this value and x.
def /(x: Char): Double

Returns the quotient of this value and x.
def /(x: Short): Double

Returns the quotient of this value and x.
def /(x: Byte): Double

Returns the quotient of this value and x.
def <(x: Double): Boolean

Returns true if this value is less than x, false otherwise.
def <(x: Float): Boolean

Returns true if this value is less than x, false otherwise.
def <(x: Long): Boolean

Returns true if this value is less than x, false otherwise.
def <(x: Int): Boolean

Returns true if this value is less than x, false otherwise.
def <(x: Char): Boolean

Returns true if this value is less than x, false otherwise.
def <(x: Short): Boolean

Returns true if this value is less than x, false otherwise.
def <(x: Byte): Boolean

Returns true if this value is less than x, false otherwise.
def <=(x: Double): Boolean

Returns true if this value is less than or equal to x, false otherwise.
def <=(x: Float): Boolean

Returns true if this value is less than or equal to x, false otherwise.
def <=(x: Long): Boolean

Returns true if this value is less than or equal to x, false otherwise.
def <=(x: Int): Boolean

Returns true if this value is less than or equal to x, false otherwise.
def <=(x: Char): Boolean

Returns true if this value is less than or equal to x, false otherwise.
def <=(x: Short): Boolean

Returns true if this value is less than or equal to x, false otherwise.
def <=(x: Byte): Boolean

Returns true if this value is less than or equal to x, false otherwise.
final def ==(arg0: Any): Boolean

Definition Classes
Any
def >(x: Double): Boolean

Returns true if this value is greater than x, false otherwise.
def >(x: Float): Boolean

Returns true if this value is greater than x, false otherwise.
def >(x: Long): Boolean

Returns true if this value is greater than x, false otherwise.
def >(x: Int): Boolean

Returns true if this value is greater than x, false otherwise.
def >(x: Char): Boolean

Returns true if this value is greater than x, false otherwise.
def >(x: Short): Boolean

Returns true if this value is greater than x, false otherwise.
def >(x: Byte): Boolean

Returns true if this value is greater than x, false otherwise.
def >=(x: Double): Boolean

Returns true if this value is greater than or equal to x, false otherwise.
def >=(x: Float): Boolean

Returns true if this value is greater than or equal to x, false otherwise.
def >=(x: Long): Boolean

Returns true if this value is greater than or equal to x, false otherwise.
def >=(x: Int): Boolean

Returns true if this value is greater than or equal to x, false otherwise.
def >=(x: Char): Boolean

Returns true if this value is greater than or equal to x, false otherwise.
def >=(x: Short): Boolean

Returns true if this value is greater than or equal to x, false otherwise.
def >=(x: Byte): Boolean

Returns true if this value is greater than or equal to x, false otherwise.
final def asInstanceOf[T0]: T0

Definition Classes
Any
def ceil: PosDouble

Returns the smallest (closest to 0) PosDouble that is greater than or equal to this PosDouble and represents a mathematical integer.
def ensuringValid(f: (Double) ⇒ Double): PosDouble

Applies the passed Double => Double function to the underlying Double value, and if the result is positive, returns the result wrapped in a PosDouble, 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 PosDouble, else throws AssertionError.
This method will inspect the result of applying the given function to this PosDouble's underlying Double value and if the result is greater than 0.0, it will return a PosDouble 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 PosDouble'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.
f
the Double => Double function to apply to this PosDouble's underlying Double value.
returns
the result of applying this PosDouble's underlying Double value to to the passed function, wrapped in a PosDouble if it is positive (else throws AssertionError).

Exceptions thrown
AssertionError if the result of applying this PosDouble's underlying Double value to to the passed function is not positive.
def floor: PosZDouble

Returns the greatest (closest to infinity) PosZDouble that is less than or equal to this PosZDouble and represents a mathematical integer.
def getClass(): Class[_ <: AnyVal]

Definition Classes
AnyVal → Any
def isFinite: Boolean

True if this PosDouble value is any finite value (i.e., it is neither positive nor negative infinity), else false.
True if this PosDouble value is any finite value (i.e., it is neither positive nor negative infinity), else false.
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
def isPosInfinity: Boolean

True if this PosDouble value represents positive infinity, else false.
True if this PosDouble value represents positive infinity, else false.
def isWhole: Boolean

Indicates whether this PosDouble has a value that is a whole number: it is finite and it has no fraction part.
def max(that: PosDouble): PosDouble

Returns this if this > that or that otherwise.
Returns this if this > that or that otherwise.
def min(that: PosDouble): PosDouble

Returns this if this < that or that otherwise.
Returns this if this < that or that otherwise.
def plus(x: PosZDouble): PosDouble

Returns the PosDouble sum of this PosDouble's value and the given PosZDouble value.
Returns the PosDouble sum of this PosDouble's value and the given PosZDouble value.
This method will always succeed (not throw an exception) because adding a positive Double and non-negative Double and another positive Double will always result in another positive Double value (though the result may be infinity).
def round: PosZLong

Rounds this PosDouble value to the nearest whole number value that can be expressed as an PosZLong, returning the result as a PosZLong.
def toByte: Byte

Converts this PosDouble to a Byte.
Converts this PosDouble to a Byte.
def toChar: Char

Converts this PosDouble to a Char.
Converts this PosDouble to a Char.
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.
def toDouble: Double

Converts this PosDouble to a Double.
Converts this PosDouble to a Double.
def toFloat: Float

Converts this PosDouble to a Float.
Converts this PosDouble to a Float.
def toInt: Int

Converts this PosDouble to an Int.
Converts this PosDouble to an Int.
def toLong: Long

Converts this PosDouble to a Long.
Converts this PosDouble to a Long.
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.
def toShort: Short

Converts this PosDouble to a Short.
Converts this PosDouble to a Short.
def toString(): String

A string representation of this PosDouble.
A string representation of this PosDouble.

Definition Classes
PosDouble → Any
def unary_+: PosDouble

Returns this value, unmodified.
def unary_-: NegDouble

Returns the negation of this value.
val value: Double

The Double value underlying this PosDouble.
The Double value underlying this PosDouble.

Related Docs: object PosDouble | package anyvals

final class PosDouble 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: PosDouble

def ensuringValid(f: (Double) ⇒ Double): PosDouble

def floor: PosZDouble

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

def isFinite: Boolean

final def isInstanceOf[T0]: Boolean

def isPosInfinity: Boolean

def isWhole: Boolean