NegFiniteFloat

An AnyVal for finite negative Floats.

Note: a NegFiniteFloat may not equal 0.0. If you want negative number or 0, use NegZFiniteFloat.

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

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

scala> import anyvals._
import anyvals._

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

scala> NegFiniteFloat(0.0fF)
<console>:14: error: NegFiniteFloat.apply can only be invoked on a finite negative (i < 0.0f && i != Float.NegativeInfinity) floating point literal, like NegFiniteFloat(-42.1fF).
              NegFiniteFloat(-42.1fF)
                      ^

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

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

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

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

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

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

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

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

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

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

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

scala> invert(0.0fF)
<console>:15: error: NegFiniteFloat.apply can only be invoked on a finite negative (i < 0.0f && i != Float.NegativeInfinity) floating point literal, like NegFiniteFloat(-42.1fF).
              invert(0.0F)
                     ^

scala> invert(0.0fF)
<console>:15: error: NegFiniteFloat.apply can only be invoked on a finite negative (i < 0.0f && i != Float.NegativeInfinity) floating point literal, like NegFiniteFloat(-42.1fF).
              invert(0.0fF)
                      ^

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

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

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

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

Exceptions thrown
AssertionError if the result of applying this NegFiniteFloat's underlying Float value to to the passed function is not finite negative.
def floor: NegFiniteFloat

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

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

Definition Classes
Any
def isWhole: Boolean

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

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

Returns this if this < that or that otherwise.
Returns this if this < that or that otherwise.
def round: NegZInt

Rounds this NegFiniteFloat 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 NegFiniteFloat to a Byte.
Converts this NegFiniteFloat to a Byte.
def toChar: Char

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

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

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

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

A string representation of this NegFiniteFloat.
A string representation of this NegFiniteFloat.

Definition Classes
NegFiniteFloat → Any
def unary_+: NegFiniteFloat

Returns this value, unmodified.
def unary_-: PosFiniteFloat

Returns the negation of this value.
val value: Float

The Float value underlying this NegFiniteFloat.
The Float value underlying this NegFiniteFloat.

Related Docs: object NegFiniteFloat | package anyvals

final class NegFiniteFloat 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: NegZFiniteFloat

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

def floor: NegFiniteFloat

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

final def isInstanceOf[T0]: Boolean

def isWhole: Boolean

def max(that: NegFiniteFloat): NegFiniteFloat

def min(that: NegFiniteFloat): NegFiniteFloat