final class PosFiniteFloat extends AnyVal

An AnyVal for finite positive Floats.

Note: a PosFiniteFloat may not equal 0.0. If you want positive number or 0, use PosZFiniteFloat.

Because PosFiniteFloat is an AnyVal it will usually be as efficient as an Float, being boxed only when an Float would have been boxed.

The PosFiniteFloat.apply factory method is implemented in terms of a macro that checks literals for validity at compile time. Calling PosFiniteFloat.apply with a literal Float value will either produce a valid PosFiniteFloat instance at run time or an error at compile time. Here's an example:

scala> import anyvals._
import anyvals._

scala> PosFiniteFloat(42.1fF)
res0: org.scalactic.anyvals.PosFiniteFloat = PosFiniteFloat(42.1f)

scala> PosFiniteFloat(0.0fF)
<console>:14: error: PosFiniteFloat.apply can only be invoked on a finite positive (i > 0.0f && i != Float.PositiveInfinity) floating point literal, like PosFiniteFloat(42.1fF).
              PosFiniteFloat(42.1fF)
                      ^

PosFiniteFloat.apply cannot be used if the value being passed is a variable (i.e., not a literal), because the macro cannot determine the validity of variables at compile time (just literals). If you try to pass a variable to PosFiniteFloat.apply, you'll get a compiler error that suggests you use a different factor method, PosFiniteFloat.from, instead:

scala> val x = 42.1fF
x: Float = 42.1f

scala> PosFiniteFloat(x)
<console>:15: error: PosFiniteFloat.apply can only be invoked on a floating point literal, like PosFiniteFloat(42.1fF). Please use PosFiniteFloat.from instead.
              PosFiniteFloat(x)
                      ^

The PosFiniteFloat.from factory method will inspect the value at runtime and return an Option[PosFiniteFloat]. If the value is valid, PosFiniteFloat.from will return a Some[PosFiniteFloat], else it will return a None. Here's an example:

scala> PosFiniteFloat.from(x)
res3: Option[org.scalactic.anyvals.PosFiniteFloat] = Some(PosFiniteFloat(42.1f))

scala> val y = 0.0fF
y: Float = 0.0f

scala> PosFiniteFloat.from(y)
res4: Option[org.scalactic.anyvals.PosFiniteFloat] = None

The PosFiniteFloat.apply factory method is marked implicit, so that you can pass literal Floats into methods that require PosFiniteFloat, and get the same compile-time checking you get when calling PosFiniteFloat.apply explicitly. Here's an example:

scala> def invert(pos: PosFiniteFloat): Float = Float.MaxValue - pos
invert: (pos: org.scalactic.anyvals.PosFiniteFloat)Float

scala> invert(42.1fF)
res5: Float = 3.4028235E38

scala> invert(Float.MaxValue)
res6: Float = 0.0

scala> invert(0.0fF)
<console>:15: error: PosFiniteFloat.apply can only be invoked on a finite positive (i > 0.0f && i != Float.PositiveInfinity) floating point literal, like PosFiniteFloat(42.1fF).
              invert(0.0F)
                     ^

scala> invert(0.0fF)
<console>:15: error: PosFiniteFloat.apply can only be invoked on a finite positive (i > 0.0f && i != Float.PositiveInfinity) floating point literal, like PosFiniteFloat(42.1fF).
              invert(0.0fF)
                      ^

This example also demonstrates that the PosFiniteFloat companion object also defines implicit widening conversions when no loss of precision will occur. This makes it convenient to use a PosFiniteFloat where a Float or wider type is needed. An example is the subtraction in the body of the invert method defined above, Float.MaxValue - pos. Although Float.MaxValue is a Float, which has no - method that takes a PosFiniteFloat (the type of pos), you can still subtract pos, because the PosFiniteFloat will be implicitly widened to Float.

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

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    Any
  2. final def ##(): Int
    Definition Classes
    Any
  3. def %(x: Double): Double

    Returns the remainder of the division of this value by x.

  4. def %(x: Float): Float

    Returns the remainder of the division of this value by x.

  5. def %(x: Long): Float

    Returns the remainder of the division of this value by x.

  6. def %(x: Int): Float

    Returns the remainder of the division of this value by x.

  7. def %(x: Char): Float

    Returns the remainder of the division of this value by x.

  8. def %(x: Short): Float

    Returns the remainder of the division of this value by x.

  9. def %(x: Byte): Float

    Returns the remainder of the division of this value by x.

  10. def *(x: Double): Double

    Returns the product of this value and x.

  11. def *(x: Float): Float

    Returns the product of this value and x.

  12. def *(x: Long): Float

    Returns the product of this value and x.

  13. def *(x: Int): Float

    Returns the product of this value and x.

  14. def *(x: Char): Float

    Returns the product of this value and x.

  15. def *(x: Short): Float

    Returns the product of this value and x.

  16. def *(x: Byte): Float

    Returns the product of this value and x.

  17. def +(x: Double): Double

    Returns the sum of this value and x.

  18. def +(x: Float): Float

    Returns the sum of this value and x.

  19. def +(x: Long): Float

    Returns the sum of this value and x.

  20. def +(x: Int): Float

    Returns the sum of this value and x.

  21. def +(x: Char): Float

    Returns the sum of this value and x.

  22. def +(x: Short): Float

    Returns the sum of this value and x.

  23. def +(x: Byte): Float

    Returns the sum of this value and x.

  24. def +(x: String): String

    Converts this PosFiniteFloat's value to a string then concatenates the given string.

    Converts this PosFiniteFloat's value to a string then concatenates the given string.

  25. def -(x: Double): Double

    Returns the difference of this value and x.

  26. def -(x: Float): Float

    Returns the difference of this value and x.

  27. def -(x: Long): Float

    Returns the difference of this value and x.

  28. def -(x: Int): Float

    Returns the difference of this value and x.

  29. def -(x: Char): Float

    Returns the difference of this value and x.

  30. def -(x: Short): Float

    Returns the difference of this value and x.

  31. def -(x: Byte): Float

    Returns the difference of this value and x.

  32. def /(x: Double): Double

    Returns the quotient of this value and x.

  33. def /(x: Float): Float

    Returns the quotient of this value and x.

  34. def /(x: Long): Float

    Returns the quotient of this value and x.

  35. def /(x: Int): Float

    Returns the quotient of this value and x.

  36. def /(x: Char): Float

    Returns the quotient of this value and x.

  37. def /(x: Short): Float

    Returns the quotient of this value and x.

  38. def /(x: Byte): Float

    Returns the quotient of this value and x.

  39. def <(x: Double): Boolean

    Returns true if this value is less than x, false otherwise.

  40. def <(x: Float): Boolean

    Returns true if this value is less than x, false otherwise.

  41. def <(x: Long): Boolean

    Returns true if this value is less than x, false otherwise.

  42. def <(x: Int): Boolean

    Returns true if this value is less than x, false otherwise.

  43. def <(x: Char): Boolean

    Returns true if this value is less than x, false otherwise.

  44. def <(x: Short): Boolean

    Returns true if this value is less than x, false otherwise.

  45. def <(x: Byte): Boolean

    Returns true if this value is less than x, false otherwise.

  46. def <=(x: Double): Boolean

    Returns true if this value is less than or equal to x, false otherwise.

  47. def <=(x: Float): Boolean

    Returns true if this value is less than or equal to x, false otherwise.

  48. def <=(x: Long): Boolean

    Returns true if this value is less than or equal to x, false otherwise.

  49. def <=(x: Int): Boolean

    Returns true if this value is less than or equal to x, false otherwise.

  50. def <=(x: Char): Boolean

    Returns true if this value is less than or equal to x, false otherwise.

  51. def <=(x: Short): Boolean

    Returns true if this value is less than or equal to x, false otherwise.

  52. def <=(x: Byte): Boolean

    Returns true if this value is less than or equal to x, false otherwise.

  53. final def ==(arg0: Any): Boolean
    Definition Classes
    Any
  54. def >(x: Double): Boolean

    Returns true if this value is greater than x, false otherwise.

  55. def >(x: Float): Boolean

    Returns true if this value is greater than x, false otherwise.

  56. def >(x: Long): Boolean

    Returns true if this value is greater than x, false otherwise.

  57. def >(x: Int): Boolean

    Returns true if this value is greater than x, false otherwise.

  58. def >(x: Char): Boolean

    Returns true if this value is greater than x, false otherwise.

  59. def >(x: Short): Boolean

    Returns true if this value is greater than x, false otherwise.

  60. def >(x: Byte): Boolean

    Returns true if this value is greater than x, false otherwise.

  61. def >=(x: Double): Boolean

    Returns true if this value is greater than or equal to x, false otherwise.

  62. def >=(x: Float): Boolean

    Returns true if this value is greater than or equal to x, false otherwise.

  63. def >=(x: Long): Boolean

    Returns true if this value is greater than or equal to x, false otherwise.

  64. def >=(x: Int): Boolean

    Returns true if this value is greater than or equal to x, false otherwise.

  65. def >=(x: Char): Boolean

    Returns true if this value is greater than or equal to x, false otherwise.

  66. def >=(x: Short): Boolean

    Returns true if this value is greater than or equal to x, false otherwise.

  67. def >=(x: Byte): Boolean

    Returns true if this value is greater than or equal to x, false otherwise.

  68. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  69. def ceil: PosFiniteFloat

    Returns the smallest (closest to 0) PosFiniteFloat that is greater than or equal to this PosFiniteFloat and represents a mathematical integer.

  70. def ensuringValid(f: (Float) ⇒ Float): PosFiniteFloat

    Applies the passed Float => Float function to the underlying Float value, and if the result is positive, returns the result wrapped in a PosFiniteFloat, else throws AssertionError.

    Applies the passed Float => Float function to the underlying Float value, and if the result is positive, returns the result wrapped in a PosFiniteFloat, else throws AssertionError.

    This method will inspect the result of applying the given function to this PosFiniteFloat's underlying Float value and if the result is finite positive, it will return a PosFiniteFloat representing that value. Otherwise, the Float value returned by the given function is not finite positive, so this method will throw AssertionError.

    This method 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 an Float is finite positive. With this method, you are asserting that you are convinced the result of the computation represented by applying the given function to this PosFiniteFloat's value will not produce invalid value. Instead of producing such invalid values, this method will throw AssertionError.

    f

    the Float => Float function to apply to this PosFiniteFloat's underlying Float value.

    returns

    the result of applying this PosFiniteFloat's underlying Float value to to the passed function, wrapped in a PosFiniteFloat if it is finite positive (else throws AssertionError).

    Exceptions thrown

    AssertionError if the result of applying this PosFiniteFloat's underlying Float value to to the passed function is not finite positive.

  71. def floor: PosFiniteFloat

    Returns the greatest (closest to infinity) PosFiniteFloat that is less than or equal to this PosFiniteFloat and represents a mathematical integer.

  72. def getClass(): Class[_ <: AnyVal]
    Definition Classes
    AnyVal → Any
  73. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  74. def isWhole: Boolean

    Indicates whether this PosFiniteFloat has a value that is a whole number: it is finite and it has no fraction part.

  75. def max(that: PosFiniteFloat): PosFiniteFloat

    Returns this if this > that or that otherwise.

    Returns this if this > that or that otherwise.

  76. def min(that: PosFiniteFloat): PosFiniteFloat

    Returns this if this < that or that otherwise.

    Returns this if this < that or that otherwise.

  77. def round: PosFiniteFloat

    Rounds this PosFiniteFloat value to the nearest whole number value that can be expressed as an Float, returning the result as a PosFiniteFloat.

  78. def to(end: Float, step: Float): Inclusive[Float]

    Create an inclusive Range from this PosFiniteFloat value to the specified end with the specified step value.

    Create an inclusive Range from this PosFiniteFloat value to the specified end with the specified step value.

    end

    The final bound of the range to make.

    step

    The number to increase by for each step of the range.

    returns

    A scala.collection.immutable.NumericRange.Inclusive[Float] from this up to and including end.

  79. def to(end: Float): Partial[Float, NumericRange[Float]]

    Create an inclusive Range from this PosFiniteFloat value to the specified end with step value 1.

    Create an inclusive Range from this PosFiniteFloat value to the specified end with step value 1.

    end

    The final bound of the range to make.

    returns

    A NumericRange[Float] from this up to and including end.

  80. def toByte: Byte

    Converts this PosFiniteFloat to a Byte.

    Converts this PosFiniteFloat to a Byte.

  81. def toChar: Char

    Converts this PosFiniteFloat to a Char.

    Converts this PosFiniteFloat to a Char.

  82. def toDegrees: Float

    Converts an angle measured in radians to an approximately equivalent angle measured in degrees.

    Converts an angle measured in radians to an approximately equivalent angle measured in degrees.

    returns

    the measurement of the angle x in degrees.

  83. def toDouble: Double

    Converts this PosFiniteFloat to a Double.

    Converts this PosFiniteFloat to a Double.

  84. def toFloat: Float

    Converts this PosFiniteFloat to a Float.

    Converts this PosFiniteFloat to a Float.

  85. def toInt: Int

    Converts this PosFiniteFloat to an Int.

    Converts this PosFiniteFloat to an Int.

  86. def toLong: Long

    Converts this PosFiniteFloat to a Long.

    Converts this PosFiniteFloat to a Long.

  87. def toRadians: Float

    Converts an angle measured in degrees to an approximately equivalent angle measured in radians.

    Converts an angle measured in degrees to an approximately equivalent angle measured in radians.

    returns

    the measurement of the angle x in radians.

  88. def toShort: Short

    Converts this PosFiniteFloat to a Short.

    Converts this PosFiniteFloat to a Short.

  89. def toString(): String

    A string representation of this PosFiniteFloat.

    A string representation of this PosFiniteFloat.

    Definition Classes
    PosFiniteFloat → Any
  90. def unary_+: PosFiniteFloat

    Returns this value, unmodified.

  91. def unary_-: Float

    Returns the negation of this value.

  92. def until(end: Float, step: Float): Exclusive[Float]

    Create a Range (exclusive) from this PosFiniteFloat value until the specified end (exclusive) with the specified step value.

    Create a Range (exclusive) from this PosFiniteFloat value until the specified end (exclusive) with the specified step value.

    end

    The final bound of the range to make.

    step

    The number to increase by for each step of the range.

    returns

    A scala.collection.immutable.NumericRange.Exclusive[Float] from this up to but not including end.

  93. def until(end: Float): Partial[Float, NumericRange[Float]]

    Create a Range from this PosFiniteFloat value until the specified end (exclusive) with step value 1.

    Create a Range from this PosFiniteFloat value until the specified end (exclusive) with step value 1.

    end

    The final bound of the range to make.

    returns

    A NumericRange[Float]] from this up to but not including end.

  94. val value: Float

Inherited from AnyVal

Inherited from Any

Ungrouped