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: NegZFloat

   The largest value representable as a non-positive Float, which is NegZFloat(0.0f).

5.  final val MinValue: NegZFloat

   The smallest value representable as a non-positive Float, which is NegZFloat(-3.4028235E38).

6.  final val NegativeInfinity: NegZFloat

   The negative infinity value, which is NegZFloat.ensuringValid(Float.NegativeInfinity).

7.  implicit macro def apply(value: Float): NegZFloat

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

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

   The macro that implements this method will inspect the specified Float expression at compile time. If the expression is a non-positive Float literal, it will return a NegZFloat representing that value. Otherwise, the passed Float expression is either a literal that is not non-positive, 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 Float literals at compile time, whereas from inspects Float values at run time.

   value

   the Float literal expression to inspect at compile time, and if non-positive, to return wrapped in a NegZFloat at run time.

   returns

   the specified, valid Float literal value wrapped in a NegZFloat. (If the specified expression is not a valid Float 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: Float): NegZFloat

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

    A factory/assertion method that produces a NegZFloat given a valid Float value, or throws AssertionError, if given an invalid Float 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 Float value and if it is a non-positive Float, it will return a NegZFloat representing that value. Otherwise, the passed Float value is not non-positive, 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 Float literals at compile time, whereas from inspects Float 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 Float is positive.

    value

    the Float to inspect, and if non-positive, return wrapped in a NegZFloat.

    returns

    the specified Float value wrapped in a NegZFloat, if it is non-positive, else throws AssertionError.

    Exceptions thrown

    AssertionError if the passed value is not non-positive

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: Float): Option[NegZFloat]

    A factory method that produces an Option[NegZFloat] given a Float value.

    A factory method that produces an Option[NegZFloat] given a Float value.

    This method will inspect the passed Float value and if it is a non-positive Float, it will return a NegZFloat representing that value wrapped in a Some. Otherwise, the passed Float value is not non-positive, 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 Float literals at compile time, whereas from inspects Float values at run time.

    value

    the Float to inspect, and if non-positive, return wrapped in a Some[NegZFloat].

    returns

    the specified Float value wrapped in a Some[NegZFloat], if it is non-positive, else None.

15.  def fromOrElse(value: Float, default: ⇒ NegZFloat): NegZFloat

    A factory method that produces a NegZFloat given a Float value and a default NegZFloat.

    A factory method that produces a NegZFloat given a Float value and a default NegZFloat.

    This method will inspect the passed Float value and if it is a non-positive Float, it will return a NegZFloat representing that value. Otherwise, the passed Float value is not non-positive, 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 Float literals at compile time, whereas from inspects Float values at run time.

    value

    the Float to inspect, and if non-positive, return.

    default

    the NegZFloat to return if the passed Float value is not non-positive.

    returns

    the specified Float value wrapped in a NegZFloat, if it is non-positive, else the default NegZFloat value.

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

    Definition Classes

    AnyRef → Any

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

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

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

    This method will inspect the passed Float value and if it is a non-positive Float, it will return a NegZFloat representing that value, wrapped in a Good. Otherwise, the passed Float value is not non-positive, so this method will return a result of type B obtained by passing the invalid Float 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 Float literals at compile time, whereas this method inspects Float values at run time.

    value

    the Float to inspect, and if non-positive, return wrapped in a Good(NegZFloat).

    returns

    the specified Float value wrapped in a Good(NegZFloat), if it is non-positive, 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: Float): Boolean

    A predicate method that returns true if a given Float value is non-positive.

    A predicate method that returns true if a given Float value is non-positive.

    value

    the Float to inspect, and if non-positive, return true.

    returns

    true if the specified Float is non-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[NegZFloat]

    Implicit Ordering instance.

25.  def passOrElse[E](value: Float)(f: (Float) ⇒ E): Validation[E]

    A validation method that produces a Pass given a valid Float 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 Float 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 Float value and if it is a non-positive Float, it will return a Pass. Otherwise, the passed Float value is non-positive, so this method will return a result of type E obtained by passing the invalid Float 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 Float literals at compile time, whereas this method inspects Float values at run time.

    value

    the Float to validate that it is non-positive.

    returns

    a Pass if the specified Float value is non-positive, else a Fail containing an error value produced by passing the specified Float to the given function f.

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

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

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

    This method will inspect the passed Int value and if it is a non-positive Int, it will return a NegZFloat representing that value, wrapped in a Right. Otherwise, the passed Int value is not non-positive, so this method will return a result of type L obtained by passing the invalid Int 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 Int literals at compile time, whereas this method inspects Int values at run time.

    value

    the Int to inspect, and if non-positive, return wrapped in a Right(NegZFloat).

    returns

    the specified Int value wrapped in a Right(NegZFloat), if it is non-positive, else a Left(f(value)).

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

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

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

    This method will always succeed (not throw an exception) because adding a non-positive Float to another non-positive Float will always result in another non-positive Float 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: NegZFloat, y: NegZFloat): NegZFloat

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

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

    This method will always succeed (not throw an exception) because adding a non-positive Float to another non-positive Float will always result in another NegZFloat Float 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 NegZFloat 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: Float): Try[NegZFloat]

    A factory/validation method that produces a NegZFloat, 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 NegZFloat, wrapped in a Success, given a valid Float value, or if the given Float is invalid, an AssertionError, wrapped in a Failure.

    This method will inspect the passed Float value and if it is a non-positive Float, it will return a NegZFloat representing that value, wrapped in a Success. Otherwise, the passed Float value is not non-positive, 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-positive, return wrapped in a Success(NegZFloat).

    returns

    the specified Float value wrapped in a Success(NegZFloat), if it is non-positive, 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: NegZFloat): Double

    Implicit widening conversion from NegZFloat to Double.

    Implicit widening conversion from NegZFloat to Double.

    pos

    the NegZFloat to widen

    returns

    the Float value underlying the specified NegZFloat, widened to Double.

36.  implicit def widenToFloat(pos: NegZFloat): Float

    Implicit widening conversion from NegZFloat to Float.

    Implicit widening conversion from NegZFloat to Float.

    pos

    the NegZFloat to widen

    returns

    the Float value underlying the specified NegZFloat

37.  implicit def widenToNegZDouble(pos: NegZFloat): NegZDouble

    Implicit widening conversion from NegZFloat to NegZDouble.

    Implicit widening conversion from NegZFloat to NegZDouble.

    pos

    the NegZFloat to widen

    returns

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