final class NonZeroFloat extends AnyVal

An AnyVal for non-zero Floats.

Note: a NonZeroFloat may not equal 0.0.

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

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

scala> import anyvals._
import anyvals._

scala> NonZeroFloat(1.1F)
res0: org.scalactic.anyvals.NonZeroFloat = NonZeroFloat(1.1)

scala> NonZeroFloat(0.0F)
<console>:14: error: NonZeroFloat.apply can only be invoked on a non-zero (i != 0.0f && !i.isNaN) floating point literal, like NonZeroFloat(1.1F).
              NonZeroFloat(1.1F)
                      ^

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

scala> val x = 1.1F
x: Float = 1.1

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

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

scala> NonZeroFloat.from(x)
res3: Option[org.scalactic.anyvals.NonZeroFloat] = Some(NonZeroFloat(1.1))

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

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

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

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

scala> invert(1.1F)
res5: Float = 3.4028235E38

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

scala> invert(0.0F)
<console>:15: error: NonZeroFloat.apply can only be invoked on a non-zero (i != 0.0f && !i.isNaN) floating point literal, like NonZeroFloat(1.1F).
              invert(0.0F)
                     ^

scala> invert(0.0F)
<console>:15: error: NonZeroFloat.apply can only be invoked on a non-zero (i != 0.0f && !i.isNaN) floating point literal, like NonZeroFloat(1.1F).
              invert(0.0F)
                      ^

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

Source
NonZeroFloat.scala
Linear Supertypes
AnyVal, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. NonZeroFloat
  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 NonZeroFloat'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 ensuringValid(f: (Float) ⇒ Float): NonZeroFloat

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

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

    returns

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

    Exceptions thrown

    AssertionError if the result of applying this NonZeroFloat's underlying Float value to to the passed function is not non-zero.

  70. def getClass(): Class[_ <: AnyVal]
    Definition Classes
    AnyVal → Any
  71. def isFinite: Boolean

    True if this NonZeroFloat value is any finite value (i.e., it is neither positive nor negative infinity), else false.

  72. def isInfinite: Boolean

    True if this NonZeroFloat value represents positive or negative infinity, else false.

  73. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  74. def isNegInfinity: Boolean

    True if this NonZeroFloat value represents negative infinity, else false.

  75. def isPosInfinity: Boolean

    True if this NonZeroFloat value represents positive infinity, else false.

  76. def isWhole: Boolean

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

  77. def max(that: NonZeroFloat): NonZeroFloat

    Returns this if this > that or that otherwise.

  78. def min(that: NonZeroFloat): NonZeroFloat

    Returns this if this < that or that otherwise.

  79. def toByte: Byte

    Converts this NonZeroFloat to a Byte.

  80. def toChar: Char

    Converts this NonZeroFloat to a Char.

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

  82. def toDouble: Double

    Converts this NonZeroFloat to a Double.

  83. def toFloat: Float

    Converts this NonZeroFloat to a Float.

  84. def toInt: Int

    Converts this NonZeroFloat to an Int.

  85. def toLong: Long

    Converts this NonZeroFloat to a Long.

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

  87. def toShort: Short

    Converts this NonZeroFloat to a Short.

  88. def toString(): String

    A string representation of this NonZeroFloat.

    A string representation of this NonZeroFloat.

    Definition Classes
    NonZeroFloat → Any
  89. def unary_+: NonZeroFloat

    Returns this value, unmodified.

  90. def unary_-: NonZeroFloat

    Returns the negation of this value.

  91. val value: Float

Inherited from AnyVal

Inherited from Any

Ungrouped