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

   The largest value representable as a non-zero Float, which is NonZeroFloat(3.4028235E38).

5.  final val MinPositiveValue: NonZeroFloat
6.  final val MinValue: NonZeroFloat

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

7.  final val NegativeInfinity: NonZeroFloat

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

8.  final val PositiveInfinity: NonZeroFloat

   The positive infinity value, which is NonZeroFloat.ensuringValid(Float.PositiveInfinity).

9.  implicit macro def apply(value: Float): NonZeroFloat

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

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

   returns

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

10.  final def asInstanceOf[T0]: T0

    Definition Classes

    Any

11.  def clone(): AnyRef

    Attributes

    protected[java.lang]

    Definition Classes

    AnyRef

    Annotations

    @throws( ... )

12.  def ensuringValid(value: Float): NonZeroFloat

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

    A factory/assertion method that produces a NonZeroFloat 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-zero Float, it will return a NonZeroFloat representing that value. Otherwise, the passed Float value is not non-zero, 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-zero, return wrapped in a NonZeroFloat.

    returns

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

    Exceptions thrown

    AssertionError if the passed value is not non-zero

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

    Definition Classes

    AnyRef

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

    Definition Classes

    AnyRef → Any

15.  def finalize(): Unit

    Attributes

    protected[java.lang]

    Definition Classes

    AnyRef

    Annotations

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

16.  def from(value: Float): Option[NonZeroFloat]

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

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

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

    returns

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

17.  def fromOrElse(value: Float, default: ⇒ NonZeroFloat): NonZeroFloat

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

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

    This method will inspect the passed Float value and if it is a non-zero Float, it will return a NonZeroFloat representing that value. Otherwise, the passed Float value is not non-zero, 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-zero, return.

    default

    the NonZeroFloat to return if the passed Float value is not non-zero.

    returns

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

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

    Definition Classes

    AnyRef → Any

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

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

    returns

    the specified Float value wrapped in a Good(NonZeroFloat), if it is non-zero, else a Bad(f(value)).

20.  def hashCode(): Int

    Definition Classes

    AnyRef → Any

21.  final def isInstanceOf[T0]: Boolean

    Definition Classes

    Any

22.  def isValid(value: Float): Boolean

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

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

    value

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

    returns

    true if the specified Float is non-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 ordering: Ordering[NonZeroFloat]

    Implicit Ordering instance.

27.  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-zero Float, it will return a Pass. Otherwise, the passed Float value is non-zero, 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-zero.

    returns

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

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

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

    returns

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

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[NonZeroFloat]

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

    returns

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

    Implicit widening conversion from NonZeroFloat to Double.

    Implicit widening conversion from NonZeroFloat to Double.

    pos

    the NonZeroFloat to widen

    returns

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

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

    Implicit widening conversion from NonZeroFloat to Float.

    Implicit widening conversion from NonZeroFloat to Float.

    pos

    the NonZeroFloat to widen

    returns

    the Float value underlying the specified NonZeroFloat

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

    Implicit widening conversion from NonZeroFloat to NonZeroDouble.

    Implicit widening conversion from NonZeroFloat to NonZeroDouble.

    pos

    the NonZeroFloat to widen

    returns

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