Class/Object

org.scalactic.anyvals

PosFloat

Related Docs: object PosFloat | package anyvals

Permalink

final class PosFloat extends AnyVal

An AnyVal for positive Floats.

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

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

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

scala> import anyvals._
import anyvals._

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

scala> PosFloat(0.0fF)
<console>:14: error: PosFloat.apply can only be invoked on a positive (i > 0.0f) floating point literal, like PosFloat(42.1fF).
              PosFloat(42.1fF)
                      ^

PosFloat.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 PosFloat.apply, you'll get a compiler error that suggests you use a different factor method, PosFloat.from, instead:

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

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

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

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

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

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

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

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

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

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

scala> invert(0.0fF)
<console>:15: error: PosFloat.apply can only be invoked on a positive (i > 0.0f) floating point literal, like PosFloat(42.1fF).
              invert(0.0F)
                     ^

scala> invert(0.0fF)
<console>:15: error: PosFloat.apply can only be invoked on a positive (i > 0.0f) floating point literal, like PosFloat(42.1fF).
              invert(0.0fF)
                      ^

This example also demonstrates that the PosFloat companion object also defines implicit widening conversions when no loss of precision will occur. This makes it convenient to use a PosFloat 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 PosFloat (the type of pos), you can still subtract pos, because the PosFloat will be implicitly widened to Float.

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

Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    Any

  2. final def ##(): Int

    Permalink
    Definition Classes
    Any

  3. def %(x: Double): Double

    Permalink

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

  4. def %(x: Float): Float

    Permalink

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

  5. def %(x: Long): Float

    Permalink

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

  6. def %(x: Int): Float

    Permalink

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

  7. def %(x: Char): Float

    Permalink

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

  8. def %(x: Short): Float

    Permalink

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

  9. def %(x: Byte): Float

    Permalink

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

  10. def *(x: Double): Double

    Permalink

    Returns the product of this value and x.

  11. def *(x: Float): Float

    Permalink

    Returns the product of this value and x.

  12. def *(x: Long): Float

    Permalink

    Returns the product of this value and x.

  13. def *(x: Int): Float

    Permalink

    Returns the product of this value and x.

  14. def *(x: Char): Float

    Permalink

    Returns the product of this value and x.

  15. def *(x: Short): Float

    Permalink

    Returns the product of this value and x.

  16. def *(x: Byte): Float

    Permalink

    Returns the product of this value and x.

  17. def +(x: Double): Double

    Permalink

    Returns the sum of this value and x.

  18. def +(x: Float): Float

    Permalink

    Returns the sum of this value and x.

  19. def +(x: Long): Float

    Permalink

    Returns the sum of this value and x.

  20. def +(x: Int): Float

    Permalink

    Returns the sum of this value and x.

  21. def +(x: Char): Float

    Permalink

    Returns the sum of this value and x.

  22. def +(x: Short): Float

    Permalink

    Returns the sum of this value and x.

  23. def +(x: Byte): Float

    Permalink

    Returns the sum of this value and x.

  24. def +(x: String): String

    Permalink

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

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

  25. def -(x: Double): Double

    Permalink

    Returns the difference of this value and x.

  26. def -(x: Float): Float

    Permalink

    Returns the difference of this value and x.

  27. def -(x: Long): Float

    Permalink

    Returns the difference of this value and x.

  28. def -(x: Int): Float

    Permalink

    Returns the difference of this value and x.

  29. def -(x: Char): Float

    Permalink

    Returns the difference of this value and x.

  30. def -(x: Short): Float

    Permalink

    Returns the difference of this value and x.

  31. def -(x: Byte): Float

    Permalink

    Returns the difference of this value and x.

  32. def /(x: Double): Double

    Permalink

    Returns the quotient of this value and x.

  33. def /(x: Float): Float

    Permalink

    Returns the quotient of this value and x.

  34. def /(x: Long): Float

    Permalink

    Returns the quotient of this value and x.

  35. def /(x: Int): Float

    Permalink

    Returns the quotient of this value and x.

  36. def /(x: Char): Float

    Permalink

    Returns the quotient of this value and x.

  37. def /(x: Short): Float

    Permalink

    Returns the quotient of this value and x.

  38. def /(x: Byte): Float

    Permalink

    Returns the quotient of this value and x.

  39. def <(x: Double): Boolean

    Permalink

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

  40. def <(x: Float): Boolean

    Permalink

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

  41. def <(x: Long): Boolean

    Permalink

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

  42. def <(x: Int): Boolean

    Permalink

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

  43. def <(x: Char): Boolean

    Permalink

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

  44. def <(x: Short): Boolean

    Permalink

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

  45. def <(x: Byte): Boolean

    Permalink

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

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

    Permalink

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

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

    Permalink

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

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

    Permalink

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

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

    Permalink

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

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

    Permalink

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

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

    Permalink

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

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

    Permalink

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

  53. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    Any

  54. def >(x: Double): Boolean

    Permalink

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

  55. def >(x: Float): Boolean

    Permalink

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

  56. def >(x: Long): Boolean

    Permalink

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

  57. def >(x: Int): Boolean

    Permalink

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

  58. def >(x: Char): Boolean

    Permalink

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

  59. def >(x: Short): Boolean

    Permalink

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

  60. def >(x: Byte): Boolean

    Permalink

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

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

    Permalink

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

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

    Permalink

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

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

    Permalink

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

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

    Permalink

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

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

    Permalink

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

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

    Permalink

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

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

    Permalink

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

  68. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any

  69. def ceil: PosFloat

    Permalink

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

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

    Permalink

    Applies the passed Float => Float function to the underlying Float value, and if the result is positive, returns the result wrapped in a PosFloat, 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 PosFloat, else throws AssertionError.

    This method will inspect the result of applying the given function to this PosFloat's underlying Float value and if the result is positive, it will return a PosFloat representing that value. Otherwise, the Float value returned by the given function is not 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 positive. With this method, you are asserting that you are convinced the result of the computation represented by applying the given function to this PosFloat'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 PosFloat's underlying Float value.

    returns

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

    Exceptions thrown

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

  71. def floor: PosZFloat

    Permalink

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

  72. def getClass(): Class[_ <: AnyVal]

    Permalink
    Definition Classes
    AnyVal → Any

  73. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any

  74. def isPosInfinity: Boolean

    Permalink

  75. def isWhole: Boolean

    Permalink

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

  76. def max(that: PosFloat): PosFloat

    Permalink

    Returns this if this > that or that otherwise.

    Returns this if this > that or that otherwise.

  77. def min(that: PosFloat): PosFloat

    Permalink

    Returns this if this < that or that otherwise.

    Returns this if this < that or that otherwise.

  78. def plus(x: PosZFloat): PosFloat

    Permalink

    Returns the PosFloat sum of this PosFloat's value and the given PosZFloat value.

    Returns the PosFloat sum of this PosFloat's value and the given PosZFloat value.

    This method will always succeed (not throw an exception) because adding a positive Float and non-negative Float and another positive Float will always result in another positive Float value (though the result may be infinity).

  79. def round: PosZFloat

    Permalink

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

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

    Permalink

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

    Create an inclusive Range from this PosFloat 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.

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

    Permalink

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

    Create an inclusive Range from this PosFloat 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.

  82. def toByte: Byte

    Permalink

    Converts this PosFloat to a Byte.

    Converts this PosFloat to a Byte.

  83. def toChar: Char

    Permalink

    Converts this PosFloat to a Char.

    Converts this PosFloat to a Char.

  84. def toDegrees: Float

    Permalink

    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.

  85. def toDouble: Double

    Permalink

    Converts this PosFloat to a Double.

    Converts this PosFloat to a Double.

  86. def toFloat: Float

    Permalink

    Converts this PosFloat to a Float.

    Converts this PosFloat to a Float.

  87. def toInt: Int

    Permalink

    Converts this PosFloat to an Int.

    Converts this PosFloat to an Int.

  88. def toLong: Long

    Permalink

    Converts this PosFloat to a Long.

    Converts this PosFloat to a Long.

  89. def toRadians: Float

    Permalink

    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.

  90. def toShort: Short

    Permalink

    Converts this PosFloat to a Short.

    Converts this PosFloat to a Short.

  91. def toString(): String

    Permalink

    A string representation of this PosFloat.

    A string representation of this PosFloat.

    Definition Classes
    PosFloat → Any

  92. def unary_+: PosFloat

    Permalink

    Returns this value, unmodified.

  93. def unary_-: NegFloat

    Permalink

    Returns the negation of this value.

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

    Permalink

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

    Create a Range (exclusive) from this PosFloat 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.

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

    Permalink

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

    Create a Range from this PosFloat 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.

  96. val value: Float

    Permalink

    The Float value underlying this PosFloat.

    The Float value underlying this PosFloat.

Inherited from AnyVal

Inherited from Any

Ungrouped