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

   The largest value representable as a finite positive Float, which is PosFiniteFloat(3.4028235E38).

   The largest value representable as a finite positive Float, which is PosFiniteFloat(3.4028235E38).

5.  final val MinPositiveValue: PosFloat
6.  final val MinValue: PosFiniteFloat

   The smallest value representable as a finite positive Float, which is PosFiniteFloat(1.4E-45).

   The smallest value representable as a finite positive Float, which is PosFiniteFloat(1.4E-45).

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

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

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

   returns

   the specified, valid Float literal value wrapped in a PosFiniteFloat. (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): PosFiniteFloat

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

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

    returns

    the specified Float value wrapped in a PosFiniteFloat, if it is finite positive, else throws AssertionError.

    Exceptions thrown

    AssertionError if the passed value is not finite 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[PosFiniteFloat]

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

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

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

    returns

    the specified Float value wrapped in a Some[PosFiniteFloat], if it is finite positive, else None.

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

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

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

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

    default

    the PosFiniteFloat to return if the passed Float value is not finite positive.

    returns

    the specified Float value wrapped in a PosFiniteFloat, if it is finite positive, else the default PosFiniteFloat value.

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

    Definition Classes

    AnyRef → Any

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

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

    returns

    the specified Float value wrapped in a Good(PosFiniteFloat), if it is finite 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 finite positive.

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

    value

    the Float to inspect, and if finite positive, return true.

    returns

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

    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 finite positive Float, it will return a Pass. Otherwise, the passed Float value is finite 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 finite positive.

    returns

    a Pass if the specified Float value is finite 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, PosFiniteFloat]

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

    returns

    the specified Int value wrapped in a Right(PosFiniteFloat), if it is finite positive, else a Left(f(value)).

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

    Definition Classes

    AnyRef

28.  def toString(): String

    Definition Classes

    AnyRef → Any

29.  def tryingValid(value: Float): Try[PosFiniteFloat]

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

    returns

    the specified Float value wrapped in a Success(PosFiniteFloat), if it is finite positive, else a Failure(AssertionError).

30.  final def wait(): Unit

    Definition Classes

    AnyRef

    Annotations

    @throws( ... )

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

    Definition Classes

    AnyRef

    Annotations

    @throws( ... )

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

    Definition Classes

    AnyRef

    Annotations

    @throws( ... )

33.  implicit def widenToDouble(pos: PosFiniteFloat): Double

    Implicit widening conversion from PosFiniteFloat to Double.

    Implicit widening conversion from PosFiniteFloat to Double.

    pos

    the PosFiniteFloat to widen

    returns

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

34.  implicit def widenToFloat(pos: PosFiniteFloat): Float

    Implicit widening conversion from PosFiniteFloat to Float.

    Implicit widening conversion from PosFiniteFloat to Float.

    pos

    the PosFiniteFloat to widen

    returns

    the Float value underlying the specified PosFiniteFloat

35.  implicit def widenToNonZeroDouble(pos: PosFiniteFloat): NonZeroDouble

    Implicit widening conversion from PosFiniteFloat to NonZeroDouble.

    Implicit widening conversion from PosFiniteFloat to NonZeroDouble.

    pos

    the PosFiniteFloat to widen

    returns

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

36.  implicit def widenToNonZeroFloat(pos: PosFiniteFloat): NonZeroFloat

    Implicit widening conversion from PosFiniteFloat to NonZeroFloat.

    Implicit widening conversion from PosFiniteFloat to NonZeroFloat.

    pos

    the PosFiniteFloat to widen

    returns

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

37.  implicit def widenToPosDouble(pos: PosFiniteFloat): PosDouble

    Implicit widening conversion from PosFiniteFloat to PosDouble.

    Implicit widening conversion from PosFiniteFloat to PosDouble.

    pos

    the PosFiniteFloat to widen

    returns

    the Float value underlying the specified PosFiniteFloat, widened to Double and wrapped in a PosDouble.

38.  implicit def widenToPosFiniteDouble(pos: PosFiniteFloat): PosFiniteDouble

    Implicit widening conversion from PosFiniteFloat to PosFiniteDouble.

    Implicit widening conversion from PosFiniteFloat to PosFiniteDouble.

    pos

    the PosFiniteFloat to widen

    returns

    the Float value underlying the specified PosFiniteFloat, widened to Double and wrapped in a PosFiniteDouble.

39.  implicit def widenToPosZDouble(pos: PosFiniteFloat): PosZDouble

    Implicit widening conversion from PosFiniteFloat to PosZDouble.

    Implicit widening conversion from PosFiniteFloat to PosZDouble.

    pos

    the PosFiniteFloat to widen

    returns

    the Float value underlying the specified PosFiniteFloat, widened to Double and wrapped in a PosZDouble.

40.  implicit def widenToPosZFiniteDouble(pos: PosFiniteFloat): PosZFiniteDouble

    Implicit widening conversion from PosFiniteFloat to PosZFiniteDouble.

    Implicit widening conversion from PosFiniteFloat to PosZFiniteDouble.

    pos

    the PosFiniteFloat to widen

    returns

    the Float value underlying the specified PosFiniteFloat, widened to Double and wrapped in a PosZFiniteDouble.

41.  implicit def widenToPosZFiniteFloat(pos: PosFiniteFloat): PosZFiniteFloat

    Implicit widening conversion from PosFiniteFloat to PosZFiniteFloat.

    Implicit widening conversion from PosFiniteFloat to PosZFiniteFloat.

    pos

    the PosFiniteFloat to widen

    returns

    the Float value underlying the specified PosFiniteFloat, widened to Float and wrapped in a PosZFiniteFloat.

42.  implicit def widenToPosZFloat(pos: PosFiniteFloat): PosZFloat

    Implicit widening conversion from PosFiniteFloat to PosZFloat.

    Implicit widening conversion from PosFiniteFloat to PosZFloat.

    pos

    the PosFiniteFloat to widen

    returns

    the Float value underlying the specified PosFiniteFloat, widened to Float and wrapped in a PosZFloat.