PosFloat

An AnyVal for positive Floats.

Note: a PosFloat may not equal 0.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(42.1fF)
res0: org.scalactic.anyvals.PosFloat = PosFloat(42.1f)

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

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 = 42.1fF
x: Float = 42.1f

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

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

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

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

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

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

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

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

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

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

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

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

Definition Classes
AnyVal → Any
def isFinite: Boolean

True if this PosFloat value is any finite value (i.e., it is neither positive nor negative infinity), else false.
True if this PosFloat 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 isPosInfinity: Boolean

True if this PosFloat value represents positive infinity, else false.
True if this PosFloat value represents positive infinity, else false.
def isWhole: Boolean

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

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

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

Returns the PosFloat sum of this PosFloat's value and the given PosZFloat value.
Returns the PosFloat sum of this PosFloat's value and the given PosZFloat value.
This method will always succeed (not throw an exception) because adding a positive Float and non-negative Float and another positive Float will always result in another positive Float value (though the result may be infinity).
def round: PosZInt

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

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

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

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

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

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

A string representation of this PosFloat.
A string representation of this PosFloat.

Definition Classes
PosFloat → Any
def unary_+: PosFloat

Returns this value, unmodified.
def unary_-: NegFloat

Returns the negation of this value.
val value: Float

The Float value underlying this PosFloat.
The Float value underlying this PosFloat.

Related Docs: object PosFloat | package anyvals

final class PosFloat 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: PosFloat

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

def floor: PosZFloat

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

def isFinite: Boolean

final def isInstanceOf[T0]: Boolean

def isPosInfinity: Boolean

def isWhole: Boolean