object PosFloat

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

Source
PosFloat.scala
Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. PosFloat
  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: PosFloat

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

  5. final val MinPositiveValue: PosFloat

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

  6. final val MinValue: PosFloat

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

  7. final val PositiveInfinity: PosFloat

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

  8. implicit macro def apply(value: Float): PosFloat

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

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

    returns

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

  9. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  10. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  11. def ensuringValid(value: Float): PosFloat

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

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

    returns

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

    Exceptions thrown

    AssertionError if the passed value is not positive

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

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

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

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

    returns

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

  16. def fromOrElse(value: Float, default: => PosFloat): PosFloat

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

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

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

    default

    the PosFloat to return if the passed Float value is not positive.

    returns

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

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

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

    returns

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

  19. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  20. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  21. def isValid(value: Float): Boolean

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

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

    value

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

    returns

    true if the specified Float is positive, else false.

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

    Implicit Ordering instance.

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

    returns

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

  27. def rightOrElse[L](value: Float)(f: (Float) => L): Either[L, PosFloat]

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

    returns

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

  28. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  29. def toString(): String
    Definition Classes
    AnyRef → Any
  30. def tryingValid(value: Float): Try[PosFloat]

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

    returns

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

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

    Implicit widening conversion from PosFloat to Double.

    Implicit widening conversion from PosFloat to Double.

    pos

    the PosFloat to widen

    returns

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

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

    Implicit widening conversion from PosFloat to Float.

    Implicit widening conversion from PosFloat to Float.

    pos

    the PosFloat to widen

    returns

    the Float value underlying the specified PosFloat

  36. implicit def widenToNonZeroDouble(pos: PosFloat): NonZeroDouble

    Implicit widening conversion from PosFloat to NonZeroDouble.

    Implicit widening conversion from PosFloat to NonZeroDouble.

    pos

    the PosFloat to widen

    returns

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

  37. implicit def widenToNonZeroFloat(pos: PosFloat): NonZeroFloat

    Implicit widening conversion from PosFloat to NonZeroFloat.

    Implicit widening conversion from PosFloat to NonZeroFloat.

    pos

    the PosFloat to widen

    returns

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

  38. implicit def widenToPosDouble(pos: PosFloat): PosDouble

    Implicit widening conversion from PosFloat to PosDouble.

    Implicit widening conversion from PosFloat to PosDouble.

    pos

    the PosFloat to widen

    returns

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

  39. implicit def widenToPosZDouble(pos: PosFloat): PosZDouble

    Implicit widening conversion from PosFloat to PosZDouble.

    Implicit widening conversion from PosFloat to PosZDouble.

    pos

    the PosFloat to widen

    returns

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

  40. implicit def widenToPosZFloat(pos: PosFloat): PosZFloat

    Implicit widening conversion from PosFloat to PosZFloat.

    Implicit widening conversion from PosFloat to PosZFloat.

    pos

    the PosFloat to widen

    returns

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

Deprecated Value Members

  1. val posFloatOrd: Ordering[PosFloat]

    The formerly implicit posFloatOrd field has been deprecated and will be removed in a future version of ScalaTest. Please use the ordering field instead.

    The formerly implicit posFloatOrd field has been deprecated and will be removed in a future version of ScalaTest. Please use the ordering field instead.

    Annotations
    @deprecated
    Deprecated

    The formerly implicit posFloatOrd field has been deprecated and will be removed in a future version of ScalaTest. Please use the ordering field instead.

Inherited from AnyRef

Inherited from Any

Ungrouped