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