final class FiniteFloat extends AnyVal
An AnyVal
for finite Float
s.
Because FiniteFloat
is an AnyVal
it
will usually be as efficient as an Float
, being
boxed only when an Float
would have been boxed.
The FiniteFloat.apply
factory method is implemented
in terms of a macro that checks literals for validity at
compile time. Calling FiniteFloat.apply
with a
literal Float
value will either produce a valid
FiniteFloat
instance at run time or an error at
compile time. Here's an example:
scala> import anyvals._ import anyvals._ scala> FiniteFloat(42.1fF) res0: org.scalactic.anyvals.FiniteFloat = FiniteFloat(42.1f) scala> FiniteFloat(Float.PositiveInfinityF) <console>:14: error: FiniteFloat.apply can only be invoked on a finite (i != Float.NegativeInfinity && i != Float.PositiveInfinity && !i.isNaN) floating point literal, like FiniteFloat(42.1fF). FiniteFloat(42.1fF) ^
FiniteFloat.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 FiniteFloat.apply
, you'll get a compiler error
that suggests you use a different factor method,
FiniteFloat.from
, instead:
scala> val x = 42.1fF x: Float = 42.1f scala> FiniteFloat(x) <console>:15: error: FiniteFloat.apply can only be invoked on a floating point literal, like FiniteFloat(42.1fF). Please use FiniteFloat.from instead. FiniteFloat(x) ^
The FiniteFloat.from
factory method will inspect
the value at runtime and return an
Option[FiniteFloat]
. If the value is valid,
FiniteFloat.from
will return a
Some[FiniteFloat]
, else it will return a
None
. Here's an example:
scala> FiniteFloat.from(x) res3: Option[org.scalactic.anyvals.FiniteFloat] = Some(FiniteFloat(42.1f)) scala> val y = Float.PositiveInfinityF y: Float = Float.PositiveInfinity scala> FiniteFloat.from(y) res4: Option[org.scalactic.anyvals.FiniteFloat] = None
The FiniteFloat.apply
factory method is marked
implicit, so that you can pass literal Float
s
into methods that require FiniteFloat
, and get the
same compile-time checking you get when calling
FiniteFloat.apply
explicitly. Here's an example:
scala> def invert(pos: FiniteFloat): Float = Float.MaxValue - pos invert: (pos: org.scalactic.anyvals.FiniteFloat)Float scala> invert(42.1fF) res5: Float = 3.4028235E38 scala> invert(Float.MaxValue) res6: Float = 0.0 scala> invert(Float.PositiveInfinityF) <console>:15: error: FiniteFloat.apply can only be invoked on a finite (i != Float.NegativeInfinity && i != Float.PositiveInfinity && !i.isNaN) floating point literal, like FiniteFloat(42.1fF). invert(0.0F) ^ scala> invert(Float.PositiveInfinityF) <console>:15: error: FiniteFloat.apply can only be invoked on a finite (i != Float.NegativeInfinity && i != Float.PositiveInfinity && !i.isNaN) floating point literal, like FiniteFloat(42.1fF). invert(Float.PositiveInfinityF) ^
This example also demonstrates that the FiniteFloat
companion object also defines implicit widening conversions
when no loss of precision will occur. This makes it convenient to use a
FiniteFloat
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
FiniteFloat
(the type of pos
), you can
still subtract pos
, because the
FiniteFloat
will be implicitly widened to
Float
.
- Source
- FiniteFloat.scala
- Alphabetic
- By Inheritance
- FiniteFloat
- AnyVal
- Any
- Hide All
- Show All
- Public
- Protected
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
FiniteFloat
'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: FiniteFloat
Returns the smallest (closest to 0)
FiniteFloat
that is greater than or equal to thisFiniteFloat
and represents a mathematical integer. - def ensuringValid(f: (Float) => Float): FiniteFloat
Applies the passed
Float => Float
function to the underlyingFloat
value, and if the result is positive, returns the result wrapped in aFiniteFloat
, else throwsAssertionError
.Applies the passed
Float => Float
function to the underlyingFloat
value, and if the result is positive, returns the result wrapped in aFiniteFloat
, else throwsAssertionError
.This method will inspect the result of applying the given function to this
FiniteFloat
's underlyingFloat
value and if the result is finite, it will return aFiniteFloat
representing that value. Otherwise, theFloat
value returned by the given function is not finite, so this method will throwAssertionError
.This method differs from a vanilla
assert
orensuring
call in that you get something you didn't already have if the assertion succeeds: a type that promises anFloat
is finite. With this method, you are asserting that you are convinced the result of the computation represented by applying the given function to thisFiniteFloat
's value will not produce invalid value. Instead of producing such invalid values, this method will throwAssertionError
.- f
the
Float => Float
function to apply to thisFiniteFloat
's underlyingFloat
value.- returns
the result of applying this
FiniteFloat
's underlyingFloat
value to to the passed function, wrapped in aFiniteFloat
if it is finite (else throwsAssertionError
).
- Exceptions thrown
AssertionError
if the result of applying thisFiniteFloat
's underlyingFloat
value to to the passed function is not finite.
- def floor: FiniteFloat
Returns the greatest (closest to infinity)
FiniteFloat
that is less than or equal to thisFiniteFloat
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
FiniteFloat
has a value that is a whole number: it is finite and it has no fraction part. - def max(that: FiniteFloat): FiniteFloat
Returns
this
ifthis > that
orthat
otherwise. - def min(that: FiniteFloat): FiniteFloat
Returns
this
ifthis < that
orthat
otherwise. - def round: Int
Rounds this
FiniteFloat
value to the nearest whole number value that can be expressed as anInt
, returning the result as aInt
. - def toByte: Byte
Converts this
FiniteFloat
to aByte
. - def toChar: Char
Converts this
FiniteFloat
to aChar
. - 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
FiniteFloat
to aDouble
. - def toFloat: Float
Converts this
FiniteFloat
to aFloat
. - def toInt: Int
Converts this
FiniteFloat
to anInt
. - def toLong: Long
Converts this
FiniteFloat
to aLong
. - 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
FiniteFloat
to aShort
. - def toString(): String
A string representation of this
FiniteFloat
.A string representation of this
FiniteFloat
.- Definition Classes
- FiniteFloat → Any
- def unary_+: FiniteFloat
Returns this value, unmodified.
- def unary_-: FiniteFloat
Returns the negation of this value.
- val value: Float