An AnyVal for non-positive Floats.
Because NegZFloat is an AnyVal it will usually be as efficient as an Float, being boxed only when an Float would have been boxed.
The NegZFloat.apply factory method is implemented in terms of a macro that checks literals for validity at compile time. Calling NegZFloat.apply with a literal Float value will either produce a valid NegZFloat instance at run time or an error at compile time. Here's an example:
scala> import anyvals._
import anyvals._
scala> NegZFloat(-1.1fF)
res0: org.scalactic.anyvals.NegZFloat = NegZFloat(-1.1f)
scala> NegZFloat(1.1fF)
<console>:14: error: NegZFloat.apply can only be invoked on a non-positive (i <= 0.0f) floating point literal, like NegZFloat(-1.1fF).
NegZFloat(-1.1fF)
^
NegZFloat.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 NegZFloat.apply, you'll get a compiler error that suggests you use a different factor method, NegZFloat.from, instead:
scala> val x = -1.1fF
x: Float = -1.1f
scala> NegZFloat(x)
<console>:15: error: NegZFloat.apply can only be invoked on a floating point literal, like NegZFloat(-1.1fF). Please use NegZFloat.from instead.
NegZFloat(x)
^
The NegZFloat.from factory method will inspect the value at runtime and return an Option[NegZFloat]. If the value is valid, NegZFloat.from will return a Some[NegZFloat], else it will return a None. Here's an example:
scala> NegZFloat.from(x) res3: Option[org.scalactic.anyvals.NegZFloat] = Some(NegZFloat(-1.1f)) scala> val y = 1.1fF y: Float = 1.1f scala> NegZFloat.from(y) res4: Option[org.scalactic.anyvals.NegZFloat] = None
The NegZFloat.apply factory method is marked implicit, so that you can pass literal Floats into methods that require NegZFloat, and get the same compile-time checking you get when calling NegZFloat.apply explicitly. Here's an example:
scala> def invert(pos: NegZFloat): Float = Float.MaxValue - pos
invert: (pos: org.scalactic.anyvals.NegZFloat)Float
scala> invert(-1.1fF)
res5: Float = 3.4028235E38
scala> invert(Float.MaxValue)
res6: Float = 0.0
scala> invert(1.1fF)
<console>:15: error: NegZFloat.apply can only be invoked on a non-positive (i <= 0.0f) floating point literal, like NegZFloat(-1.1fF).
invert(0.0F)
^
scala> invert(1.1fF)
<console>:15: error: NegZFloat.apply can only be invoked on a non-positive (i <= 0.0f) floating point literal, like NegZFloat(-1.1fF).
invert(1.1fF)
^
This example also demonstrates that the NegZFloat companion object also defines implicit widening conversions when no loss of precision will occur. This makes it convenient to use a NegZFloat 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 NegZFloat (the type of pos), you can still subtract pos, because the NegZFloat will be implicitly widened to Float.
Value parameters
- value
-
The
Floatvalue underlying thisNegZFloat.
Attributes
- Companion
- object
- Source
- NegZFloat.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 NegZDouble's value to a string then concatenates the given string.
Converts this NegZDouble's value to a string then concatenates the given string.
Attributes
- Source
- NegZDouble.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 NegZFloat's value to a string then concatenates the given string.
Converts this NegZFloat's value to a string then concatenates the given string.
Attributes
- Source
- NegZFloat.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
- NegZDouble.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
- NegZDouble.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
- NegZDouble.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
- NegZDouble.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
- NegZDouble.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
- NegZDouble.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
- NegZDouble.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
- NegZFloat.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
- NegZFloat.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
- NegZFloat.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
- NegZFloat.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
- NegZFloat.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
- NegZFloat.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
- NegZFloat.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
- NegZDouble.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
- NegZDouble.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
- NegZDouble.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
- NegZDouble.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
- NegZDouble.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
- NegZDouble.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
- NegZDouble.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
- NegZFloat.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
- NegZFloat.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
- NegZFloat.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
- NegZFloat.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
- NegZFloat.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
- NegZFloat.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
- NegZFloat.scala
Returns the smallest (closest to 0) NegZDouble that is greater than or equal to this NegZDouble and represents a mathematical integer.
Returns the smallest (closest to 0) NegZDouble that is greater than or equal to this NegZDouble and represents a mathematical integer.
Attributes
- Source
- NegZDouble.scala
Returns the smallest (closest to 0) NegZFloat that is greater than or equal to this NegZFloat and represents a mathematical integer.
Returns the smallest (closest to 0) NegZFloat that is greater than or equal to this NegZFloat and represents a mathematical integer.
Attributes
- Source
- NegZFloat.scala
Applies the passed Double => Double function to the underlying Double value, and if the result is positive, returns the result wrapped in a NegZDouble, 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 NegZDouble, else throws AssertionError.
This method will inspect the result of applying the given function to this NegZDouble's underlying Double value and if the result is greater than 0.0, it will return a NegZDouble 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 NegZDouble'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 => Doublefunction to apply to thisNegZDouble's underlyingDoublevalue.
Attributes
- Returns
-
the result of applying this
NegZDouble's underlyingDoublevalue to to the passed function, wrapped in aNegZDoubleif it is positive (else throwsAssertionError). - Throws
-
AssertionError
if the result of applying this
NegZDouble's underlyingDoublevalue to to the passed function is not positive. - Source
- NegZDouble.scala
Applies the passed Float => Float function to the underlying Float value, and if the result is positive, returns the result wrapped in a NegZFloat, 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 NegZFloat, else throws AssertionError.
This method will inspect the result of applying the given function to this NegZFloat's underlying Float value and if the result is non-positive, it will return a NegZFloat representing that value. Otherwise, the Float value returned by the given function is not non-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 non-positive. With this method, you are asserting that you are convinced the result of the computation represented by applying the given function to this NegZFloat's value will not produce invalid value. Instead of producing such invalid values, this method will throw AssertionError.
Value parameters
- f
-
the
Float => Floatfunction to apply to thisNegZFloat's underlyingFloatvalue.
Attributes
- Returns
-
the result of applying this
NegZFloat's underlyingFloatvalue to to the passed function, wrapped in aNegZFloatif it is non-positive (else throwsAssertionError). - Throws
-
AssertionError
if the result of applying this
NegZFloat's underlyingFloatvalue to to the passed function is not non-positive. - Source
- NegZFloat.scala
Returns the greatest (closest to infinity) NegZDouble that is less than or equal to this NegZDouble and represents a mathematical integer.
Returns the greatest (closest to infinity) NegZDouble that is less than or equal to this NegZDouble and represents a mathematical integer.
Attributes
- Source
- NegZDouble.scala
Returns the greatest (closest to infinity) NegZFloat that is less than or equal to this NegZFloat and represents a mathematical integer.
Returns the greatest (closest to infinity) NegZFloat that is less than or equal to this NegZFloat and represents a mathematical integer.
Attributes
- Source
- NegZFloat.scala
True if this NegZDouble value is any finite value (i.e., it is neither positive nor negative infinity), else false.
True if this NegZDouble value is any finite value (i.e., it is neither positive nor negative infinity), else false.
Attributes
- Source
- NegZDouble.scala
True if this NegZFloat value is any finite value (i.e., it is neither positive nor negative infinity), else false.
True if this NegZFloat value is any finite value (i.e., it is neither positive nor negative infinity), else false.
Attributes
- Source
- NegZFloat.scala
True if this NegZDouble value represents negative infinity, else false.
True if this NegZDouble value represents negative infinity, else false.
Attributes
- Source
- NegZDouble.scala
True if this NegZFloat value represents negative infinity, else false.
True if this NegZFloat value represents negative infinity, else false.
Attributes
- Source
- NegZFloat.scala
Indicates whether this NegZDouble has a value that is a whole number: it is finite and it has no fraction part.
Indicates whether this NegZDouble has a value that is a whole number: it is finite and it has no fraction part.
Attributes
- Source
- NegZDouble.scala
Indicates whether this NegZFloat has a value that is a whole number: it is finite and it has no fraction part.
Indicates whether this NegZFloat has a value that is a whole number: it is finite and it has no fraction part.
Attributes
- Source
- NegZFloat.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.
Returns the NegZDouble sum of this value and x.
Returns the NegZDouble sum of this value and x.
This method will always succeed (not throw an exception) because adding a non-positive Double to another non-positive Double will always result in another non-positive Double value (though the result may be infinity).
Attributes
- Source
- NegZDouble.scala
Returns the NegZFloat sum of this value and x.
Returns the NegZFloat sum of this value and x.
This method will always succeed (not throw an exception) because adding a non-positive Float to another non-positive Float will always result in another non-positive Float value (though the result may be infinity).
Attributes
- Source
- NegZFloat.scala
Rounds this NegZDouble value to the nearest whole number value that can be expressed as an NegZLong, returning the result as a NegZLong.
Rounds this NegZDouble value to the nearest whole number value that can be expressed as an NegZLong, returning the result as a NegZLong.
Attributes
- Source
- NegZDouble.scala
Rounds this NegZFloat value to the nearest whole number value that can be expressed as an NegZInt, returning the result as a NegZInt.
Rounds this NegZFloat value to the nearest whole number value that can be expressed as an NegZInt, returning the result as a NegZInt.
Attributes
- Source
- NegZFloat.scala
Converts this NegZDouble to a Byte.
Converts this NegZFloat to a Byte.
Converts this NegZDouble to a Char.
Converts this NegZFloat 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
- NegZDouble.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
- NegZFloat.scala
Converts this NegZDouble to a Double.
Converts this NegZFloat to a Double.
Converts this NegZDouble to a Float.
Converts this NegZFloat to a Float.
Converts this NegZDouble to an Int.
Converts this NegZFloat to an Int.
Converts this NegZDouble to a Long.
Converts this NegZFloat 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
- NegZDouble.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
- NegZFloat.scala
Converts this NegZDouble to a Short.
Converts this NegZFloat to a Short.
A string representation of this NegZFloat.
Returns this value, unmodified.
Returns this value, unmodified.
Returns the negation of this value.
Returns the negation of this value.
Concrete fields
Attributes
- Source
- NegZDouble.scala
Attributes
- Source
- NegZFloat.scala