PosZDouble

org.scalactic.anyvals.PosZDouble
See thePosZDouble companion class
object PosZDouble

The companion object for PosZDouble that offers factory methods that produce PosZDoubles, implicit widening conversions from PosZDouble to other numeric types, and maximum and minimum constant values for PosZDouble.

Attributes

Companion
class
Source
PosZDouble.scala
Graph
Supertypes
class Object
trait Matchable
class Any
Self type
PosZDouble.type

Members list

Value members

Concrete methods

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.

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 parameters

value

the Double to inspect, and if non-negative, return wrapped in a PosZDouble.

Attributes

Returns

the specified Double value wrapped in a PosZDouble, if it is non-negative, else throws AssertionError.

Throws
AssertionError

if the passed value is not non-negative

Source
PosZDouble.scala
def from(value: Double): Option[PosZDouble]

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

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 parameters

value

the Double to inspect, and if non-negative, return wrapped in a Some[PosZDouble].

Attributes

Returns

the specified Double value wrapped in a Some[PosZDouble], if it is PosZDouble, else None.

Source
PosZDouble.scala
def fromOrElse(value: Double, default: => PosZDouble): PosZDouble

A factory method that produces a PosZDouble given a Double value and a default 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 parameters

default

the PosZDouble to return if the passed Double value is not non-negative.

value

the Double to inspect, and if non-negative, return.

Attributes

Returns

the specified Double value wrapped in a PosZDouble, if it is non-negative, else the default PosZDouble value.

Source
PosZDouble.scala
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.

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 parameters

value

the Double to inspect, and if non-negative, return wrapped in a Good(PosZDouble).

Attributes

Returns

the specified Double value wrapped in a Good(PosZDouble), if it is non-negative, else a Bad(f(value)).

Source
PosZDouble.scala
def isValid(value: Double): Boolean

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

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

Value parameters

value

the Double to inspect, and if non-negative, return true.

Attributes

Returns

true if the specified Double is positive, else false.

Source
PosZDouble.scala
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.

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 parameters

value

the Int to validate that it is non-negative.

Attributes

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.

Source
PosZDouble.scala
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.

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 parameters

value

the Double to inspect, and if non-negative, return wrapped in a Right(PosZDouble).

Attributes

Returns

the specified Double value wrapped in a Right(PosZDouble), if it is non-negative, else a Left(f(value)).

Source
PosZDouble.scala
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.

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 parameters

value

the Float to inspect, and if non-negative, return wrapped in a Success(PosZDouble).

Attributes

Returns

the specified Float value wrapped in a Success(PosZDouble), if it is non-negative, else a Failure(AssertionError).

Source
PosZDouble.scala

Concrete fields

final val MaxValue: PosZDouble

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

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

Attributes

Source
PosZDouble.scala

The smallest positive value greater than 0.0d representable as a PosZDouble, which is PosZDouble(4.9E-324).

The smallest positive value greater than 0.0d representable as a PosZDouble, which is PosZDouble(4.9E-324).

Attributes

Source
PosZDouble.scala
final val MinValue: PosZDouble

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

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

Attributes

Source
PosZDouble.scala

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

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

Attributes

Source
PosZDouble.scala

Deprecated fields

val posZDoubleOrd: Ordering[PosZDouble]

The formerly implicit posZDoubleOrd field has been deprecated and will be removed in a future version of ScalaTest. Please use the ordering field instead.

The formerly implicit posZDoubleOrd field has been deprecated and will be removed in a future version of ScalaTest. Please use the ordering field instead.

Attributes

Deprecated
true
Source
PosZDouble.scala

Implicits

Implicits

implicit inline 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.

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 parameters

value

the Double literal expression to inspect at compile time, and if non-negative, to return wrapped in a PosZDouble at run time.

Attributes

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

Source
PosZDouble.scala
implicit val ordering: Ordering[PosZDouble]

Implicit Ordering instance.

Implicit Ordering instance.

Attributes

Source
PosZDouble.scala
implicit def widenToDouble(pos: PosZDouble): Double

Implicit widening conversion from PosZDouble to Double.

Implicit widening conversion from PosZDouble to Double.

Value parameters

pos

the PosZDouble to widen

Attributes

Returns

the Double value underlying the specified PosZDouble

Source
PosZDouble.scala