org.scalactic.anyvals.PosZFiniteDouble.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 finite non-negative Doubles.
*
*
*
*
*
*
* Because PosZFiniteDouble is an AnyVal it
* will usually be as efficient as an Double, being
* boxed only when a Double would have been boxed.
*
*
*
* The PosZFiniteDouble.apply factory method is
* implemented in terms of a macro that checks literals for
* validity at compile time. Calling
* PosZFiniteDouble.apply with a literal
* Double value will either produce a valid
* PosZFiniteDouble instance at run time or an error at
* compile time. Here's an example:
*
*
*
* scala> import anyvals._
* import anyvals._
*
* scala> PosZFiniteDouble(1.1)
* res1: org.scalactic.anyvals.PosZFiniteDouble = PosZFiniteDouble(1.1)
*
* scala> PosZFiniteDouble(-1.1)
* <console>:14: error: PosZFiniteDouble.apply can only be invoked on a finite non-negative (i >= 0.0 && i != Double.PositiveInfinity) floating point literal, like PosZFiniteDouble(1.1).
* PosZFiniteDouble(-1.1)
* ^
*
*
*
* PosZFiniteDouble.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 PosZFiniteDouble.apply, you'll get a
* compiler error that suggests you use a different factor
* method, PosZFiniteDouble.from, instead:
*
*
*
* scala> val x = 1.1
* x: Double = 1.1
*
* scala> PosZFiniteDouble(x)
* <console>:15: error: PosZFiniteDouble.apply can only be invoked on a floating point literal, like PosZFiniteDouble(1.1). Please use PosZFiniteDouble.from instead.
* PosZFiniteDouble(x)
* ^
*
*
*
* The PosZFiniteDouble.from factory method will inspect
* the value at runtime and return an
* Option[PosZFiniteDouble]. If the value is valid,
* PosZFiniteDouble.from will return a
* Some[PosZFiniteDouble], else it will return a
* None. Here's an example:
*
*
*
* scala> PosZFiniteDouble.from(x)
* res4: Option[org.scalactic.anyvals.PosZFiniteDouble] = Some(PosZFiniteDouble(1.1))
*
* scala> val y = -1.1
* y: Double = -1.1
*
* scala> PosZFiniteDouble.from(y)
* res5: Option[org.scalactic.anyvals.PosZFiniteDouble] = None
*
*
*
* The PosZFiniteDouble.apply factory method is marked
* implicit, so that you can pass literal Doubles
* into methods that require PosZFiniteDouble, and get the
* same compile-time checking you get when calling
* PosZFiniteDouble.apply explicitly. Here's an example:
*
*
*
* scala> def invert(pos: PosZFiniteDouble): Double = Double.MaxValue - pos
* invert: (pos: org.scalactic.anyvals.PosZFiniteDouble)Double
*
* scala> invert(1.1)
* res6: Double = 1.7976931348623157E308
*
* scala> invert(Double.MaxValue)
* res8: Double = 0.0
*
* scala> invert(-1.1)
* <console>:15: error: PosZFiniteDouble.apply can only be invoked on a finite non-negative (i >= 0.0 && i != Double.PositiveInfinity) floating point literal, like PosZFiniteDouble(1.1).
* invert(-1.1)
* ^
*
*
*
*
* This example also demonstrates that the
* PosZFiniteDouble companion object also defines implicit
* widening conversions when a similar conversion is provided in
* Scala. This makes it convenient to use a
* PosZFiniteDouble where a Double is
* needed. An example is the subtraction in the body of the
* invert method defined above,
* Double.MaxValue - pos. Although
* Double.MaxValue is a Double, which
* has no - method that takes a
* PosZFiniteDouble (the type of pos), you
* can still subtract pos, because the
* PosZFiniteDouble will be implicitly widened to
* Double.
*
*
* @param value The Double value underlying this PosZFiniteDouble.
*/
final class PosZFiniteDouble private (val value: Double) extends AnyVal {
/**
* A string representation of this PosZFiniteDouble.
*/
override def toString: String = s"PosZFiniteDouble(${value.toString()})"
/**
* Converts this PosZFiniteDouble to a Byte.
*/
def toByte: Byte = value.toByte
/**
* Converts this PosZFiniteDouble to a Short.
*/
def toShort: Short = value.toShort
/**
* Converts this PosZFiniteDouble to a Char.
*/
def toChar: Char = value.toChar
/**
* Converts this PosZFiniteDouble to an Int.
*/
def toInt: Int = value.toInt
/**
* Converts this PosZFiniteDouble to a Long.
*/
def toLong: Long = value.toLong
/**
* Converts this PosZFiniteDouble to a Float.
*/
def toFloat: Float = value.toFloat
/**
* Converts this PosZFiniteDouble to a Double.
*/
def toDouble: Double = value.toDouble
/** Returns this value, unmodified. */
def unary_+ : PosZFiniteDouble = this
/** Returns the negation of this value. */
def unary_- : NegZFiniteDouble = NegZFiniteDouble.ensuringValid(-value)
/**
* Converts this PosZFiniteDouble'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): Double = value + x
/** Returns the sum of this value and `x`. */
def +(x: Short): Double = value + x
/** Returns the sum of this value and `x`. */
def +(x: Char): Double = value + x
/** Returns the sum of this value and `x`. */
def +(x: Int): Double = value + x
/** Returns the sum of this value and `x`. */
def +(x: Long): Double = value + x
/** Returns the sum of this value and `x`. */
def +(x: Float): Double = 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): Double = value - x
/** Returns the difference of this value and `x`. */
def -(x: Short): Double = value - x
/** Returns the difference of this value and `x`. */
def -(x: Char): Double = value - x
/** Returns the difference of this value and `x`. */
def -(x: Int): Double = value - x
/** Returns the difference of this value and `x`. */
def -(x: Long): Double = value - x
/** Returns the difference of this value and `x`. */
def -(x: Float): Double = 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): Double = value * x
/** Returns the product of this value and `x`. */
def *(x: Short): Double = value * x
/** Returns the product of this value and `x`. */
def *(x: Char): Double = value * x
/** Returns the product of this value and `x`. */
def *(x: Int): Double = value * x
/** Returns the product of this value and `x`. */
def *(x: Long): Double = value * x
/** Returns the product of this value and `x`. */
def *(x: Float): Double = 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): Double = value / x
/** Returns the quotient of this value and `x`. */
def /(x: Short): Double = value / x
/** Returns the quotient of this value and `x`. */
def /(x: Char): Double = value / x
/** Returns the quotient of this value and `x`. */
def /(x: Int): Double = value / x
/** Returns the quotient of this value and `x`. */
def /(x: Long): Double = value / x
/** Returns the quotient of this value and `x`. */
def /(x: Float): Double = 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): Double = value % x
/** Returns the remainder of the division of this value by `x`. */
def %(x: Short): Double = value % x
/** Returns the remainder of the division of this value by `x`. */
def %(x: Char): Double = value % x
/** Returns the remainder of the division of this value by `x`. */
def %(x: Int): Double = value % x
/** Returns the remainder of the division of this value by `x`. */
def %(x: Long): Double = value % x
/** Returns the remainder of the division of this value by `x`. */
def %(x: Float): Double = value % x
/** Returns the remainder of the division of this value by `x`. */
def %(x: Double): Double = value % x
// TODO: Need Scaladoc
// Stuff from RichDouble
/**
* Returns this if this > that or that otherwise.
*/
def max(that: PosZFiniteDouble): PosZFiniteDouble = if (math.max(value, that.value) == value) this else that
/**
* Returns this if this < that or that otherwise.
*/
def min(that: PosZFiniteDouble): PosZFiniteDouble = if (math.min(value, that.value) == value) this else that
/**
* Indicates whether this `PosZFiniteDouble` has a value that is a whole number: it is finite and it has no fraction part.
*/
def isWhole = {
val longValue = value.toLong
longValue.toDouble == value || longValue == Long.MaxValue && value < Double.PositiveInfinity || longValue == Long.MinValue && value > Double.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: Double = math.toRadians(value)
/** 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: Double = math.toDegrees(value)
/**
* Applies the passed Double => Double function to the underlying Double
* value, and if the result is positive, returns the result wrapped in a PosZFiniteDouble,
* else throws AssertionError.
*
*
* This method will inspect the result of applying the given function to this
* PosZFiniteDouble's underlying Double value and if the result
* is greater than 0.0, it will return a PosZFiniteDouble 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 PosZFiniteDouble'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.
*
*
* @param f the Double => Double function to apply to this PosZFiniteDouble's
* underlying Double value.
* @return the result of applying this PosZFiniteDouble's underlying Double value to
* to the passed function, wrapped in a PosZFiniteDouble if it is positive (else throws AssertionError).
* @throws AssertionError if the result of applying this PosZFiniteDouble's underlying Double value to
* to the passed function is not positive.
*/
def ensuringValid(f: Double => Double): PosZFiniteDouble = {
val candidateResult: Double = f(value)
if (PosZFiniteDoubleMacro.isValid(candidateResult)) new PosZFiniteDouble(candidateResult)
else throw new AssertionError(s"${candidateResult.toString()}, the result of applying the passed function to ${value.toString()}, was not a valid PosZFiniteDouble")
}
/**
* Rounds this `PosZFiniteDouble` value to the nearest whole number value that can be expressed as an `PosZLong`, returning the result as a `PosZLong`.
*/
def round: PosZLong = PosZLong.ensuringValid(math.round(value))
/**
* Returns the smallest (closest to 0) `PosZFiniteDouble` that is greater than or equal to this `PosZFiniteDouble`
* and represents a mathematical integer.
*/
def ceil: PosZFiniteDouble = PosZFiniteDouble.ensuringValid(math.ceil(value).toDouble)
/**
* Returns the greatest (closest to infinity) `PosZFiniteDouble` that is less than or equal to
* this `PosZFiniteDouble` and represents a mathematical integer.
*/
def floor: PosZFiniteDouble = PosZFiniteDouble.ensuringValid(math.floor(value).toDouble)
}
/**
* The companion object for PosZFiniteDouble that offers
* factory methods that produce PosZFiniteDoubles,
* implicit widening conversions from PosZFiniteDouble to
* other numeric types, and maximum and minimum constant values
* for PosZFiniteDouble.
*/
object PosZFiniteDouble {
/**
* The largest value representable as a finite non-negative Double,
* which is PosZFiniteDouble(1.7976931348623157E308).
*/
final val MaxValue: PosZFiniteDouble = PosZFiniteDouble.ensuringValid(Double.MaxValue)
/**
* The smallest value representable as a finite non-negative
* Double, which is PosZFiniteDouble(0.0).
*/
final val MinValue: PosZFiniteDouble = PosZFiniteDouble.ensuringValid(0.0) // Can't use the macro here
/**
* A factory method that produces an Option[PosZFiniteDouble] given a
* Double value.
*
*
* This method will inspect the passed Double value and if
* it is a finite non-negative Double, it will return a PosZFiniteDouble
* representing that value, wrapped in a Some. Otherwise, the passed Double
* value is not finite non-negative, 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 Double literals at
* compile time, whereas from inspects
* Double values at run time.
*
*
* @param value the Double to inspect, and if finite non-negative, return
* wrapped in a Some[PosZFiniteDouble].
* @return the specified Double value wrapped in a
* Some[PosZFiniteDouble], if it is PosZFiniteDouble, else
* None.
*/
def from(value: Double): Option[PosZFiniteDouble] =
if (PosZFiniteDoubleMacro.isValid(value)) Some(new PosZFiniteDouble(value)) else None
/**
* A factory/assertion method that produces a PosZFiniteDouble given a
* valid Double value, or throws AssertionError,
* if given an invalid Double value.
*
*
* This method will inspect the passed Double value and if
* it is a finite non-negative Double, it will return a PosZFiniteDouble
* representing that value. Otherwise, the passed Double value is not finite non-negative,
* 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 Double literals at
* compile time, whereas from inspects
* Double 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 Double is finite non-negative.
*
*
* @param value the Double to inspect, and if finite non-negative, return
* wrapped in a PosZFiniteDouble.
* @return the specified Double value wrapped in a
* PosZFiniteDouble, if it is finite non-negative, else
* throws AssertionError.
* @throws AssertionError if the passed value is not finite non-negative
*/
def ensuringValid(value: Double): PosZFiniteDouble =
if (PosZFiniteDoubleMacro.isValid(value)) new PosZFiniteDouble(value) else {
throw new AssertionError(s"${value.toString()} was not a valid PosZFiniteDouble")
}
/**
* A factory/validation method that produces a PosZFiniteDouble, wrapped
* in a Success, given a valid Float value, or if the
* given Float is invalid, an AssertionError, wrapped
* in a Failure.
*
* 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 finite non-negative Float, it will return a PosZFiniteDouble
* representing that value, wrapped in a Success.
* Otherwise, the passed Float value is not finite non-negative, 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 finite non-negative, return
* wrapped in a Success(PosZFiniteDouble).
* @return the specified Float value wrapped
* in a Success(PosZFiniteDouble), if it is finite non-negative, else a Failure(AssertionError).
*/
def tryingValid(value: Double): Try[PosZFiniteDouble] =
if (PosZFiniteDoubleMacro.isValid(value))
Success(new PosZFiniteDouble(value))
else
Failure(new AssertionError(s"${value.toString()} was not a valid PosZFiniteDouble"))
/**
* A validation method that produces a Pass
* given a valid Double 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 Double value and if
* it is a finite non-negative Double, it will return a Pass.
* Otherwise, the passed Double value is finite non-negative, so this
* method will return a result of type E obtained by passing
* the invalid Double 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
* Double literals at compile time, whereas this method inspects
* Double values at run time.
*
*
* @param value the `Int` to validate that it is finite non-negative.
* @return a `Pass` if the specified `Int` value is finite non-negative,
* else a `Fail` containing an error value produced by passing the
* specified `Double` to the given function `f`.
*/
def passOrElse[E](value: Double)(f: Double => E): Validation[E] =
if (PosZFiniteDoubleMacro.isValid(value)) Pass else Fail(f(value))
/**
* A factory/validation method that produces a PosZFiniteDouble, wrapped
* in a Good, given a valid Double value, or if the
* given Double is invalid, an error value of type B
* produced by passing the given invalid Double value
* to the given function f, wrapped in a Bad.
*
*
* This method will inspect the passed Double value and if
* it is a finite non-negative Double, it will return a PosZFiniteDouble
* representing that value, wrapped in a Good.
* Otherwise, the passed Double value is not finite non-negative, so this
* method will return a result of type B obtained by passing
* the invalid Double 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
* Double literals at compile time, whereas this method inspects
* Double values at run time.
*
*
* @param value the Double to inspect, and if finite non-negative, return
* wrapped in a Good(PosZFiniteDouble).
* @return the specified Double value wrapped
* in a Good(PosZFiniteDouble), if it is finite non-negative, else a Bad(f(value)).
*/
def goodOrElse[B](value: Double)(f: Double => B): PosZFiniteDouble Or B =
if (PosZFiniteDoubleMacro.isValid(value)) Good(PosZFiniteDouble.ensuringValid(value)) else Bad(f(value))
/**
* A factory/validation method that produces a PosZFiniteDouble, wrapped
* in a Right, given a valid Double value, or if the
* given Double is invalid, an error value of type L
* produced by passing the given invalid Double value
* to the given function f, wrapped in a Left.
*
*
* This method will inspect the passed Double value and if
* it is a finite non-negative Double, it will return a PosZFiniteDouble
* representing that value, wrapped in a Right.
* Otherwise, the passed Double value is not finite non-negative, so this
* method will return a result of type L obtained by passing
* the invalid Double 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
* Double literals at compile time, whereas this method inspects
* Double values at run time.
*
*
* @param value the Double to inspect, and if finite non-negative, return
* wrapped in a Right(PosZFiniteDouble).
* @return the specified Double value wrapped
* in a Right(PosZFiniteDouble), if it is finite non-negative, else a Left(f(value)).
*/
def rightOrElse[L](value: Double)(f: Double => L): Either[L, PosZFiniteDouble] =
if (PosZFiniteDoubleMacro.isValid(value)) Right(PosZFiniteDouble.ensuringValid(value)) else Left(f(value))
/**
* A predicate method that returns true if a given
* Double value is finite non-negative.
*
* @param value the Double to inspect, and if finite non-negative, return true.
* @return true if the specified Double is positive, else false.
*/
def isValid(value: Double): Boolean = PosZFiniteDoubleMacro.isValid(value)
/**
* A factory method that produces a PosZFiniteDouble given a
* Double value and a default PosZFiniteDouble.
*
*
* This method will inspect the passed Double value and if
* it is a finite non-negative Double, it will return a PosZFiniteDouble
* representing that value. Otherwise, the passed Double value is finite non-negative,
* 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 Double literals at
* compile time, whereas from inspects
* Double values at run time.
*
*
* @param value the Double to inspect, and if finite non-negative, return.
* @param default the PosZFiniteDouble to return if the passed
* Double value is not finite non-negative.
* @return the specified Double value wrapped in a
* PosZFiniteDouble, if it is finite non-negative, else the
* default PosZFiniteDouble value.
*/
def fromOrElse(value: Double, default: => PosZFiniteDouble): PosZFiniteDouble =
if (PosZFiniteDoubleMacro.isValid(value)) new PosZFiniteDouble(value) else default
import language.experimental.macros
import scala.language.implicitConversions
/**
* A factory method, implemented via a macro, that produces a
* PosZFiniteDouble if passed a valid Double
* literal, otherwise a compile time error.
*
*
* The macro that implements this method will inspect the
* specified Double expression at compile time. If
* the expression is a finite non-negative Double literal,
* it will return a PosZFiniteDouble representing that value.
* Otherwise, the passed Double expression is either a literal
* that is not finite non-negative, 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 Double literals at compile
* time, whereas from inspects Double
* values at run time.
*
*
* @param value the Double literal expression to
* inspect at compile time, and if finite non-negative, to return
* wrapped in a PosZFiniteDouble at run time.
* @return the specified, valid Double literal
* value wrapped in a PosZFiniteDouble. (If the
* specified expression is not a valid Double
* literal, the invocation of this method will not
* compile.)
*/
inline implicit def apply(value: => Double): PosZFiniteDouble = ${ PosZFiniteDoubleMacro('{value}) }
/**
* Implicit widening conversion from PosZFiniteDouble to
* Double.
*
* @param pos the PosZFiniteDouble to widen
* @return the Double value underlying the specified
* PosZFiniteDouble
*/
implicit def widenToDouble(pos: PosZFiniteDouble): Double = pos.value
/**
* Implicit widening conversion from PosZFiniteDouble to PosZDouble.
*
* @param pos the PosZFiniteDouble to widen
* @return the Double value underlying the specified PosZFiniteDouble,
* widened to Double and wrapped in a PosZDouble.
*/
implicit def widenToPosZDouble(pos: PosZFiniteDouble): PosZDouble = PosZDouble.ensuringValid(pos.value)
/**
* Implicit Ordering instance.
*/
implicit val ordering: Ordering[PosZFiniteDouble] =
new Ordering[PosZFiniteDouble] {
def compare(x: PosZFiniteDouble, y: PosZFiniteDouble): Int = x.toDouble.compare(y.toDouble)
}
/**
* The smallest positive value greater than 0.0d representable as a PosZFiniteDouble, which is PosZFiniteDouble(4.9E-324).
*/
final val MinPositiveValue: PosZFiniteDouble = PosZFiniteDouble.ensuringValid(Double.MinPositiveValue)
}