org.scalactic.anyvals.NonZeroFloat.scala Maven / Gradle / Ivy
/*
* Copyright 2001-2016 Artima, Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.scalactic.anyvals
import scala.collection.immutable.NumericRange
import scala.language.implicitConversions
import scala.util.{Try, Success, Failure}
import org.scalactic.{Validation, Pass, Fail}
import org.scalactic.{Or, Good, Bad}
/**
* 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.
*
*
* @param value The Float value underlying this NonZeroFloat.
*/
final class NonZeroFloat private (val value: Float) extends AnyVal {
/**
* A string representation of this NonZeroFloat.
*/
override def toString: String = s"NonZeroFloat(${value.toString()}f)"
/**
* Converts this NonZeroFloat to a Byte.
*/
def toByte: Byte = value.toByte
/**
* Converts this NonZeroFloat to a Short.
*/
def toShort: Short = value.toShort
/**
* Converts this NonZeroFloat to a Char.
*/
def toChar: Char = value.toChar
/**
* Converts this NonZeroFloat to an Int.
*/
def toInt: Int = value.toInt
/**
* Converts this NonZeroFloat to a Long.
*/
def toLong: Long = value.toLong
/**
* Converts this NonZeroFloat to a Float.
*/
def toFloat: Float = value.toFloat
/**
* Converts this NonZeroFloat to a Double.
*/
def toDouble: Double = value.toDouble
/** Returns this value, unmodified. */
def unary_+ : NonZeroFloat = this
/** Returns the negation of this value. */
def unary_- : NonZeroFloat = NonZeroFloat.ensuringValid(-value)
/**
* Converts this NonZeroFloat's value to a string then concatenates the given string.
*/
def +(x: String): String = s"${value.toString()}${x.toString()}"
/** Returns `true` if this value is less than x, `false` otherwise. */
def <(x: Byte): Boolean = value < x
/** Returns `true` if this value is less than x, `false` otherwise. */
def <(x: Short): Boolean = value < x
/** Returns `true` if this value is less than x, `false` otherwise. */
def <(x: Char): Boolean = value < x
/** Returns `true` if this value is less than x, `false` otherwise. */
def <(x: Int): Boolean = value < x
/** Returns `true` if this value is less than x, `false` otherwise. */
def <(x: Long): Boolean = value < x
/** Returns `true` if this value is less than x, `false` otherwise. */
def <(x: Float): Boolean = value < x
/** Returns `true` if this value is less than x, `false` otherwise. */
def <(x: Double): Boolean = value < x
/** Returns `true` if this value is less than or equal to x, `false` otherwise. */
def <=(x: Byte): Boolean = value <= x
/** Returns `true` if this value is less than or equal to x, `false` otherwise. */
def <=(x: Short): Boolean = value <= x
/** Returns `true` if this value is less than or equal to x, `false` otherwise. */
def <=(x: Char): Boolean = value <= x
/** Returns `true` if this value is less than or equal to x, `false` otherwise. */
def <=(x: Int): Boolean = value <= x
/** Returns `true` if this value is less than or equal to x, `false` otherwise. */
def <=(x: Long): Boolean = value <= x
/** Returns `true` if this value is less than or equal to x, `false` otherwise. */
def <=(x: Float): Boolean = value <= x
/** Returns `true` if this value is less than or equal to x, `false` otherwise. */
def <=(x: Double): Boolean = value <= x
/** Returns `true` if this value is greater than x, `false` otherwise. */
def >(x: Byte): Boolean = value > x
/** Returns `true` if this value is greater than x, `false` otherwise. */
def >(x: Short): Boolean = value > x
/** Returns `true` if this value is greater than x, `false` otherwise. */
def >(x: Char): Boolean = value > x
/** Returns `true` if this value is greater than x, `false` otherwise. */
def >(x: Int): Boolean = value > x
/** Returns `true` if this value is greater than x, `false` otherwise. */
def >(x: Long): Boolean = value > x
/** Returns `true` if this value is greater than x, `false` otherwise. */
def >(x: Float): Boolean = value > x
/** Returns `true` if this value is greater than x, `false` otherwise. */
def >(x: Double): Boolean = value > x
/** Returns `true` if this value is greater than or equal to x, `false` otherwise. */
def >=(x: Byte): Boolean = value >= x
/** Returns `true` if this value is greater than or equal to x, `false` otherwise. */
def >=(x: Short): Boolean = value >= x
/** Returns `true` if this value is greater than or equal to x, `false` otherwise. */
def >=(x: Char): Boolean = value >= x
/** Returns `true` if this value is greater than or equal to x, `false` otherwise. */
def >=(x: Int): Boolean = value >= x
/** Returns `true` if this value is greater than or equal to x, `false` otherwise. */
def >=(x: Long): Boolean = value >= x
/** Returns `true` if this value is greater than or equal to x, `false` otherwise. */
def >=(x: Float): Boolean = value >= x
/** Returns `true` if this value is greater than or equal to x, `false` otherwise. */
def >=(x: Double): Boolean = value >= x
/** Returns the sum of this value and `x`. */
def +(x: Byte): Float = value + x
/** Returns the sum of this value and `x`. */
def +(x: Short): Float = value + x
/** Returns the sum of this value and `x`. */
def +(x: Char): Float = value + x
/** Returns the sum of this value and `x`. */
def +(x: Int): Float = value + x
/** Returns the sum of this value and `x`. */
def +(x: Long): Float = value + x
/** Returns the sum of this value and `x`. */
def +(x: Float): Float = value + x
/** Returns the sum of this value and `x`. */
def +(x: Double): Double = value + x
/** Returns the difference of this value and `x`. */
def -(x: Byte): Float = value - x
/** Returns the difference of this value and `x`. */
def -(x: Short): Float = value - x
/** Returns the difference of this value and `x`. */
def -(x: Char): Float = value - x
/** Returns the difference of this value and `x`. */
def -(x: Int): Float = value - x
/** Returns the difference of this value and `x`. */
def -(x: Long): Float = value - x
/** Returns the difference of this value and `x`. */
def -(x: Float): Float = value - x
/** Returns the difference of this value and `x`. */
def -(x: Double): Double = value - x
/** Returns the product of this value and `x`. */
def *(x: Byte): Float = value * x
/** Returns the product of this value and `x`. */
def *(x: Short): Float = value * x
/** Returns the product of this value and `x`. */
def *(x: Char): Float = value * x
/** Returns the product of this value and `x`. */
def *(x: Int): Float = value * x
/** Returns the product of this value and `x`. */
def *(x: Long): Float = value * x
/** Returns the product of this value and `x`. */
def *(x: Float): Float = value * x
/** Returns the product of this value and `x`. */
def *(x: Double): Double = value * x
/** Returns the quotient of this value and `x`. */
def /(x: Byte): Float = value / x
/** Returns the quotient of this value and `x`. */
def /(x: Short): Float = value / x
/** Returns the quotient of this value and `x`. */
def /(x: Char): Float = value / x
/** Returns the quotient of this value and `x`. */
def /(x: Int): Float = value / x
/** Returns the quotient of this value and `x`. */
def /(x: Long): Float = value / x
/** Returns the quotient of this value and `x`. */
def /(x: Float): Float = value / x
/** Returns the quotient of this value and `x`. */
def /(x: Double): Double = value / x
/** Returns the remainder of the division of this value by `x`. */
def %(x: Byte): Float = value % x
/** Returns the remainder of the division of this value by `x`. */
def %(x: Short): Float = value % x
/** Returns the remainder of the division of this value by `x`. */
def %(x: Char): Float = value % x
/** Returns the remainder of the division of this value by `x`. */
def %(x: Int): Float = value % x
/** Returns the remainder of the division of this value by `x`. */
def %(x: Long): Float = value % x
/** Returns the remainder of the division of this value by `x`. */
def %(x: Float): Float = value % x
/** Returns the remainder of the division of this value by `x`. */
def %(x: Double): Double = value % x
// Stuff from RichFloat
/**
* Returns this if this > that or that otherwise.
*/
def max(that: NonZeroFloat): NonZeroFloat = if (math.max(value, that.value) == value) this else that
/**
* Returns this if this < that or that otherwise.
*/
def min(that: NonZeroFloat): NonZeroFloat = if (math.min(value, that.value) == value) this else that
/**
* Indicates whether this `NonZeroFloat` has a value that is a whole number: it is finite and it has no fraction part.
*/
def isWhole = {
val longValue = value.toLong
longValue.toFloat == value || longValue == Long.MaxValue && value < Float.PositiveInfinity || longValue == Long.MinValue && value > Float.NegativeInfinity
}
/** Converts an angle measured in degrees to an approximately equivalent
* angle measured in radians.
*
* @return the measurement of the angle x in radians.
*/
def toRadians: Float = math.toRadians(value.toDouble).toFloat
/** Converts an angle measured in radians to an approximately equivalent
* angle measured in degrees.
* @return the measurement of the angle x in degrees.
*/
def toDegrees: Float = math.toDegrees(value.toDouble).toFloat
/**
* 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.
*
*
* @param f the Float => Float function to apply to this NonZeroFloat's
* underlying Float value.
* @return the result of applying this NonZeroFloat's underlying Float value to
* to the passed function, wrapped in a NonZeroFloat if it is non-zero (else throws AssertionError).
* @throws AssertionError if the result of applying this NonZeroFloat's underlying Float value to
* to the passed function is not non-zero.
*/
def ensuringValid(f: Float => Float): NonZeroFloat = {
val candidateResult: Float = f(value)
if (NonZeroFloatMacro.isValid(candidateResult)) new NonZeroFloat(candidateResult)
else throw new AssertionError(s"${candidateResult.toString()}, the result of applying the passed function to ${value.toString()}, was not a valid NonZeroFloat")
}
/**
* True if this NonZeroFloat value represents positive infinity, else false.
*/
def isPosInfinity: Boolean = Float.PositiveInfinity == value
/**
* True if this NonZeroFloat value represents negative infinity, else false.
*/
def isNegInfinity: Boolean = Float.NegativeInfinity == value
/**
* True if this NonZeroFloat value represents positive or negative infinity, else false.
*/
def isInfinite: Boolean = value.isInfinite
/**
* True if this NonZeroFloat value is any finite value (i.e., it is neither positive nor negative infinity), else false.
*/
def isFinite: Boolean = !value.isInfinite
}
/**
* The companion object for NonZeroFloat that offers
* factory methods that produce NonZeroFloats,
* implicit widening conversions from NonZeroFloat to
* other numeric types, and maximum and minimum constant values
* for NonZeroFloat.
*/
object NonZeroFloat {
/**
* The largest value representable as a non-zero Float,
* which is NonZeroFloat(3.4028235E38).
*/
final val MaxValue: NonZeroFloat = NonZeroFloat.ensuringValid(Float.MaxValue)
/**
* The smallest value representable as a non-zero
* Float, which is NonZeroFloat(-3.4028235E38).
*/
final val MinValue: NonZeroFloat = NonZeroFloat.ensuringValid(Float.MinValue) // Can't use the macro here
/**
* A factory method that produces an Option[NonZeroFloat] given a
* Float value.
*
*
* This method will inspect the passed Float value and if
* it is a non-zero Float, it will return a NonZeroFloat
* representing that value wrapped in a Some. Otherwise, the passed Float
* value is not non-zero, so this method will return None.
*
*
*
* This factory method differs from the apply
* factory method in that apply is implemented
* via a macro that inspects Float literals at
* compile time, whereas from inspects
* Float values at run time.
*
*
* @param value the Float to inspect, and if non-zero, return
* wrapped in a Some[NonZeroFloat].
* @return the specified Float value wrapped in a
* Some[NonZeroFloat], if it is non-zero, else
* None.
*/
def from(value: Float): Option[NonZeroFloat] =
if (NonZeroFloatMacro.isValid(value)) Some(new NonZeroFloat(value)) else None
/**
* A factory/assertion method that produces a NonZeroFloat given a
* valid Float value, or throws AssertionError,
* if given an invalid Float value.
*
* Note: you should use this method only when you are convinced that it will
* always succeed, i.e., never throw an exception. It is good practice to
* add a comment near the invocation of this method indicating ''why'' you think
* it will always succeed to document your reasoning. If you are not sure an
* `ensuringValid` call will always succeed, you should use one of the other
* factory or validation methods provided on this object instead: `isValid`,
* `tryingValid`, `passOrElse`, `goodOrElse`, or `rightOrElse`.
*
*
* This method will inspect the passed Float value and if
* it is a non-zero Float, it will return a NonZeroFloat representing that value.
* Otherwise, the passed Float value is not non-zero, so
* this method will throw AssertionError.
*
*
*
* This factory method differs from the apply
* factory method in that apply is implemented
* via a macro that inspects Float literals at
* compile time, whereas from inspects
* Float values at run time.
* It 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 a Float is positive.
*
*
* @param value the Float to inspect, and if non-zero, return
* wrapped in a NonZeroFloat.
* @return the specified Float value wrapped in a
* NonZeroFloat, if it is non-zero, else
* throws AssertionError.
* @throws AssertionError if the passed value is not non-zero
*/
def ensuringValid(value: Float): NonZeroFloat =
if (NonZeroFloatMacro.isValid(value)) new NonZeroFloat(value) else {
throw new AssertionError(s"${value.toString()} was not a valid NonZeroFloat")
}
/**
* A factory/validation method that produces a NonZeroFloat, wrapped
* in a Success, given a valid Float value, or if the
* given Float is invalid, an AssertionError, wrapped
* in a Failure.
*
*
* This method will inspect the passed Float value and if
* it is a non-zero Float, it will return a NonZeroFloat
* representing that value, wrapped in a Success.
* Otherwise, the passed Float value is not non-zero, so this
* method will return an AssertionError, wrapped in a Failure.
*
*
*
* This factory method differs from the apply factory method
* in that apply is implemented via a macro that inspects
* Float literals at compile time, whereas this method inspects
* Float values at run time.
*
*
* @param value the Float to inspect, and if non-zero, return
* wrapped in a Success(NonZeroFloat).
* @return the specified Float value wrapped
* in a Success(NonZeroFloat), if it is non-zero, else a Failure(AssertionError).
*/
def tryingValid(value: Float): Try[NonZeroFloat] =
if (NonZeroFloatMacro.isValid(value))
Success(new NonZeroFloat(value))
else
Failure(new AssertionError(s"${value.toString()} was not a valid NonZeroFloat"))
/**
* A validation method that produces a Pass
* given a valid Float value, or
* an error value of type E produced by passing the
* given invalid Int value
* to the given function f, wrapped in a Fail.
*
*
* This method will inspect the passed Float value and if
* it is a non-zero Float, it will return a Pass.
* Otherwise, the passed Float value is non-zero, so this
* method will return a result of type E obtained by passing
* the invalid Float value to the given function f,
* wrapped in a `Fail`.
*
*
*
* This factory method differs from the apply factory method
* in that apply is implemented via a macro that inspects
* Float literals at compile time, whereas this method inspects
* Float values at run time.
*
*
* @param value the `Float` to validate that it is non-zero.
* @return a `Pass` if the specified `Float` value is non-zero,
* else a `Fail` containing an error value produced by passing the
* specified `Float` to the given function `f`.
*/
def passOrElse[E](value: Float)(f: Float => E): Validation[E] =
if (NonZeroFloatMacro.isValid(value)) Pass else Fail(f(value))
/**
* A factory/validation method that produces a NonZeroFloat, wrapped
* in a Good, given a valid Float value, or if the
* given Float is invalid, an error value of type B
* produced by passing the given invalid Float value
* to the given function f, wrapped in a Bad.
*
*
* This method will inspect the passed Float value and if
* it is a non-zero Float, it will return a NonZeroFloat
* representing that value, wrapped in a Good.
* Otherwise, the passed Float value is not non-zero, so this
* method will return a result of type B obtained by passing
* the invalid Float value to the given function f,
* wrapped in a `Bad`.
*
*
*
* This factory method differs from the apply factory method
* in that apply is implemented via a macro that inspects
* Float literals at compile time, whereas this method inspects
* Float values at run time.
*
*
* @param value the Float to inspect, and if non-zero, return
* wrapped in a Good(NonZeroFloat).
* @return the specified Float value wrapped
* in a Good(NonZeroFloat), if it is non-zero, else a Bad(f(value)).
*/
def goodOrElse[B](value: Float)(f: Float => B): NonZeroFloat Or B =
if (NonZeroFloatMacro.isValid(value)) Good(NonZeroFloat.ensuringValid(value)) else Bad(f(value))
/**
* A factory/validation method that produces a NonZeroFloat, wrapped
* in a Right, given a valid Int value, or if the
* given Int is invalid, an error value of type L
* produced by passing the given invalid Int value
* to the given function f, wrapped in a Left.
*
*
* This method will inspect the passed Int value and if
* it is a non-zero Int, it will return a NonZeroFloat
* representing that value, wrapped in a Right.
* Otherwise, the passed Int value is not non-zero, so this
* method will return a result of type L obtained by passing
* the invalid Int value to the given function f,
* wrapped in a `Left`.
*
*
*
* This factory method differs from the apply factory method
* in that apply is implemented via a macro that inspects
* Int literals at compile time, whereas this method inspects
* Int values at run time.
*
*
* @param value the Int to inspect, and if non-zero, return
* wrapped in a Right(NonZeroFloat).
* @return the specified Int value wrapped
* in a Right(NonZeroFloat), if it is non-zero, else a Left(f(value)).
*/
def rightOrElse[L](value: Float)(f: Float => L): Either[L, NonZeroFloat] =
if (NonZeroFloatMacro.isValid(value)) Right(NonZeroFloat.ensuringValid(value)) else Left(f(value))
/**
* A predicate method that returns true if a given
* Float value is non-zero.
*
* @param value the Float to inspect, and if non-zero, return true.
* @return true if the specified Float is non-zero, else false.
*/
def isValid(value: Float): Boolean = NonZeroFloatMacro.isValid(value)
/**
* A factory method that produces a NonZeroFloat given a
* Float value and a default NonZeroFloat.
*
*
* This method will inspect the passed Float value and if
* it is a non-zero Float, it will return a NonZeroFloat representing that value.
* Otherwise, the passed Float value is not non-zero, so this
* method will return the passed default value.
*
*
*
* This factory method differs from the apply
* factory method in that apply is implemented
* via a macro that inspects Float literals at
* compile time, whereas from inspects
* Float values at run time.
*
*
* @param value the Float to inspect, and if non-zero, return.
* @param default the NonZeroFloat to return if the passed
* Float value is not non-zero.
* @return the specified Float value wrapped in a
* NonZeroFloat, if it is non-zero, else the
* default NonZeroFloat value.
*/
def fromOrElse(value: Float, default: => NonZeroFloat): NonZeroFloat =
if (NonZeroFloatMacro.isValid(value)) new NonZeroFloat(value) else default
import language.experimental.macros
import scala.language.implicitConversions
/**
* A factory method, implemented via a macro, that produces a
* NonZeroFloat if passed a valid Float
* literal, otherwise a compile time error.
*
*
* The macro that implements this method will inspect the
* specified Float expression at compile time. If
* the expression is a non-zero Float literal,
* it will return a NonZeroFloat representing that value.
* Otherwise, the passed Float expression is either a literal
* that is not non-zero, or is not a literal, so this method
* will give a compiler error.
*
*
*
* This factory method differs from the from
* factory method in that this method is implemented via a
* macro that inspects Float literals at compile
* time, whereas from inspects Float
* values at run time.
*
*
* @param value the Float literal expression to
* inspect at compile time, and if non-zero, to return
* wrapped in a NonZeroFloat at run time.
* @return the specified, valid Float literal
* value wrapped in a NonZeroFloat. (If the
* specified expression is not a valid Float
* literal, the invocation of this method will not
* compile.)
*/
inline implicit def apply(value: => Float): NonZeroFloat = ${ NonZeroFloatMacro('{value}) }
/**
* Implicit widening conversion from NonZeroFloat to
* Float.
*
* @param pos the NonZeroFloat to widen
* @return the Float value underlying the
* specified NonZeroFloat
*/
implicit def widenToFloat(pos: NonZeroFloat): Float = pos.value
/**
* Implicit widening conversion from NonZeroFloat to
* Double.
*
* @param pos the NonZeroFloat to widen
* @return the Float value underlying the
* specified NonZeroFloat, widened to
* Double.
*/
implicit def widenToDouble(pos: NonZeroFloat): Double = pos.value
/**
* Implicit widening conversion from NonZeroFloat to NonZeroDouble.
*
* @param pos the NonZeroFloat to widen
* @return the Float value underlying the specified NonZeroFloat,
* widened to Double and wrapped in a NonZeroDouble.
*/
implicit def widenToNonZeroDouble(pos: NonZeroFloat): NonZeroDouble = NonZeroDouble.ensuringValid(pos.value)
/**
* Implicit Ordering instance.
*/
implicit val ordering: Ordering[NonZeroFloat] =
new Ordering[NonZeroFloat] {
def compare(x: NonZeroFloat, y: NonZeroFloat): Int = x.toFloat.compare(y)
}
/**
* The positive infinity value, which is NonZeroFloat.ensuringValid(Float.PositiveInfinity).
*/
final val PositiveInfinity: NonZeroFloat = NonZeroFloat.ensuringValid(Float.PositiveInfinity) // Can't use the macro here
/**
* The negative infinity value, which is NonZeroFloat.ensuringValid(Float.NegativeInfinity).
*/
final val NegativeInfinity: NonZeroFloat = NonZeroFloat.ensuringValid(Float.NegativeInfinity) // Can't use the macro here
/**
* The smallest positive value greater than 0.0d representable as a NonZeroFloat, which is NonZeroFloat(1.4E-45).
*/
final val MinPositiveValue: NonZeroFloat = NonZeroFloat.ensuringValid(Float.MinPositiveValue)
}