final class PosZFloat extends AnyVal

An AnyVal for non-negative Floats.

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

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

scala> import anyvals._
import anyvals._
scala> PosZFloat(1.1F)
res0: org.scalactic.anyvals.PosZFloat = PosZFloat(1.1)
scala> PosZFloat(0.0F)
res1: org.scalactic.anyvals.PosZFloat = PosZFloat(0.0)
scala> PosZFloat(-1.1F)
<console>:14: error: PosZFloat.apply can only be invoked on a non-negative (i >= 0.0F) floating point literal, like PosZFloat(42.0F).
 PosZFloat(-1.1F)
 ^

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

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

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

scala> PosZFloat.from(x)
res4: Option[org.scalactic.anyvals.PosZFloat] = Some(PosZFloat(1.1))
scala> val y = -1.1F
y: Float = -1.1
scala> PosZFloat.from(y)
res5: Option[org.scalactic.anyvals.PosZFloat] = None

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

scala> def invert(pos: PosZFloat): Float = Float.MaxValue - pos
invert: (pos: org.scalactic.anyvals.PosZFloat)Float
scala> invert(0.0F)
res6: Float = 3.4028235E38
scala> invert(Float.MaxValue)
res7: Float = 0.0
scala> invert(-1.1F)
<console>:15: error: PosZFloat.apply can only be invoked on a non-negative (i >= 0.0F) floating point literal, like PosZFloat(42.0F).
 invert(-1.1F)
 ^

This example also demonstrates that the PosZFloat companion object also defines implicit widening conversions when a similar conversion is provided in Scala. This makes it convenient to use a PosZFloat 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 an Float, which has no - method that takes a PosZFloat (the type of pos), you can still subtract pos, because the PosZFloat will be implicitly widened to Float.

Source: PosZFloat.scala

Linear Supertypes

AnyVal, Any

Ordering

Alphabetic
By Inheritance

Inherited

PosZFloat
AnyVal
Any

Hide All
Show All

Visibility

Public
All

Value Members

final def !=(arg0: Any): Boolean
Permalink

Definition Classes
Any
final def ##(): Int
Permalink

Definition Classes
Any
def %(x: Double): Double
Permalink
Returns the remainder of the division of this value by x.
def %(x: Float): Float
Permalink
Returns the remainder of the division of this value by x.
def %(x: Long): Float
Permalink
Returns the remainder of the division of this value by x.
def %(x: Int): Float
Permalink
Returns the remainder of the division of this value by x.
def %(x: Char): Float
Permalink
Returns the remainder of the division of this value by x.
def %(x: Short): Float
Permalink
Returns the remainder of the division of this value by x.
def %(x: Byte): Float
Permalink
Returns the remainder of the division of this value by x.
def *(x: Double): Double
Permalink
Returns the product of this value and x.
def *(x: Float): Float
Permalink
Returns the product of this value and x.
def *(x: Long): Float
Permalink
Returns the product of this value and x.
def *(x: Int): Float
Permalink
Returns the product of this value and x.
def *(x: Char): Float
Permalink
Returns the product of this value and x.
def *(x: Short): Float
Permalink
Returns the product of this value and x.
def *(x: Byte): Float
Permalink
Returns the product of this value and x.
def +(x: Double): Double
Permalink
Returns the sum of this value and x.
def +(x: Float): Float
Permalink
Returns the sum of this value and x.
def +(x: Long): Float
Permalink
Returns the sum of this value and x.
def +(x: Int): Float
Permalink
Returns the sum of this value and x.
def +(x: Char): Float
Permalink
Returns the sum of this value and x.
def +(x: Short): Float
Permalink
Returns the sum of this value and x.
def +(x: Byte): Float
Permalink
Returns the sum of this value and x.
def +(x: String): String
Permalink
Converts this PosZFloat's value to a string then concatenates the given string.
Converts this PosZFloat's value to a string then concatenates the given string.
def -(x: Double): Double
Permalink
Returns the difference of this value and x.
def -(x: Float): Float
Permalink
Returns the difference of this value and x.
def -(x: Long): Float
Permalink
Returns the difference of this value and x.
def -(x: Int): Float
Permalink
Returns the difference of this value and x.
def -(x: Char): Float
Permalink
Returns the difference of this value and x.
def -(x: Short): Float
Permalink
Returns the difference of this value and x.
def -(x: Byte): Float
Permalink
Returns the difference of this value and x.
def /(x: Double): Double
Permalink
Returns the quotient of this value and x.
def /(x: Float): Float
Permalink
Returns the quotient of this value and x.
def /(x: Long): Float
Permalink
Returns the quotient of this value and x.
def /(x: Int): Float
Permalink
Returns the quotient of this value and x.
def /(x: Char): Float
Permalink
Returns the quotient of this value and x.
def /(x: Short): Float
Permalink
Returns the quotient of this value and x.
def /(x: Byte): Float
Permalink
Returns the quotient of this value and x.
def <(x: Double): Boolean
Permalink
Returns true if this value is less than x, false otherwise.
def <(x: Float): Boolean
Permalink
Returns true if this value is less than x, false otherwise.
def <(x: Long): Boolean
Permalink
Returns true if this value is less than x, false otherwise.
def <(x: Int): Boolean
Permalink
Returns true if this value is less than x, false otherwise.
def <(x: Char): Boolean
Permalink
Returns true if this value is less than x, false otherwise.
def <(x: Short): Boolean
Permalink
Returns true if this value is less than x, false otherwise.
def <(x: Byte): Boolean
Permalink
Returns true if this value is less than x, false otherwise.
def <=(x: Double): Boolean
Permalink
Returns true if this value is less than or equal to x, false otherwise.
def <=(x: Float): Boolean
Permalink
Returns true if this value is less than or equal to x, false otherwise.
def <=(x: Long): Boolean
Permalink
Returns true if this value is less than or equal to x, false otherwise.
def <=(x: Int): Boolean
Permalink
Returns true if this value is less than or equal to x, false otherwise.
def <=(x: Char): Boolean
Permalink
Returns true if this value is less than or equal to x, false otherwise.
def <=(x: Short): Boolean
Permalink
Returns true if this value is less than or equal to x, false otherwise.
def <=(x: Byte): Boolean
Permalink
Returns true if this value is less than or equal to x, false otherwise.
final def ==(arg0: Any): Boolean
Permalink

Definition Classes
Any
def >(x: Double): Boolean
Permalink
Returns true if this value is greater than x, false otherwise.
def >(x: Float): Boolean
Permalink
Returns true if this value is greater than x, false otherwise.
def >(x: Long): Boolean
Permalink
Returns true if this value is greater than x, false otherwise.
def >(x: Int): Boolean
Permalink
Returns true if this value is greater than x, false otherwise.
def >(x: Char): Boolean
Permalink
Returns true if this value is greater than x, false otherwise.
def >(x: Short): Boolean
Permalink
Returns true if this value is greater than x, false otherwise.
def >(x: Byte): Boolean
Permalink
Returns true if this value is greater than x, false otherwise.
def >=(x: Double): Boolean
Permalink
Returns true if this value is greater than or equal to x, false otherwise.
def >=(x: Float): Boolean
Permalink
Returns true if this value is greater than or equal to x, false otherwise.
def >=(x: Long): Boolean
Permalink
Returns true if this value is greater than or equal to x, false otherwise.
def >=(x: Int): Boolean
Permalink
Returns true if this value is greater than or equal to x, false otherwise.
def >=(x: Char): Boolean
Permalink
Returns true if this value is greater than or equal to x, false otherwise.
def >=(x: Short): Boolean
Permalink
Returns true if this value is greater than or equal to x, false otherwise.
def >=(x: Byte): Boolean
Permalink
Returns true if this value is greater than or equal to x, false otherwise.
final def asInstanceOf[T0]: T0
Permalink

Definition Classes
Any
def ceil: PosZFloat
Permalink
def floor: PosZFloat
Permalink
def getClass(): Class[_ <: AnyVal]
Permalink

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

Definition Classes
Any
def isPosInfinity: Boolean
Permalink
def isWhole: Boolean
Permalink
def max(that: PosZFloat ): PosZFloat
Permalink
Returns this if this > that or that otherwise.
Returns this if this > that or that otherwise.
def min(that: PosZFloat ): PosZFloat
Permalink
Returns this if this < that or that otherwise.
Returns this if this < that or that otherwise.
def round: PosZInt
Permalink
def to(end: Float, step: Float): Inclusive[Float]
Permalink
Create an inclusive Range from this PosZFloat value to the specified end with the specified step value.
Create an inclusive Range from this PosZFloat 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]]
Permalink
Create an inclusive Range from this PosZFloat value to the specified end with step value 1.
Create an inclusive Range from this PosZFloat 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
Permalink
Converts this PosZFloat to a Byte.
Converts this PosZFloat to a Byte.
def toChar: Char
Permalink
Converts this PosZFloat to a Char.
Converts this PosZFloat to a Char.
def toDegrees: PosZFloat
Permalink
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
Permalink
Converts this PosZFloat to a Double.
Converts this PosZFloat to a Double.
def toFloat: Float
Permalink
Converts this PosZFloat to a Float.
Converts this PosZFloat to a Float.
def toInt: Int
Permalink
Converts this PosZFloat to an Int.
Converts this PosZFloat to an Int.
def toLong: Long
Permalink
Converts this PosZFloat to a Long.
Converts this PosZFloat to a Long.
def toRadians: PosZFloat
Permalink
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
Permalink
Converts this PosZFloat to a Short.
Converts this PosZFloat to a Short.
def toString(): String
Permalink
A string representation of this PosZFloat.
A string representation of this PosZFloat.

Definition Classes
PosZFloat → Any
def unary_+: PosZFloat
Permalink
Returns this value, unmodified.
def unary_-: Float
Permalink
Returns the negation of this value.
def until(end: Float, step: Float): Exclusive[Float]
Permalink
Create a Range from this PosZFloat value until the specified end (exclusive) with the specified step value.
Create a Range from this PosZFloat 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]]
Permalink
Create a Range from this PosZFloat value until the specified end (exclusive) with step value 1.
Create a Range from this PosZFloat 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
Permalink
The Float value underlying this PosZFloat.
The Float value underlying this PosZFloat.

PosZFloat

Related Docs: object PosZFloat | package anyvals

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

def floor: PosZFloat

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

final def isInstanceOf[T0]: Boolean

def isPosInfinity: Boolean

def isWhole: Boolean

def max(that: PosZFloat ): PosZFloat

def min(that: PosZFloat ): PosZFloat