final class NegFloat extends AnyVal
An AnyVal
for megative Float
s.
Note: a NegFloat
may not equal 0.0. If you want negative number or 0, use NegZFloat.
Because NegFloat
is an AnyVal
it
will usually be as efficient as an Float
, being
boxed only when an Float
would have been boxed.
The NegFloat.apply
factory method is implemented
in terms of a macro that checks literals for validity at
compile time. Calling NegFloat.apply
with a
literal Float
value will either produce a valid
NegFloat
instance at run time or an error at
compile time. Here's an example:
scala> import anyvals._ import anyvals._ scala> NegFloat(-42.1fF) res0: org.scalactic.anyvals.NegFloat = NegFloat(-42.1f) scala> NegFloat(0.0fF) <console>:14: error: NegFloat.apply can only be invoked on a megative (i < 0.0f) floating point literal, like NegFloat(-42.1fF). NegFloat(-42.1fF) ^
NegFloat.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 NegFloat.apply
, you'll get a compiler error
that suggests you use a different factor method,
NegFloat.from
, instead:
scala> val x = -42.1fF x: Float = -42.1f scala> NegFloat(x) <console>:15: error: NegFloat.apply can only be invoked on a floating point literal, like NegFloat(-42.1fF). Please use NegFloat.from instead. NegFloat(x) ^
The NegFloat.from
factory method will inspect
the value at runtime and return an
Option[NegFloat]
. If the value is valid,
NegFloat.from
will return a
Some[NegFloat]
, else it will return a
None
. Here's an example:
scala> NegFloat.from(x) res3: Option[org.scalactic.anyvals.NegFloat] = Some(NegFloat(-42.1f)) scala> val y = 0.0fF y: Float = 0.0f scala> NegFloat.from(y) res4: Option[org.scalactic.anyvals.NegFloat] = None
The NegFloat.apply
factory method is marked
implicit, so that you can pass literal Float
s
into methods that require NegFloat
, and get the
same compile-time checking you get when calling
NegFloat.apply
explicitly. Here's an example:
scala> def invert(pos: NegFloat): Float = Float.MaxValue - pos invert: (pos: org.scalactic.anyvals.NegFloat)Float scala> invert(-42.1fF) res5: Float = 3.4028235E38 scala> invert(Float.MaxValue) res6: Float = 0.0 scala> invert(0.0fF) <console>:15: error: NegFloat.apply can only be invoked on a megative (i < 0.0f) floating point literal, like NegFloat(-42.1fF). invert(0.0F) ^ scala> invert(0.0fF) <console>:15: error: NegFloat.apply can only be invoked on a megative (i < 0.0f) floating point literal, like NegFloat(-42.1fF). invert(0.0fF) ^
This example also demonstrates that the NegFloat
companion object also defines implicit widening conversions
when no loss of precision will occur. This makes it convenient to use a
NegFloat
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
NegFloat
(the type of pos
), you can
still subtract pos
, because the
NegFloat
will be implicitly widened to
Float
.
- Source
- NegFloat.scala
- Alphabetic
- By Inheritance
- NegFloat
- 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
NegFloat
'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: NegZFloat
Returns the smallest (closest to 0)
NegZFloat
that is greater than or equal to thisNegZFloat
and represents a mathematical integer. - def ensuringValid(f: (Float) => Float): NegFloat
Applies the passed
Float => Float
function to the underlyingFloat
value, and if the result is positive, returns the result wrapped in aNegFloat
, else throwsAssertionError
.Applies the passed
Float => Float
function to the underlyingFloat
value, and if the result is positive, returns the result wrapped in aNegFloat
, else throwsAssertionError
.This method will inspect the result of applying the given function to this
NegFloat
's underlyingFloat
value and if the result is megative, it will return aNegFloat
representing that value. Otherwise, theFloat
value returned by the given function is not megative, 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 megative. With this method, you are asserting that you are convinced the result of the computation represented by applying the given function to thisNegFloat
'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 thisNegFloat
's underlyingFloat
value.- returns
the result of applying this
NegFloat
's underlyingFloat
value to to the passed function, wrapped in aNegFloat
if it is megative (else throwsAssertionError
).
- Exceptions thrown
AssertionError
if the result of applying thisNegFloat
's underlyingFloat
value to to the passed function is not megative.
- def floor: NegFloat
Returns the greatest (closest to infinity)
NegFloat
that is less than or equal to thisNegFloat
and represents a mathematical integer. - def getClass(): Class[_ <: AnyVal]
- Definition Classes
- AnyVal → Any
- def isFinite: Boolean
True if this
NegFloat
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 isNegInfinity: Boolean
True if this
NegFloat
value represents negative infinity, else false. - def isWhole: Boolean
Indicates whether this
NegFloat
has a value that is a whole number: it is finite and it has no fraction part. - def max(that: NegFloat): NegFloat
Returns
this
ifthis > that
orthat
otherwise. - def min(that: NegFloat): NegFloat
Returns
this
ifthis < that
orthat
otherwise. - def plus(x: NegZFloat): NegFloat
Returns the
NegFloat
sum of thisNegFloat
's value and the givenNegZFloat
value.Returns the
NegFloat
sum of thisNegFloat
's value and the givenNegZFloat
value.This method will always succeed (not throw an exception) because adding a negative Float and non-positive Float and another negative Float will always result in another negative Float value (though the result may be infinity).
- def round: NegZInt
Rounds this
NegFloat
value to the nearest whole number value that can be expressed as anNegZInt
, returning the result as aNegZInt
. - def toByte: Byte
Converts this
NegFloat
to aByte
. - def toChar: Char
Converts this
NegFloat
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
NegFloat
to aDouble
. - def toFloat: Float
Converts this
NegFloat
to aFloat
. - def toInt: Int
Converts this
NegFloat
to anInt
. - def toLong: Long
Converts this
NegFloat
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
NegFloat
to aShort
. - def toString(): String
A string representation of this
NegFloat
.A string representation of this
NegFloat
.- Definition Classes
- NegFloat → Any
- def unary_+: NegFloat
Returns this value, unmodified.
- def unary_-: PosFloat
Returns the negation of this value.
- val value: Float