object FiniteFloat

The companion object for FiniteFloat that offers factory methods that produce FiniteFloats, implicit widening conversions from FiniteFloat to other numeric types, and maximum and minimum constant values for FiniteFloat.

Source
FiniteFloat.scala
Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. FiniteFloat
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

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

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

  5. final val MinPositiveValue: FiniteFloat

    The smallest positive value greater than 0.0d representable as a FiniteFloat, which is FiniteFloat(1.4E-45).

  6. final val MinValue: FiniteFloat

    The smallest value representable as a finite Float, which is FiniteFloat(-3.4028235E38).

  7. implicit macro def apply(value: Float): FiniteFloat

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

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

    returns

    the specified, valid Float literal value wrapped in a FiniteFloat. (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[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  10. def ensuringValid(value: Float): FiniteFloat

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

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

    returns

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

    Exceptions thrown

    AssertionError if the passed value is not finite

  11. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  12. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  13. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  14. def from(value: Float): Option[FiniteFloat]

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

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

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

    returns

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

  15. def fromOrElse(value: Float, default: => FiniteFloat): FiniteFloat

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

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

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

    default

    the FiniteFloat to return if the passed Float value is not finite.

    returns

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

  16. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  17. def goodOrElse[B](value: Float)(f: (Float) => B): Or[FiniteFloat, B]

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

    returns

    the specified Float value wrapped in a Good(FiniteFloat), if it is finite, else a Bad(f(value)).

  18. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  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.

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

    value

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

    returns

    true if the specified Float is finite, else false.

  21. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  22. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  23. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  24. implicit val ordering: Ordering[FiniteFloat]

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

    returns

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

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

    returns

    the specified Int value wrapped in a Right(FiniteFloat), if it is finite, 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[FiniteFloat]

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

    returns

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

  30. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  31. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  32. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  33. implicit def widenToDouble(pos: FiniteFloat): Double

    Implicit widening conversion from FiniteFloat to Double.

    Implicit widening conversion from FiniteFloat to Double.

    pos

    the FiniteFloat to widen

    returns

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

  34. implicit def widenToFiniteDouble(pos: FiniteFloat): FiniteDouble

    Implicit widening conversion from FiniteFloat to FiniteDouble.

    Implicit widening conversion from FiniteFloat to FiniteDouble.

    pos

    the FiniteFloat to widen

    returns

    the Float value underlying the specified FiniteFloat, widened to Double and wrapped in a FiniteDouble.

  35. implicit def widenToFloat(pos: FiniteFloat): Float

    Implicit widening conversion from FiniteFloat to Float.

    Implicit widening conversion from FiniteFloat to Float.

    pos

    the FiniteFloat to widen

    returns

    the Float value underlying the specified FiniteFloat

Inherited from AnyRef

Inherited from Any

Ungrouped