org.scalactic.anyvals.NegZFloat.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-positive Float
s.
*
*
*
*
*
*
* 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 Float
s
* 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
.
*
*
* @param value The Float
value underlying this NegZFloat
.
*/
final class NegZFloat private (val value: Float) extends AnyVal {
/**
* A string representation of this NegZFloat
.
*/
override def toString: String = s"NegZFloat(${value.toString()}f)"
/**
* Converts this NegZFloat
to a Byte
.
*/
def toByte: Byte = value.toByte
/**
* Converts this NegZFloat
to a Short
.
*/
def toShort: Short = value.toShort
/**
* Converts this NegZFloat
to a Char
.
*/
def toChar: Char = value.toChar
/**
* Converts this NegZFloat
to an Int
.
*/
def toInt: Int = value.toInt
/**
* Converts this NegZFloat
to a Long
.
*/
def toLong: Long = value.toLong
/**
* Converts this NegZFloat
to a Float
.
*/
def toFloat: Float = value.toFloat
/**
* Converts this NegZFloat
to a Double
.
*/
def toDouble: Double = value.toDouble
/** Returns this value, unmodified. */
def unary_+ : NegZFloat = this
/** Returns the negation of this value. */
def unary_- : PosZFloat = PosZFloat.ensuringValid(-value)
/**
* Converts this NegZFloat
'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: NegZFloat): NegZFloat = if (math.max(value, that.value) == value) this else that
/**
* Returns this
if this < that
or that
otherwise.
*/
def min(that: NegZFloat): NegZFloat = if (math.min(value, that.value) == value) this else that
/**
* Indicates whether this `NegZFloat` 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 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
.
*
*
* @param f the Float => Float
function to apply to this NegZFloat
's
* underlying Float
value.
* @return the result of applying this NegZFloat
's underlying Float
value to
* to the passed function, wrapped in a NegZFloat
if it is non-positive (else throws AssertionError
).
* @throws AssertionError if the result of applying this NegZFloat
's underlying Float
value to
* to the passed function is not non-positive.
*/
def ensuringValid(f: Float => Float): NegZFloat = {
val candidateResult: Float = f(value)
if (NegZFloatMacro.isValid(candidateResult)) new NegZFloat(candidateResult)
else throw new AssertionError(s"${candidateResult.toString()}, the result of applying the passed function to ${value.toString()}, was not a valid NegZFloat")
}
/**
* Rounds this `NegZFloat` value to the nearest whole number value that can be expressed as an `NegZInt`, returning the result as a `NegZInt`.
*/
def round: NegZInt = NegZInt.ensuringValid(math.round(value))
/**
* Returns the smallest (closest to 0) `NegZFloat` that is greater than or equal to this `NegZFloat`
* and represents a mathematical integer.
*/
def ceil: NegZFloat = NegZFloat.ensuringValid(math.ceil(value).toFloat)
/**
* Returns the greatest (closest to infinity) `NegZFloat` that is less than or equal to
* this `NegZFloat` and represents a mathematical integer.
*/
def floor: NegZFloat = NegZFloat.ensuringValid(math.floor(value).toFloat)
/**
* 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).
*
*/
def plus(x: NegZFloat): NegZFloat = NegZFloat.ensuringValid(value + x)
/**
* True if this NegZFloat
value represents negative infinity, else false.
*/
def isNegInfinity: Boolean = Float.NegativeInfinity == value
/**
* True if this NegZFloat
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 NegZFloat
that offers
* factory methods that produce NegZFloat
s,
* implicit widening conversions from NegZFloat
to
* other numeric types, and maximum and minimum constant values
* for NegZFloat
.
*/
object NegZFloat {
/**
* The largest value representable as a non-positive Float
,
* which is NegZFloat(0.0f)
.
*/
final val MaxValue: NegZFloat = NegZFloat.ensuringValid(0.0f)
/**
* The smallest value representable as a non-positive
* Float
, which is NegZFloat(-3.4028235E38)
.
*/
final val MinValue: NegZFloat = NegZFloat.ensuringValid(Float.MinValue) // Can't use the macro here
/**
* A factory method that produces an Option[NegZFloat]
given a
* Float
value.
*
*
* This method will inspect the passed Float
value and if
* it is a non-positive Float
, it will return a NegZFloat
* representing that value wrapped in a Some
. Otherwise, the passed Float
* value is not non-positive, 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-positive, return
* wrapped in a Some[NegZFloat]
.
* @return the specified Float
value wrapped in a
* Some[NegZFloat]
, if it is non-positive, else
* None
.
*/
def from(value: Float): Option[NegZFloat] =
if (NegZFloatMacro.isValid(value)) Some(new NegZFloat(value)) else None
/**
* A factory/assertion method that produces a NegZFloat
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-positive Float
, it will return a NegZFloat
representing that value.
* Otherwise, the passed Float
value is not non-positive, 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-positive, return
* wrapped in a NegZFloat
.
* @return the specified Float
value wrapped in a
* NegZFloat
, if it is non-positive, else
* throws AssertionError
.
* @throws AssertionError if the passed value is not non-positive
*/
def ensuringValid(value: Float): NegZFloat =
if (NegZFloatMacro.isValid(value)) new NegZFloat(value) else {
throw new AssertionError(s"${value.toString()} was not a valid NegZFloat")
}
/**
* A factory/validation method that produces a NegZFloat
, 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-positive Float
, it will return a NegZFloat
* representing that value, wrapped in a Success
.
* Otherwise, the passed Float
value is not non-positive, 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-positive, return
* wrapped in a Success(NegZFloat)
.
* @return the specified Float
value wrapped
* in a Success(NegZFloat)
, if it is non-positive, else a Failure(AssertionError)
.
*/
def tryingValid(value: Float): Try[NegZFloat] =
if (NegZFloatMacro.isValid(value))
Success(new NegZFloat(value))
else
Failure(new AssertionError(s"${value.toString()} was not a valid NegZFloat"))
/**
* 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-positive Float
, it will return a Pass
.
* Otherwise, the passed Float
value is non-positive, 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-positive.
* @return a `Pass` if the specified `Float` value is non-positive,
* 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 (NegZFloatMacro.isValid(value)) Pass else Fail(f(value))
/**
* A factory/validation method that produces a NegZFloat
, 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-positive Float
, it will return a NegZFloat
* representing that value, wrapped in a Good
.
* Otherwise, the passed Float
value is not non-positive, 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-positive, return
* wrapped in a Good(NegZFloat)
.
* @return the specified Float
value wrapped
* in a Good(NegZFloat)
, if it is non-positive, else a Bad(f(value))
.
*/
def goodOrElse[B](value: Float)(f: Float => B): NegZFloat Or B =
if (NegZFloatMacro.isValid(value)) Good(NegZFloat.ensuringValid(value)) else Bad(f(value))
/**
* A factory/validation method that produces a NegZFloat
, 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-positive Int
, it will return a NegZFloat
* representing that value, wrapped in a Right
.
* Otherwise, the passed Int
value is not non-positive, 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-positive, return
* wrapped in a Right(NegZFloat)
.
* @return the specified Int
value wrapped
* in a Right(NegZFloat)
, if it is non-positive, else a Left(f(value))
.
*/
def rightOrElse[L](value: Float)(f: Float => L): Either[L, NegZFloat] =
if (NegZFloatMacro.isValid(value)) Right(NegZFloat.ensuringValid(value)) else Left(f(value))
/**
* A predicate method that returns true if a given
* Float
value is non-positive.
*
* @param value the Float
to inspect, and if non-positive, return true.
* @return true if the specified Float
is non-positive, else false.
*/
def isValid(value: Float): Boolean = NegZFloatMacro.isValid(value)
/**
* A factory method that produces a NegZFloat
given a
* Float
value and a default NegZFloat
.
*
*
* This method will inspect the passed Float
value and if
* it is a non-positive Float
, it will return a NegZFloat
representing that value.
* Otherwise, the passed Float
value is not non-positive, 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-positive, return.
* @param default the NegZFloat
to return if the passed
* Float
value is not non-positive.
* @return the specified Float
value wrapped in a
* NegZFloat
, if it is non-positive, else the
* default
NegZFloat
value.
*/
def fromOrElse(value: Float, default: => NegZFloat): NegZFloat =
if (NegZFloatMacro.isValid(value)) new NegZFloat(value) else default
import language.experimental.macros
import scala.language.implicitConversions
/**
* A factory method, implemented via a macro, that produces a
* NegZFloat
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-positive Float
literal,
* it will return a NegZFloat
representing that value.
* Otherwise, the passed Float
expression is either a literal
* that is not non-positive, 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-positive, to return
* wrapped in a NegZFloat
at run time.
* @return the specified, valid Float
literal
* value wrapped in a NegZFloat
. (If the
* specified expression is not a valid Float
* literal, the invocation of this method will not
* compile.)
*/
inline implicit def apply(value: => Float): NegZFloat = ${ NegZFloatMacro('{value}) }
/**
* Implicit widening conversion from NegZFloat
to
* Float
.
*
* @param pos the NegZFloat
to widen
* @return the Float
value underlying the
* specified NegZFloat
*/
implicit def widenToFloat(pos: NegZFloat): Float = pos.value
/**
* Implicit widening conversion from NegZFloat
to
* Double
.
*
* @param pos the NegZFloat
to widen
* @return the Float
value underlying the
* specified NegZFloat
, widened to
* Double
.
*/
implicit def widenToDouble(pos: NegZFloat): Double = pos.value
/**
* Implicit widening conversion from NegZFloat
to NegZDouble
.
*
* @param pos the NegZFloat
to widen
* @return the Float
value underlying the specified NegZFloat
,
* widened to Double
and wrapped in a NegZDouble
.
*/
implicit def widenToNegZDouble(pos: NegZFloat): NegZDouble = NegZDouble.ensuringValid(pos.value)
/**
* Implicit Ordering instance.
*/
implicit val ordering: Ordering[NegZFloat] =
new Ordering[NegZFloat] {
def compare(x: NegZFloat, y: NegZFloat): Int = x.toFloat.compare(y)
}
/**
* The negative infinity value, which is NegZFloat.ensuringValid(Float.NegativeInfinity)
.
*/
final val NegativeInfinity: NegZFloat = NegZFloat.ensuringValid(Float.NegativeInfinity) // Can't use the macro here
}