org.scalactic.anyvals

PosZDouble

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.

Source
PosZDouble.scala
Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. PosZDouble
  2. AnyRef
  3. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Value Members

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

    Definition Classes
    AnyRef
  2. final def !=(arg0: Any): Boolean

    Definition Classes
    Any
  3. final def ##(): Int

    Definition Classes
    AnyRef → Any
  4. final def ==(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  5. final def ==(arg0: Any): Boolean

    Definition Classes
    Any
  6. 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).

  7. final val MinPositiveValue: PosZDouble

    The smallest value representable as a positive Double, which is PosDouble(4.9E-324).

    The smallest value representable as a positive Double, which is PosDouble(4.9E-324).

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

  9. final val PositiveInfinity: PosZDouble

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

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

  10. implicit 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, i.e., with a value greater than or equal to 0, it will return a PosZDouble representing that value. Otherwise, the passed Double expression is either a literal that is 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.)

    Annotations
    @macroImpl( ... )
  11. final def asInstanceOf[T0]: T0

    Definition Classes
    Any
  12. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  13. def ensuringValid(value: Double): PosZDouble

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

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

    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 Double value and if it is a non-negative Double, i.e., a value greater than or equal to 0, it will return a PosZDouble representing that value. Otherwise, the passed Double value is 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 this method 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 positive or zero.

    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 positive, else throws AssertionError.

    Exceptions thrown
    AssertionError

    if the passed value is not zero or positive

  14. final def eq(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  15. def equals(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any
  16. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  17. 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, i.e., a value greater than or equal to 0, it will return a PosZDouble representing that value, wrapped in a Some. Otherwise, the passed Double value is 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 positive, else None.

  18. 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 positive or zero Double, i.e., a value greater than or equal to 0.0, it will return a PosZDouble representing that value. Otherwise, the passed Double value is 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 positive or zero, return.

    default

    the PosZDouble to return if the passed Double value is not positive or zero.

    returns

    the specified Double value wrapped in a PosZDouble, if it is positive or zero, else the default PosZDouble value.

  19. final def getClass(): Class[_]

    Definition Classes
    AnyRef → Any
  20. def hashCode(): Int

    Definition Classes
    AnyRef → Any
  21. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any
  22. def isValid(value: Double): Boolean

    A predicate method that returns true if a given Double value is positive or zero.

    A predicate method that returns true if a given Double value is positive or zero.

    value

    the Double to inspect, and if positive or zero, return true.

    returns

    true if the specified Double is positive or zero, else false.

  23. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  24. final def notify(): Unit

    Definition Classes
    AnyRef
  25. final def notifyAll(): Unit

    Definition Classes
    AnyRef
  26. implicit val posZDoubleOrd: Ordering[PosZDouble]

    Implicit Ordering instance.

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

    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 positive or zero Double to another positive or zero Double will always result in another positive or zero Double value (though the result may be positive infinity).

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

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

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

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

    This method will always succeed (not throw an exception) because adding a positive or zero Double to another positive or zero Double will always result in another positive or zero Double value (though the result may be positive 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.

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

    Definition Classes
    AnyRef
  30. def toString(): String

    Definition Classes
    AnyRef → Any
  31. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  32. final def wait(arg0: Long, arg1: Int): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  33. final def wait(arg0: Long): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  34. implicit def widenToDouble(poz: PosZDouble): Double

    Implicit widening conversion from PosZDouble to Double.

    Implicit widening conversion from PosZDouble to Double.

    returns

    the Double value underlying the specified PosZDouble.

Inherited from AnyRef

Inherited from Any

Ungrouped