Packages

final class PosFloat extends AnyVal

An AnyVal for positive Floats.

Note: a PosFloat may not equal 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(1.0F)
res0: org.scalactic.anyvals.PosFloat = PosFloat(1.0)

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

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 = 1.0F
x: Float = 1.0

scala> PosFloat(x)
<console>:15: error: PosFloat.apply can only be invoked on a floating point literal, like PosFloat(42.0F). 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(1.0))

scala> val y = 0.0F
y: Float = 0.0

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(1.1F)
res5: Float = 3.4028235E38

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

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

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

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
    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 PosFloat'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: PosFloat
  70. def floor: PosZFloat
  71. def getClass(): Class[_ <: AnyVal]
    Definition Classes
    AnyVal → Any
  72. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  73. def isPosInfinity: Boolean
  74. def isWhole: Boolean
  75. def max(that: PosFloat): PosFloat

    Returns this if this > that or that otherwise.

  76. def min(that: PosFloat): PosFloat

    Returns this if this < that or that otherwise.

  77. def round: PosZInt
  78. def toByte: Byte

    Converts this PosFloat to a Byte.

  79. def toChar: Char

    Converts this PosFloat to a Char.

  80. 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.

  81. def toDouble: Double

    Converts this PosFloat to a Double.

  82. def toFloat: Float

    Converts this PosFloat to a Float.

  83. def toInt: Int

    Converts this PosFloat to an Int.

  84. def toLong: Long

    Converts this PosFloat to a Long.

  85. 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.

  86. def toShort: Short

    Converts this PosFloat to a Short.

  87. def toString(): String

    A string representation of this PosFloat.

    A string representation of this PosFloat.

    Definition Classes
    PosFloat → Any
  88. def unary_+: PosFloat

    Returns this value, unmodified.

  89. def unary_-: Float

    Returns the negation of this value.

  90. val value: Float

Deprecated Value Members

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

    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.

    Annotations
    @deprecated
    Deprecated

    This function will be removed in future version of Scalactic, use BigDecimal's to function instead

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

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

    Create an inclusive Range.Partial 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.

    Annotations
    @deprecated
    Deprecated

    This function will be removed in future version of Scalactic, use BigDecimal's to function instead

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

    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.

    Annotations
    @deprecated
    Deprecated

    This function will be removed in future version of Scalactic, use BigDecimal's until function instead

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

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

    Create a Range.Partial 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.

    Annotations
    @deprecated
    Deprecated

    This function will be removed in future version of Scalactic, use BigDecimal's until function instead

Inherited from AnyVal

Inherited from Any

Ungrouped