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
.
Value parameters
- value
-
The
Float
value underlying thisFiniteFloat
.
Attributes
- Companion
- object
- Source
- FiniteFloat.scala
- Graph
-
- Supertypes
-
class AnyValtrait Matchableclass Any
Members list
Value members
Concrete methods
Returns the remainder of the division of this value by x
.
Returns the remainder of the division of this value by x
.
Returns the remainder of the division of this value by x
.
Returns the remainder of the division of this value by x
.
Returns the remainder of the division of this value by x
.
Returns the remainder of the division of this value by x
.
Returns the remainder of the division of this value by x
.
Returns the remainder of the division of this value by x
.
Returns the remainder of the division of this value by x
.
Returns the remainder of the division of this value by x
.
Returns the remainder of the division of this value by x
.
Returns the remainder of the division of this value by x
.
Returns the remainder of the division of this value by x
.
Returns the remainder of the division of this value by x
.
Returns the product of this value and x
.
Returns the product of this value and x
.
Returns the product of this value and x
.
Returns the product of this value and x
.
Returns the product of this value and x
.
Returns the product of this value and x
.
Returns the product of this value and x
.
Returns the product of this value and x
.
Returns the product of this value and x
.
Returns the product of this value and x
.
Returns the product of this value and x
.
Returns the product of this value and x
.
Returns the product of this value and x
.
Returns the product of this value and x
.
Converts this FiniteDouble
's value to a string then concatenates the given string.
Converts this FiniteDouble
's value to a string then concatenates the given string.
Attributes
- Source
- FiniteDouble.scala
Returns the sum of this value and x
.
Returns the sum of this value and x
.
Returns the sum of this value and x
.
Returns the sum of this value and x
.
Returns the sum of this value and x
.
Returns the sum of this value and x
.
Returns the sum of this value and x
.
Converts this FiniteFloat
's value to a string then concatenates the given string.
Converts this FiniteFloat
's value to a string then concatenates the given string.
Attributes
- Source
- FiniteFloat.scala
Returns the sum of this value and x
.
Returns the sum of this value and x
.
Returns the sum of this value and x
.
Returns the sum of this value and x
.
Returns the sum of this value and x
.
Returns the sum of this value and x
.
Returns the sum of this value and x
.
Returns the difference of this value and x
.
Returns the difference of this value and x
.
Returns the difference of this value and x
.
Returns the difference of this value and x
.
Returns the difference of this value and x
.
Returns the difference of this value and x
.
Returns the difference of this value and x
.
Returns the difference of this value and x
.
Returns the difference of this value and x
.
Returns the difference of this value and x
.
Returns the difference of this value and x
.
Returns the difference of this value and x
.
Returns the difference of this value and x
.
Returns the difference of this value and x
.
Returns the quotient of this value and x
.
Returns the quotient of this value and x
.
Returns the quotient of this value and x
.
Returns the quotient of this value and x
.
Returns the quotient of this value and x
.
Returns the quotient of this value and x
.
Returns the quotient of this value and x
.
Returns the quotient of this value and x
.
Returns the quotient of this value and x
.
Returns the quotient of this value and x
.
Returns the quotient of this value and x
.
Returns the quotient of this value and x
.
Returns the quotient of this value and x
.
Returns the quotient of this value and x
.
Returns true
if this value is less than x, false
otherwise.
Returns true
if this value is less than x, false
otherwise.
Returns true
if this value is less than x, false
otherwise.
Returns true
if this value is less than x, false
otherwise.
Returns true
if this value is less than x, false
otherwise.
Returns true
if this value is less than x, false
otherwise.
Returns true
if this value is less than x, false
otherwise.
Returns true
if this value is less than x, false
otherwise.
Returns true
if this value is less than x, false
otherwise.
Returns true
if this value is less than x, false
otherwise.
Returns true
if this value is less than x, false
otherwise.
Returns true
if this value is less than x, false
otherwise.
Returns true
if this value is less than x, false
otherwise.
Returns true
if this value is less than x, false
otherwise.
Returns true
if this value is less than or equal to x, false
otherwise.
Returns true
if this value is less than or equal to x, false
otherwise.
Attributes
- Source
- FiniteDouble.scala
Returns true
if this value is less than or equal to x, false
otherwise.
Returns true
if this value is less than or equal to x, false
otherwise.
Attributes
- Source
- FiniteDouble.scala
Returns true
if this value is less than or equal to x, false
otherwise.
Returns true
if this value is less than or equal to x, false
otherwise.
Attributes
- Source
- FiniteDouble.scala
Returns true
if this value is less than or equal to x, false
otherwise.
Returns true
if this value is less than or equal to x, false
otherwise.
Attributes
- Source
- FiniteDouble.scala
Returns true
if this value is less than or equal to x, false
otherwise.
Returns true
if this value is less than or equal to x, false
otherwise.
Attributes
- Source
- FiniteDouble.scala
Returns true
if this value is less than or equal to x, false
otherwise.
Returns true
if this value is less than or equal to x, false
otherwise.
Attributes
- Source
- FiniteDouble.scala
Returns true
if this value is less than or equal to x, false
otherwise.
Returns true
if this value is less than or equal to x, false
otherwise.
Attributes
- Source
- FiniteDouble.scala
Returns true
if this value is less than or equal to x, false
otherwise.
Returns true
if this value is less than or equal to x, false
otherwise.
Attributes
- Source
- FiniteFloat.scala
Returns true
if this value is less than or equal to x, false
otherwise.
Returns true
if this value is less than or equal to x, false
otherwise.
Attributes
- Source
- FiniteFloat.scala
Returns true
if this value is less than or equal to x, false
otherwise.
Returns true
if this value is less than or equal to x, false
otherwise.
Attributes
- Source
- FiniteFloat.scala
Returns true
if this value is less than or equal to x, false
otherwise.
Returns true
if this value is less than or equal to x, false
otherwise.
Attributes
- Source
- FiniteFloat.scala
Returns true
if this value is less than or equal to x, false
otherwise.
Returns true
if this value is less than or equal to x, false
otherwise.
Attributes
- Source
- FiniteFloat.scala
Returns true
if this value is less than or equal to x, false
otherwise.
Returns true
if this value is less than or equal to x, false
otherwise.
Attributes
- Source
- FiniteFloat.scala
Returns true
if this value is less than or equal to x, false
otherwise.
Returns true
if this value is less than or equal to x, false
otherwise.
Attributes
- Source
- FiniteFloat.scala
Returns true
if this value is greater than x, false
otherwise.
Returns true
if this value is greater than x, false
otherwise.
Returns true
if this value is greater than x, false
otherwise.
Returns true
if this value is greater than x, false
otherwise.
Returns true
if this value is greater than x, false
otherwise.
Returns true
if this value is greater than x, false
otherwise.
Returns true
if this value is greater than x, false
otherwise.
Returns true
if this value is greater than x, false
otherwise.
Returns true
if this value is greater than x, false
otherwise.
Returns true
if this value is greater than x, false
otherwise.
Returns true
if this value is greater than x, false
otherwise.
Returns true
if this value is greater than x, false
otherwise.
Returns true
if this value is greater than x, false
otherwise.
Returns true
if this value is greater than x, false
otherwise.
Returns true
if this value is greater than or equal to x, false
otherwise.
Returns true
if this value is greater than or equal to x, false
otherwise.
Attributes
- Source
- FiniteDouble.scala
Returns true
if this value is greater than or equal to x, false
otherwise.
Returns true
if this value is greater than or equal to x, false
otherwise.
Attributes
- Source
- FiniteDouble.scala
Returns true
if this value is greater than or equal to x, false
otherwise.
Returns true
if this value is greater than or equal to x, false
otherwise.
Attributes
- Source
- FiniteDouble.scala
Returns true
if this value is greater than or equal to x, false
otherwise.
Returns true
if this value is greater than or equal to x, false
otherwise.
Attributes
- Source
- FiniteDouble.scala
Returns true
if this value is greater than or equal to x, false
otherwise.
Returns true
if this value is greater than or equal to x, false
otherwise.
Attributes
- Source
- FiniteDouble.scala
Returns true
if this value is greater than or equal to x, false
otherwise.
Returns true
if this value is greater than or equal to x, false
otherwise.
Attributes
- Source
- FiniteDouble.scala
Returns true
if this value is greater than or equal to x, false
otherwise.
Returns true
if this value is greater than or equal to x, false
otherwise.
Attributes
- Source
- FiniteDouble.scala
Returns true
if this value is greater than or equal to x, false
otherwise.
Returns true
if this value is greater than or equal to x, false
otherwise.
Attributes
- Source
- FiniteFloat.scala
Returns true
if this value is greater than or equal to x, false
otherwise.
Returns true
if this value is greater than or equal to x, false
otherwise.
Attributes
- Source
- FiniteFloat.scala
Returns true
if this value is greater than or equal to x, false
otherwise.
Returns true
if this value is greater than or equal to x, false
otherwise.
Attributes
- Source
- FiniteFloat.scala
Returns true
if this value is greater than or equal to x, false
otherwise.
Returns true
if this value is greater than or equal to x, false
otherwise.
Attributes
- Source
- FiniteFloat.scala
Returns true
if this value is greater than or equal to x, false
otherwise.
Returns true
if this value is greater than or equal to x, false
otherwise.
Attributes
- Source
- FiniteFloat.scala
Returns true
if this value is greater than or equal to x, false
otherwise.
Returns true
if this value is greater than or equal to x, false
otherwise.
Attributes
- Source
- FiniteFloat.scala
Returns true
if this value is greater than or equal to x, false
otherwise.
Returns true
if this value is greater than or equal to x, false
otherwise.
Attributes
- Source
- FiniteFloat.scala
Returns the smallest (closest to 0) FiniteDouble
that is greater than or equal to this FiniteDouble
and represents a mathematical integer.
Returns the smallest (closest to 0) FiniteDouble
that is greater than or equal to this FiniteDouble
and represents a mathematical integer.
Attributes
- Source
- FiniteDouble.scala
Returns the smallest (closest to 0) FiniteFloat
that is greater than or equal to this FiniteFloat
and represents a mathematical integer.
Returns the smallest (closest to 0) FiniteFloat
that is greater than or equal to this FiniteFloat
and represents a mathematical integer.
Attributes
- Source
- FiniteFloat.scala
Applies the passed Double => Double
function to the underlying Double
value, and if the result is positive, returns the result wrapped in a FiniteDouble
, else throws AssertionError
.
Applies the passed Double => Double
function to the underlying Double
value, and if the result is positive, returns the result wrapped in a FiniteDouble
, else throws AssertionError
.
This method will inspect the result of applying the given function to this FiniteDouble
's underlying Double
value and if the result is greater than 0.0
, it will return a FiniteDouble
representing that value. Otherwise, the Double
value returned by the given function is 0.0
or 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 Double
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 FiniteDouble
's value will not produce zero, a negative number, including Double.NegativeInfinity
, or Double.NaN
. Instead of producing such invalid values, this method will throw AssertionError
.
Value parameters
- f
-
the
Double => Double
function to apply to thisFiniteDouble
's underlyingDouble
value.
Attributes
- Returns
-
the result of applying this
FiniteDouble
's underlyingDouble
value to to the passed function, wrapped in aFiniteDouble
if it is positive (else throwsAssertionError
). - Throws
-
AssertionError
if the result of applying this
FiniteDouble
's underlyingDouble
value to to the passed function is not positive. - Source
- FiniteDouble.scala
Applies the passed Float => Float
function to the underlying Float
value, and if the result is positive, returns the result wrapped in a FiniteFloat
, 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 FiniteFloat
, else throws AssertionError
.
This method will inspect the result of applying the given function to this FiniteFloat
's underlying Float
value and if the result is finite, it will return a FiniteFloat
representing that value. Otherwise, the Float
value returned by the given function is not finite, 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. With this method, you are asserting that you are convinced the result of the computation represented by applying the given function to this FiniteFloat
's value will not produce invalid value. Instead of producing such invalid values, this method will throw AssertionError
.
Value parameters
- f
-
the
Float => Float
function to apply to thisFiniteFloat
's underlyingFloat
value.
Attributes
- Returns
-
the result of applying this
FiniteFloat
's underlyingFloat
value to to the passed function, wrapped in aFiniteFloat
if it is finite (else throwsAssertionError
). - Throws
-
AssertionError
if the result of applying this
FiniteFloat
's underlyingFloat
value to to the passed function is not finite. - Source
- FiniteFloat.scala
Returns the greatest (closest to infinity) FiniteDouble
that is less than or equal to this FiniteDouble
and represents a mathematical integer.
Returns the greatest (closest to infinity) FiniteDouble
that is less than or equal to this FiniteDouble
and represents a mathematical integer.
Attributes
- Source
- FiniteDouble.scala
Returns the greatest (closest to infinity) FiniteFloat
that is less than or equal to this FiniteFloat
and represents a mathematical integer.
Returns the greatest (closest to infinity) FiniteFloat
that is less than or equal to this FiniteFloat
and represents a mathematical integer.
Attributes
- Source
- FiniteFloat.scala
Indicates whether this FiniteDouble
has a value that is a whole number: it is finite and it has no fraction part.
Indicates whether this FiniteDouble
has a value that is a whole number: it is finite and it has no fraction part.
Attributes
- Source
- FiniteDouble.scala
Indicates whether this FiniteFloat
has a value that is a whole number: it is finite and it has no fraction part.
Indicates whether this FiniteFloat
has a value that is a whole number: it is finite and it has no fraction part.
Attributes
- Source
- FiniteFloat.scala
Returns this
if this > that
or that
otherwise.
Returns this
if this > that
or that
otherwise.
Returns this
if this < that
or that
otherwise.
Returns this
if this < that
or that
otherwise.
Rounds this FiniteDouble
value to the nearest whole number value that can be expressed as an Long
, returning the result as a Long
.
Rounds this FiniteDouble
value to the nearest whole number value that can be expressed as an Long
, returning the result as a Long
.
Attributes
- Source
- FiniteDouble.scala
Rounds this FiniteFloat
value to the nearest whole number value that can be expressed as an Int
, returning the result as a Int
.
Rounds this FiniteFloat
value to the nearest whole number value that can be expressed as an Int
, returning the result as a Int
.
Attributes
- Source
- FiniteFloat.scala
Converts this FiniteDouble
to a Byte
.
Converts this FiniteFloat
to a Byte
.
Converts this FiniteDouble
to a Char
.
Converts this FiniteFloat
to a Char
.
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.
Attributes
- Returns
-
the measurement of the angle x in degrees.
- Source
- FiniteDouble.scala
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.
Attributes
- Returns
-
the measurement of the angle x in degrees.
- Source
- FiniteFloat.scala
Converts this FiniteDouble
to a Double
.
Converts this FiniteFloat
to a Double
.
Converts this FiniteDouble
to a Float
.
Converts this FiniteFloat
to a Float
.
Converts this FiniteDouble
to an Int
.
Converts this FiniteFloat
to an Int
.
Converts this FiniteDouble
to a Long
.
Converts this FiniteFloat
to a Long
.
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.
Attributes
- Returns
-
the measurement of the angle x in radians.
- Source
- FiniteDouble.scala
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.
Attributes
- Returns
-
the measurement of the angle x in radians.
- Source
- FiniteFloat.scala
Converts this FiniteDouble
to a Short
.
Converts this FiniteFloat
to a Short
.
A string representation of this FiniteFloat
.
A string representation of this FiniteFloat
.
Attributes
- Definition Classes
-
Any
- Source
- FiniteFloat.scala
Returns this value, unmodified.
Returns this value, unmodified.
Returns the negation of this value.
Returns the negation of this value.
Concrete fields
Attributes
- Source
- FiniteDouble.scala
Attributes
- Source
- FiniteFloat.scala