NegZFloat

An AnyVal for non-positive Floats.

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

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

scala> import anyvals._
import anyvals._

scala> NegZFloat(-1.1fF)
res0: org.scalactic.anyvals.NegZFloat = NegZFloat(-1.1f)

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

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

scala> val x = -1.1fF
x: Float = -1.1f

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

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

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

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

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

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

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

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

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

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

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

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

Source: NegZFloat.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 NegZFloat's value to a string then concatenates the given string.
Converts this NegZFloat'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 ceil: NegZFloat

Returns the smallest (closest to 0) NegZFloat that is greater than or equal to this NegZFloat and represents a mathematical integer.
def ensuringValid(f: (Float) ⇒ Float): NegZFloat

Applies the passed Float => Float function to the underlying Float value, and if the result is positive, returns the result wrapped in a NegZFloat, 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 NegZFloat, else throws AssertionError.
This method will inspect the result of applying the given function to this NegZFloat's underlying Float value and if the result is non-positive, it will return a NegZFloat representing that value. Otherwise, the Float value returned by the given function is not non-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 non-positive. With this method, you are asserting that you are convinced the result of the computation represented by applying the given function to this NegZFloat'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 NegZFloat's underlying Float value.
returns
the result of applying this NegZFloat's underlying Float value to to the passed function, wrapped in a NegZFloat if it is non-positive (else throws AssertionError).

Exceptions thrown
AssertionError if the result of applying this NegZFloat's underlying Float value to to the passed function is not non-positive.
def floor: NegZFloat

Returns the greatest (closest to infinity) NegZFloat that is less than or equal to this NegZFloat and represents a mathematical integer.
def getClass(): Class[_ <: AnyVal]

Definition Classes
AnyVal → Any
def isFinite: Boolean

True if this NegZFloat value is any finite value (i.e., it is neither positive nor negative infinity), else false.
True if this NegZFloat value is any finite value (i.e., it is neither positive nor negative infinity), else false.
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
def isNegInfinity: Boolean

True if this NegZFloat value represents negative infinity, else false.
True if this NegZFloat value represents negative infinity, else false.
def isWhole: Boolean

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

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

Returns this if this < that or that otherwise.
Returns this if this < that or that otherwise.
def plus(x: NegZFloat): NegZFloat

Returns the NegZFloat sum of this value and x.
Returns the NegZFloat sum of this value and x.
This method will always succeed (not throw an exception) because adding a non-positive Float to another non-positive Float will always result in another non-positive Float value (though the result may be infinity).
def round: NegZInt

Rounds this NegZFloat value to the nearest whole number value that can be expressed as an NegZInt, returning the result as a NegZInt.
def toByte: Byte

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

Converts this NegZFloat to a Char.
Converts this NegZFloat 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 NegZFloat to a Double.
Converts this NegZFloat to a Double.
def toFloat: Float

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

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

Converts this NegZFloat to a Long.
Converts this NegZFloat 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 NegZFloat to a Short.
Converts this NegZFloat to a Short.
def toString(): String

A string representation of this NegZFloat.
A string representation of this NegZFloat.

Definition Classes
NegZFloat → Any
def unary_+: NegZFloat

Returns this value, unmodified.
def unary_-: PosZFloat

Returns the negation of this value.
val value: Float

The Float value underlying this NegZFloat.
The Float value underlying this NegZFloat.

Related Docs: object NegZFloat | package anyvals

final class NegZFloat 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 ceil: NegZFloat

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

def floor: NegZFloat

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

def isFinite: Boolean

final def isInstanceOf[T0]: Boolean

def isNegInfinity: Boolean

def isWhole: Boolean