Value Members

1.  final def !=(arg0: Any): Boolean

   Definition Classes

   AnyRef → Any

2.  final def ##(): Int

   Definition Classes

   AnyRef → Any

3.  final def ==(arg0: Any): Boolean

   Definition Classes

   AnyRef → Any

4.  final val MaxValue: NegDouble

   The largest value representable as a negative Double, which is NegDouble(-4.9E-324).

5.  final val MinValue: NegDouble

   The smallest value representable as a negative Double, which is NegDouble(-1.7976931348623157E308).

6.  final val NegativeInfinity: NegDouble

   The negative infinity value, which is NegDouble.ensuringValid(Double.NegativeInfinity).

7.  implicit macro def apply(value: Double): NegDouble

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

   A factory method, implemented via a macro, that produces a NegDouble 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 negative Double literal, it will return a NegDouble representing that value. Otherwise, the passed Double expression is either a literal that is not 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 negative, to return wrapped in a NegDouble at run time.

   returns

   the specified, valid Double literal value wrapped in a NegDouble. (If the specified expression is not a valid Double literal, the invocation of this method will not compile.)

8.  final def asInstanceOf[T0]: T0

   Definition Classes

   Any

9.  def clone(): AnyRef

   Attributes

   protected[java.lang]

   Definition Classes

   AnyRef

   Annotations

   @throws( ... )

10.  def ensuringValid(value: Double): NegDouble

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

    A factory/assertion method that produces a NegDouble 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 negative Double, it will return a NegDouble representing that value. Otherwise, the passed Double value is not 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 negative.

    value

    the Double to inspect, and if negative, return wrapped in a NegDouble.

    returns

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

    Exceptions thrown

    AssertionError if the passed value is not negative

11.  final def eq(arg0: AnyRef): Boolean

    Definition Classes

    AnyRef

12.  def equals(arg0: Any): Boolean

    Definition Classes

    AnyRef → Any

13.  def finalize(): Unit

    Attributes

    protected[java.lang]

    Definition Classes

    AnyRef

    Annotations

    @throws( classOf[java.lang.Throwable] )

14.  def from(value: Double): Option[NegDouble]

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

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

    This method will inspect the passed Double value and if it is a negative Double, it will return a NegDouble representing that value, wrapped in a Some. Otherwise, the passed Double value is not 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 negative, return wrapped in a Some[NegDouble].

    returns

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

15.  def fromOrElse(value: Double, default: ⇒ NegDouble): NegDouble

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

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

    This method will inspect the passed Double value and if it is a negative Double, it will return a NegDouble 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 negative, return.

    default

    the NegDouble to return if the passed Double value is not negative.

    returns

    the specified Double value wrapped in a NegDouble, if it is negative, else the default NegDouble value.

16.  final def getClass(): Class[_]

    Definition Classes

    AnyRef → Any

17.  def goodOrElse[B](value: Double)(f: (Double) ⇒ B): Or[NegDouble, B]

    A factory/validation method that produces a NegDouble, 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 NegDouble, 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 negative Double, it will return a NegDouble representing that value, wrapped in a Good. Otherwise, the passed Double value is not 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 negative, return wrapped in a Good(NegDouble).

    returns

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

18.  def hashCode(): Int

    Definition Classes

    AnyRef → Any

19.  final def isInstanceOf[T0]: Boolean

    Definition Classes

    Any

20.  def isValid(value: Double): Boolean

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

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

    value

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

    returns

    true if the specified Double is positive, else false.

21.  final def ne(arg0: AnyRef): Boolean

    Definition Classes

    AnyRef

22.  final def notify(): Unit

    Definition Classes

    AnyRef

23.  final def notifyAll(): Unit

    Definition Classes

    AnyRef

24.  implicit val ordering: Ordering[NegDouble]

    Implicit Ordering instance.

25.  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 negative Double, it will return a Pass. Otherwise, the passed Double value is 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 negative.

    returns

    a Pass if the specified Int value is negative, else a Fail containing an error value produced by passing the specified Double to the given function f.

26.  def rightOrElse[L](value: Double)(f: (Double) ⇒ L): Either[L, NegDouble]

    A factory/validation method that produces a NegDouble, 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 NegDouble, 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 negative Double, it will return a NegDouble representing that value, wrapped in a Right. Otherwise, the passed Double value is not 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 negative, return wrapped in a Right(NegDouble).

    returns

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

27.  def sumOf(first: NegDouble, second: NegZDouble, rest: NegZDouble*): NegDouble

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

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

    This method will always succeed (not throw an exception) because adding a negative Double and one or more non-positive Doubles will always result in another 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.

28.  def sumOf(x: NegDouble, y: NegZDouble): NegDouble

    Returns the NegDouble sum of the passed NegDouble value x and NegZDouble value y.

    Returns the NegDouble sum of the passed NegDouble value x and NegZDouble value y.

    This method will always succeed (not throw an exception) because adding a negative Double and non-positive Double will always result in another negative 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 NegZDouble 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.  def tryingValid(value: Double): Try[NegDouble]

    A factory/validation method that produces a NegDouble, 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 NegDouble, 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 negative Float, it will return a NegDouble representing that value, wrapped in a Success. Otherwise, the passed Float value is not 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 negative, return wrapped in a Success(NegDouble).

    returns

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

32.  final def wait(): Unit

    Definition Classes

    AnyRef

    Annotations

    @throws( ... )

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

    Definition Classes

    AnyRef

    Annotations

    @throws( ... )

34.  final def wait(arg0: Long): Unit

    Definition Classes

    AnyRef

    Annotations

    @throws( ... )

35.  implicit def widenToDouble(pos: NegDouble): Double

    Implicit widening conversion from NegDouble to Double.

    Implicit widening conversion from NegDouble to Double.

    pos

    the NegDouble to widen

    returns

    the Double value underlying the specified NegDouble

36.  implicit def widenToNegZDouble(pos: NegDouble): NegZDouble

    Implicit widening conversion from NegDouble to NegZDouble.

    Implicit widening conversion from NegDouble to NegZDouble.

    pos

    the NegDouble to widen

    returns

    the Double value underlying the specified NegDouble, widened to Double and wrapped in a NegZDouble.

37.  implicit def widenToNonZeroDouble(pos: NegDouble): NonZeroDouble

    Implicit widening conversion from NegDouble to NonZeroDouble.

    Implicit widening conversion from NegDouble to NonZeroDouble.

    pos

    the NegDouble to widen

    returns

    the Double value underlying the specified NegDouble, widened to Double and wrapped in a NonZeroDouble.