NonZeroFloat

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

Value Members

final def !=(arg0: Any): Boolean

Definition Classes
Any
final def ##(): Int

Definition Classes
Any
def %(x: Double): Double

Returns the remainder of the division of this value by x.
def %(x: Float): Float

Returns the remainder of the division of this value by x.
def %(x: Long): Float

Returns the remainder of the division of this value by x.
def %(x: Int): Float

Returns the remainder of the division of this value by x.
def %(x: Char): Float

Returns the remainder of the division of this value by x.
def %(x: Short): Float

Returns the remainder of the division of this value by x.
def %(x: Byte): Float

Returns the remainder of the division of this value by x.
def *(x: Double): Double

Returns the product of this value and x.
def *(x: Float): Float

Returns the product of this value and x.
def *(x: Long): Float

Returns the product of this value and x.
def *(x: Int): Float

Returns the product of this value and x.
def *(x: Char): Float

Returns the product of this value and x.
def *(x: Short): Float

Returns the product of this value and x.
def *(x: Byte): Float

Returns the product of this value and x.
def +(x: Double): Double

Returns the sum of this value and x.
def +(x: Float): Float

Returns the sum of this value and x.
def +(x: Long): Float

Returns the sum of this value and x.
def +(x: Int): Float

Returns the sum of this value and x.
def +(x: Char): Float

Returns the sum of this value and x.
def +(x: Short): Float

Returns the sum of this value and x.
def +(x: Byte): Float

Returns the sum of this value and x.
def +(x: String): String

Converts this NonZeroFloat's value to a string then concatenates the given string.
Converts this NonZeroFloat's value to a string then concatenates the given string.
def -(x: Double): Double

Returns the difference of this value and x.
def -(x: Float): Float

Returns the difference of this value and x.
def -(x: Long): Float

Returns the difference of this value and x.
def -(x: Int): Float

Returns the difference of this value and x.
def -(x: Char): Float

Returns the difference of this value and x.
def -(x: Short): Float

Returns the difference of this value and x.
def -(x: Byte): Float

Returns the difference of this value and x.
def /(x: Double): Double

Returns the quotient of this value and x.
def /(x: Float): Float

Returns the quotient of this value and x.
def /(x: Long): Float

Returns the quotient of this value and x.
def /(x: Int): Float

Returns the quotient of this value and x.
def /(x: Char): Float

Returns the quotient of this value and x.
def /(x: Short): Float

Returns the quotient of this value and x.
def /(x: Byte): Float

Returns the quotient of this value and x.
def <(x: Double): Boolean

Returns true if this value is less than x, false otherwise.
def <(x: Float): Boolean

Returns true if this value is less than x, false otherwise.
def <(x: Long): Boolean

Returns true if this value is less than x, false otherwise.
def <(x: Int): Boolean

Returns true if this value is less than x, false otherwise.
def <(x: Char): Boolean

Returns true if this value is less than x, false otherwise.
def <(x: Short): Boolean

Returns true if this value is less than x, false otherwise.
def <(x: Byte): Boolean

Returns true if this value is less than x, false otherwise.
def <=(x: Double): Boolean

Returns true if this value is less than or equal to x, false otherwise.
def <=(x: Float): Boolean

Returns true if this value is less than or equal to x, false otherwise.
def <=(x: Long): Boolean

Returns true if this value is less than or equal to x, false otherwise.
def <=(x: Int): Boolean

Returns true if this value is less than or equal to x, false otherwise.
def <=(x: Char): Boolean

Returns true if this value is less than or equal to x, false otherwise.
def <=(x: Short): Boolean

Returns true if this value is less than or equal to x, false otherwise.
def <=(x: Byte): Boolean

Returns true if this value is less than or equal to x, false otherwise.
final def ==(arg0: Any): Boolean

Definition Classes
Any
def >(x: Double): Boolean

Returns true if this value is greater than x, false otherwise.
def >(x: Float): Boolean

Returns true if this value is greater than x, false otherwise.
def >(x: Long): Boolean

Returns true if this value is greater than x, false otherwise.
def >(x: Int): Boolean

Returns true if this value is greater than x, false otherwise.
def >(x: Char): Boolean

Returns true if this value is greater than x, false otherwise.
def >(x: Short): Boolean

Returns true if this value is greater than x, false otherwise.
def >(x: Byte): Boolean

Returns true if this value is greater than x, false otherwise.
def >=(x: Double): Boolean

Returns true if this value is greater than or equal to x, false otherwise.
def >=(x: Float): Boolean

Returns true if this value is greater than or equal to x, false otherwise.
def >=(x: Long): Boolean

Returns true if this value is greater than or equal to x, false otherwise.
def >=(x: Int): Boolean

Returns true if this value is greater than or equal to x, false otherwise.
def >=(x: Char): Boolean

Returns true if this value is greater than or equal to x, false otherwise.
def >=(x: Short): Boolean

Returns true if this value is greater than or equal to x, false otherwise.
def >=(x: Byte): Boolean

Returns true if this value is greater than or equal to x, false otherwise.
final def asInstanceOf[T0]: T0

Definition Classes
Any
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.
def getClass(): Class[_ <: AnyVal]

Definition Classes
AnyVal → Any
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
def isNegInfinity: Boolean
def isPosInfinity: Boolean
def isWhole: Boolean

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

Returns this if this > that or that otherwise.
Returns this if this > that or that otherwise.
def min(that: NonZeroFloat): NonZeroFloat

Returns this if this < that or that otherwise.
Returns this if this < that or that otherwise.
def to(end: Float, step: Float): Inclusive[Float]

Create an inclusive Range from this NonZeroFloat value to the specified end with the specified step value.
Create an inclusive Range from this NonZeroFloat 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.
def to(end: Float): Partial[Float, NumericRange[Float]]

Create an inclusive Range from this NonZeroFloat value to the specified end with step value 1.
Create an inclusive Range from this NonZeroFloat 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.
def toByte: Byte

Converts this NonZeroFloat to a Byte.
Converts this NonZeroFloat to a Byte.
def toChar: Char

Converts this NonZeroFloat to a Char.
Converts this NonZeroFloat to a Char.
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.
def toDouble: Double

Converts this NonZeroFloat to a Double.
Converts this NonZeroFloat to a Double.
def toFloat: Float

Converts this NonZeroFloat to a Float.
Converts this NonZeroFloat to a Float.
def toInt: Int

Converts this NonZeroFloat to an Int.
Converts this NonZeroFloat to an Int.
def toLong: Long

Converts this NonZeroFloat to a Long.
Converts this NonZeroFloat to a Long.
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.
def toShort: Short

Converts this NonZeroFloat to a Short.
Converts this NonZeroFloat to a Short.
def toString(): String

A string representation of this NonZeroFloat.
A string representation of this NonZeroFloat.

Definition Classes
NonZeroFloat → Any
def unary_+: NonZeroFloat

Returns this value, unmodified.
def unary_-: NonZeroFloat

Returns the negation of this value.
def until(end: Float, step: Float): Exclusive[Float]

Create a Range (exclusive) from this NonZeroFloat value until the specified end (exclusive) with the specified step value.
Create a Range (exclusive) from this NonZeroFloat 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.
def until(end: Float): Partial[Float, NumericRange[Float]]

Create a Range from this NonZeroFloat value until the specified end (exclusive) with step value 1.
Create a Range from this NonZeroFloat 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.
val value: Float

The Float value underlying this NonZeroFloat.
The Float value underlying this NonZeroFloat.

Related Docs: object NonZeroFloat | package anyvals

final class NonZeroFloat extends AnyVal

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

def %(x: Double): Double

def %(x: Float): Float

def %(x: Long): Float

def %(x: Int): Float

def %(x: Char): Float

def %(x: Short): Float

def %(x: Byte): Float

def *(x: Double): Double

def *(x: Float): Float

def *(x: Long): Float

def *(x: Int): Float

def *(x: Char): Float

def *(x: Short): Float

def *(x: Byte): Float

def +(x: Double): Double

def +(x: Float): Float

def +(x: Long): Float

def +(x: Int): Float

def +(x: Char): Float

def +(x: Short): Float

def +(x: Byte): Float

def +(x: String): String

def -(x: Double): Double

def -(x: Float): Float

def -(x: Long): Float

def -(x: Int): Float

def -(x: Char): Float

def -(x: Short): Float

def -(x: Byte): Float

def /(x: Double): Double

def /(x: Float): Float

def /(x: Long): Float

def /(x: Int): Float

def /(x: Char): Float

def /(x: Short): Float

def /(x: Byte): Float

def <(x: Double): Boolean

def <(x: Float): Boolean

def <(x: Long): Boolean

def <(x: Int): Boolean

def <(x: Char): Boolean

def <(x: Short): Boolean

def <(x: Byte): Boolean

def <=(x: Double): Boolean

def <=(x: Float): Boolean

def <=(x: Long): Boolean

def <=(x: Int): Boolean

def <=(x: Char): Boolean

def <=(x: Short): Boolean

def <=(x: Byte): Boolean

final def ==(arg0: Any): Boolean

def >(x: Double): Boolean

def >(x: Float): Boolean

def >(x: Long): Boolean

def >(x: Int): Boolean

def >(x: Char): Boolean

def >(x: Short): Boolean

def >(x: Byte): Boolean

def >=(x: Double): Boolean

def >=(x: Float): Boolean

def >=(x: Long): Boolean

def >=(x: Int): Boolean

def >=(x: Char): Boolean

def >=(x: Short): Boolean

def >=(x: Byte): Boolean

final def asInstanceOf[T0]: T0

def ensuringValid(f: (Float) ⇒ Float): NonZeroFloat

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

final def isInstanceOf[T0]: Boolean

def isNegInfinity: Boolean

def isPosInfinity: Boolean

def isWhole: Boolean

def max(that: NonZeroFloat): NonZeroFloat

def min(that: NonZeroFloat): NonZeroFloat