Scalactic 3.2.0-SNAP7 - org.scalactic.anyvals.PosZDouble

final def !=(arg0: Any): Boolean

Definition Classes: AnyRef → Any

final def ##(): Int

Definition Classes: AnyRef → Any

final def ==(arg0: Any): Boolean

Definition Classes: AnyRef → Any

final val MaxValue: PosZDouble

The largest value representable as a non-negative Double, which is PosZDouble(1.7976931348623157E308).

final val MinPositiveValue: PosZDouble

final val MinValue: PosZDouble

The smallest value representable as a non-negative Double, which is PosZDouble(0.0).

final val PositiveInfinity: PosZDouble

The positive infinity value, which is PosZDouble.ensuringValid(Double.PositiveInfinity).

implicit macro def apply(value: Double): PosZDouble

A factory method, implemented via a macro, that produces a PosZDouble if passed a valid Double literal, otherwise a compile time error.

The macro that implements this method will inspect the specified Double expression at compile time. If the expression is a non-negative Double literal, it will return a PosZDouble representing that value. Otherwise, the passed Double expression is either a literal that is not non-negative, or is not a literal, so this method will give a compiler error.

This factory method differs from the from factory method in that this method is implemented via a macro that inspects Double literals at compile time, whereas from inspects Double values at run time.

value: the Double literal expression to inspect at compile time, and if non-negative, to return wrapped in a PosZDouble at run time.
returns: the specified, valid Double literal value wrapped in a PosZDouble. (If the specified expression is not a valid Double literal, the invocation of this method will not compile.)

final def asInstanceOf[T0]: T0

Definition Classes: Any

def clone(): AnyRef

Attributes: protected[java.lang]
Definition Classes: AnyRef
Annotations: @throws( ... )

def ensuringValid(value: Double): PosZDouble

A factory/assertion method that produces a PosZDouble given a valid Double value, or throws AssertionError, if given an invalid Double value.

This method will inspect the passed Double value and if it is a non-negative Double, it will return a PosZDouble representing that value. Otherwise, the passed Double value is not non-negative, so this method will throw AssertionError.

This factory method differs from the apply factory method in that apply is implemented via a macro that inspects Double literals at compile time, whereas from inspects Double values at run time. It 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 a Double is non-negative.

value: the Double to inspect, and if non-negative, return wrapped in a PosZDouble.
returns: the specified Double value wrapped in a PosZDouble, if it is non-negative, else throws AssertionError.

Exceptions thrown: AssertionError if the passed value is not non-negative

final def eq(arg0: AnyRef): Boolean

Definition Classes: AnyRef

def equals(arg0: Any): Boolean

Definition Classes: AnyRef → Any

def finalize(): Unit

Attributes: protected[java.lang]
Definition Classes: AnyRef
Annotations: @throws( classOf[java.lang.Throwable] )

def from(value: Double): Option[PosZDouble]

A factory method that produces an Option[PosZDouble] given a Double value.

This method will inspect the passed Double value and if it is a non-negative Double, it will return a PosZDouble representing that value, wrapped in a Some. Otherwise, the passed Double value is not non-negative, so this method will return None.

This factory method differs from the apply factory method in that apply is implemented via a macro that inspects Double literals at compile time, whereas from inspects Double values at run time.

value: the Double to inspect, and if non-negative, return wrapped in a Some[PosZDouble].
returns: the specified Double value wrapped in a Some[PosZDouble], if it is PosZDouble, else None.

def fromOrElse(value: Double, default: ⇒ PosZDouble): PosZDouble

A factory method that produces a PosZDouble given a Double value and a default PosZDouble.

This method will inspect the passed Double value and if it is a non-negative Double, it will return a PosZDouble representing that value. Otherwise, the passed Double value is non-negative, so this method will return the passed default value.

This factory method differs from the apply factory method in that apply is implemented via a macro that inspects Double literals at compile time, whereas from inspects Double values at run time.

value: the Double to inspect, and if non-negative, return.
default: the PosZDouble to return if the passed Double value is not non-negative.
returns: the specified Double value wrapped in a PosZDouble, if it is non-negative, else the default PosZDouble value.

final def getClass(): Class[_]

Definition Classes: AnyRef → Any

def goodOrElse[B](value: Double)(f: (Double) ⇒ B): Or[PosZDouble, B]

A factory/validation method that produces a PosZDouble, wrapped in a Good, given a valid Double value, or if the given Double is invalid, an error value of type B produced by passing the given invalid Double value to the given function f, wrapped in a Bad.

This method will inspect the passed Double value and if it is a non-negative Double, it will return a PosZDouble representing that value, wrapped in a Good. Otherwise, the passed Double value is not non-negative, so this method will return a result of type B obtained by passing the invalid Double value to the given function f, wrapped in a Bad.

This factory method differs from the apply factory method in that apply is implemented via a macro that inspects Double literals at compile time, whereas this method inspects Double values at run time.

value: the Double to inspect, and if non-negative, return wrapped in a Good(PosZDouble).
returns: the specified Double value wrapped in a Good(PosZDouble), if it is non-negative, else a Bad(f(value)).

def hashCode(): Int

Definition Classes: AnyRef → Any

final def isInstanceOf[T0]: Boolean

Definition Classes: Any

def isValid(value: Double): Boolean

A predicate method that returns true if a given Double value is non-negative.

value: the Double to inspect, and if non-negative, return true.
returns: true if the specified Double is positive, else false.

final def ne(arg0: AnyRef): Boolean

Definition Classes: AnyRef

final def notify(): Unit

Definition Classes: AnyRef

final def notifyAll(): Unit

Definition Classes: AnyRef

implicit val ordering: Ordering[PosZDouble]

Implicit Ordering instance.

def passOrElse[E](value: Double)(f: (Double) ⇒ E): Validation[E]

A validation method that produces a Pass given a valid Double value, or an error value of type E produced by passing the given invalid Int value to the given function f, wrapped in a Fail.

This method will inspect the passed Double value and if it is a non-negative Double, it will return a Pass. Otherwise, the passed Double value is non-negative, so this method will return a result of type E obtained by passing the invalid Double value to the given function f, wrapped in a Fail.

This factory method differs from the apply factory method in that apply is implemented via a macro that inspects Double literals at compile time, whereas this method inspects Double values at run time.

value: the Int to validate that it is non-negative.
returns: a Pass if the specified Int value is non-negative, else a Fail containing an error value produced by passing the specified Double to the given function f.

def rightOrElse[L](value: Double)(f: (Double) ⇒ L): Either[L, PosZDouble]

A factory/validation method that produces a PosZDouble, wrapped in a Right, given a valid Double value, or if the given Double is invalid, an error value of type L produced by passing the given invalid Double value to the given function f, wrapped in a Left.

This method will inspect the passed Double value and if it is a non-negative Double, it will return a PosZDouble representing that value, wrapped in a Right. Otherwise, the passed Double value is not non-negative, so this method will return a result of type L obtained by passing the invalid Double value to the given function f, wrapped in a Left.

This factory method differs from the apply factory method in that apply is implemented via a macro that inspects Double literals at compile time, whereas this method inspects Double values at run time.

value: the Double to inspect, and if non-negative, return wrapped in a Right(PosZDouble).
returns: the specified Double value wrapped in a Right(PosZDouble), if it is non-negative, else a Left(f(value)).

def sumOf(first: PosZDouble, second: PosZDouble, rest: PosZDouble*): PosZDouble

Returns the PosZDouble sum of the passed PosZDouble values first and value second, and the PosZDouble values passed as varargs rest.

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

This overloaded form of the sumOf method can sum more than two values, but unlike its two-arg sibling, will entail boxing.

def sumOf(x: PosZDouble, y: PosZDouble): PosZDouble

Returns the PosZDouble sum of the passed PosZDouble values x and y.

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 PosZDouble Double value (though the result may be infinity).

This overloaded form of the method is used when there are just two arguments so that boxing is avoided. The overloaded sumOf that takes a varargs of PosZDouble starting at the third parameter can sum more than two values, but will entail boxing and may therefore be less efficient.

final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes: AnyRef

def toString(): String

Definition Classes: AnyRef → Any

def tryingValid(value: Double): Try[PosZDouble]

A factory/validation method that produces a PosZDouble, wrapped in a Success, given a valid Float value, or if the given Float is invalid, an AssertionError, wrapped in a Failure.

Note: you should use this method only when you are convinced that it will always succeed, i.e., never throw an exception. It is good practice to add a comment near the invocation of this method indicating why you think it will always succeed to document your reasoning. If you are not sure an ensuringValid call will always succeed, you should use one of the other factory or validation methods provided on this object instead: isValid, tryingValid, passOrElse, goodOrElse, or rightOrElse.

This method will inspect the passed Float value and if it is a non-negative Float, it will return a PosZDouble representing that value, wrapped in a Success. Otherwise, the passed Float value is not non-negative, so this method will return an AssertionError, wrapped in a Failure.

This factory method differs from the apply factory method in that apply is implemented via a macro that inspects Float literals at compile time, whereas this method inspects Float values at run time.

value: the Float to inspect, and if non-negative, return wrapped in a Success(PosZDouble).
returns: the specified Float value wrapped in a Success(PosZDouble), if it is non-negative, else a Failure(AssertionError).

final def wait(): Unit

Definition Classes: AnyRef
Annotations: @throws( ... )

final def wait(arg0: Long, arg1: Int): Unit

Definition Classes: AnyRef
Annotations: @throws( ... )

final def wait(arg0: Long): Unit

Definition Classes: AnyRef
Annotations: @throws( ... )

implicit def widenToDouble(pos: PosZDouble): Double

Implicit widening conversion from PosZDouble to Double.

pos: the PosZDouble to widen
returns: the Double value underlying the specified PosZDouble

Packages

PosZDouble

Companion class PosZDouble

object PosZDouble

Value Members

Inherited from AnyRef

Inherited from Any

Ungrouped

Packages

PosZDouble 

Companion class PosZDouble

object PosZDouble

Value Members

Inherited from AnyRef

Inherited from Any

Ungrouped

PosZDouble