All Downloads are FREE. Search and download functionalities are using the official Maven repository.

org.scalactic.anyvals.NegZDouble.scala Maven / Gradle / Ivy

The newest version!
/*
 * 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 Doubles.
 *
 * 

* *

* *

* Because NegZDouble is an AnyVal it * will usually be as efficient as an Double, being * boxed only when a Double would have been boxed. *

* *

* The NegZDouble.apply factory method is * implemented in terms of a macro that checks literals for * validity at compile time. Calling * NegZDouble.apply with a literal * Double value will either produce a valid * NegZDouble instance at run time or an error at * compile time. Here's an example: *

* *
 * scala> import anyvals._
 * import anyvals._
 *
 * scala> NegZDouble(-1.1)
 * res1: org.scalactic.anyvals.NegZDouble = NegZDouble(-1.1)
 *
 * scala> NegZDouble(1.1)
 * <console>:14: error: NegZDouble.apply can only be invoked on a non-positive (i <= 0.0) floating point literal, like NegZDouble(-1.1).
 *               NegZDouble(1.1)
 *                        ^
 * 
* *

* NegZDouble.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 NegZDouble.apply, you'll get a * compiler error that suggests you use a different factor * method, NegZDouble.from, instead: *

* *
 * scala> val x = -1.1
 * x: Double = -1.1
 *
 * scala> NegZDouble(x)
 * <console>:15: error: NegZDouble.apply can only be invoked on a floating point literal, like NegZDouble(-1.1). Please use NegZDouble.from instead.
 *               NegZDouble(x)
 *                        ^
 * 
* *

* The NegZDouble.from factory method will inspect * the value at runtime and return an * Option[NegZDouble]. If the value is valid, * NegZDouble.from will return a * Some[NegZDouble], else it will return a * None. Here's an example: *

* *
 * scala> NegZDouble.from(x)
 * res4: Option[org.scalactic.anyvals.NegZDouble] = Some(NegZDouble(-1.1))
 *
 * scala> val y = 1.1
 * y: Double = 1.1
 *
 * scala> NegZDouble.from(y)
 * res5: Option[org.scalactic.anyvals.NegZDouble] = None
 * 
* *

* The NegZDouble.apply factory method is marked * implicit, so that you can pass literal Doubles * into methods that require NegZDouble, and get the * same compile-time checking you get when calling * NegZDouble.apply explicitly. Here's an example: *

* *
 * scala> def invert(pos: NegZDouble): Double = Double.MaxValue - pos
 * invert: (pos: org.scalactic.anyvals.NegZDouble)Double
 *
 * scala> invert(1.1)
 * res6: Double = 1.7976931348623157E308
 *
 * scala> invert(Double.MaxValue)
 * res8: Double = 0.0
 *
 * scala> invert(1.1)
 * <console>:15: error: NegZDouble.apply can only be invoked on a non-positive (i <= 0.0) floating point literal, like NegZDouble(-1.1).
 *               invert(1.1)
 *                      ^
 *
 * 
* *

* This example also demonstrates that the * NegZDouble companion object also defines implicit * widening conversions when a similar conversion is provided in * Scala. This makes it convenient to use a * NegZDouble 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 * NegZDouble (the type of pos), you * can still subtract pos, because the * NegZDouble will be implicitly widened to * Double. *

* * @param value The Double value underlying this NegZDouble. */ final class NegZDouble private (val value: Double) extends AnyVal { /** * A string representation of this NegZDouble. */ override def toString: String = s"NegZDouble(${value.toString()})" /** * Converts this NegZDouble to a Byte. */ def toByte: Byte = value.toByte /** * Converts this NegZDouble to a Short. */ def toShort: Short = value.toShort /** * Converts this NegZDouble to a Char. */ def toChar: Char = value.toChar /** * Converts this NegZDouble to an Int. */ def toInt: Int = value.toInt /** * Converts this NegZDouble to a Long. */ def toLong: Long = value.toLong /** * Converts this NegZDouble to a Float. */ def toFloat: Float = value.toFloat /** * Converts this NegZDouble to a Double. */ def toDouble: Double = value.toDouble /** Returns this value, unmodified. */ def unary_+ : NegZDouble = this /** Returns the negation of this value. */ def unary_- : PosZDouble = PosZDouble.ensuringValid(-value) /** * Converts this NegZDouble'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: NegZDouble): NegZDouble = if (math.max(value, that.value) == value) this else that /** * Returns this if this < that or that otherwise. */ def min(that: NegZDouble): NegZDouble = if (math.min(value, that.value) == value) this else that /** * Indicates whether this `NegZDouble` 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 NegZDouble, * else throws AssertionError. * *

* This method will inspect the result of applying the given function to this * NegZDouble's underlying Double value and if the result * is greater than 0.0, it will return a NegZDouble representing that value. * Otherwise, the Double value returned by the given function is * 0.0 or negative, so this method will throw AssertionError. *

* *

* This method differs from a vanilla assert or ensuring * call in that you get something you didn't already have if the assertion * succeeds: a type that promises an Double is positive. * With this method, you are asserting that you are convinced the result of * the computation represented by applying the given function to this NegZDouble's * value will not produce zero, a negative number, including Double.NegativeInfinity, or Double.NaN. * Instead of producing such invalid values, this method will throw AssertionError. *

* * @param f the Double => Double function to apply to this NegZDouble's * underlying Double value. * @return the result of applying this NegZDouble's underlying Double value to * to the passed function, wrapped in a NegZDouble if it is positive (else throws AssertionError). * @throws AssertionError if the result of applying this NegZDouble's underlying Double value to * to the passed function is not positive. */ def ensuringValid(f: Double => Double): NegZDouble = { val candidateResult: Double = f(value) if (NegZDoubleMacro.isValid(candidateResult)) new NegZDouble(candidateResult) else throw new AssertionError(s"${candidateResult.toString()}, the result of applying the passed function to ${value.toString()}, was not a valid NegZDouble") } /** * Rounds this `NegZDouble` value to the nearest whole number value that can be expressed as an `NegZLong`, returning the result as a `NegZLong`. */ def round: NegZLong = NegZLong.ensuringValid(math.round(value)) /** * Returns the smallest (closest to 0) `NegZDouble` that is greater than or equal to this `NegZDouble` * and represents a mathematical integer. */ def ceil: NegZDouble = NegZDouble.ensuringValid(math.ceil(value).toDouble) /** * Returns the greatest (closest to infinity) `NegZDouble` that is less than or equal to * this `NegZDouble` and represents a mathematical integer. */ def floor: NegZDouble = NegZDouble.ensuringValid(math.floor(value).toDouble) /** * Returns the NegZDouble sum of this value and `x`. * *

* This method will always succeed (not throw an exception) because * adding a non-positive Double to another non-positive Double * will always result in another non-positive Double * value (though the result may be infinity). *

*/ def plus(x: NegZDouble): NegZDouble = NegZDouble.ensuringValid(value + x) /** * True if this NegZDouble value represents negative infinity, else false. */ def isNegInfinity: Boolean = Double.NegativeInfinity == value /** * True if this NegZDouble 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 NegZDouble that offers * factory methods that produce NegZDoubles, * implicit widening conversions from NegZDouble to * other numeric types, and maximum and minimum constant values * for NegZDouble. */ object NegZDouble { /** * The largest value representable as a non-positive Double, * which is NegZDouble(0.0). */ final val MaxValue: NegZDouble = NegZDouble.ensuringValid(0.0) /** * The smallest value representable as a non-positive * Double, which is NegZDouble(-1.7976931348623157E308). */ final val MinValue: NegZDouble = NegZDouble.ensuringValid(Double.MinValue) // Can't use the macro here /** * A factory method that produces an Option[NegZDouble] given a * Double value. * *

* This method will inspect the passed Double value and if * it is a non-positive Double, it will return a NegZDouble * representing that value, wrapped in a Some. Otherwise, the passed Double * 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 Double literals at * compile time, whereas from inspects * Double values at run time. *

* * @param value the Double to inspect, and if non-positive, return * wrapped in a Some[NegZDouble]. * @return the specified Double value wrapped in a * Some[NegZDouble], if it is NegZDouble, else * None. */ def from(value: Double): Option[NegZDouble] = if (NegZDoubleMacro.isValid(value)) Some(new NegZDouble(value)) else None /** * A factory/assertion method that produces a NegZDouble 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 non-positive Double, it will return a NegZDouble * representing that value. Otherwise, the passed Double 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 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 non-positive. *

* * @param value the Double to inspect, and if non-positive, return * wrapped in a NegZDouble. * @return the specified Double value wrapped in a * NegZDouble, if it is non-positive, else * throws AssertionError. * @throws AssertionError if the passed value is not non-positive */ def ensuringValid(value: Double): NegZDouble = if (NegZDoubleMacro.isValid(value)) new NegZDouble(value) else { throw new AssertionError(s"${value.toString()} was not a valid NegZDouble") } /** * A factory/validation method that produces a NegZDouble, 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 non-positive Float, it will return a NegZDouble * 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(NegZDouble). * @return the specified Float value wrapped * in a Success(NegZDouble), if it is non-positive, else a Failure(AssertionError). */ def tryingValid(value: Double): Try[NegZDouble] = if (NegZDoubleMacro.isValid(value)) Success(new NegZDouble(value)) else Failure(new AssertionError(s"${value.toString()} was not a valid NegZDouble")) /** * 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 non-positive Double, it will return a Pass. * Otherwise, the passed Double value is non-positive, 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 non-positive. * @return a `Pass` if the specified `Int` value is non-positive, * 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 (NegZDoubleMacro.isValid(value)) Pass else Fail(f(value)) /** * A factory/validation method that produces a NegZDouble, 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 non-positive Double, it will return a NegZDouble * representing that value, wrapped in a Good. * Otherwise, the passed Double value is not non-positive, 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 non-positive, return * wrapped in a Good(NegZDouble). * @return the specified Double value wrapped * in a Good(NegZDouble), if it is non-positive, else a Bad(f(value)). */ def goodOrElse[B](value: Double)(f: Double => B): NegZDouble Or B = if (NegZDoubleMacro.isValid(value)) Good(NegZDouble.ensuringValid(value)) else Bad(f(value)) /** * A factory/validation method that produces a NegZDouble, 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 non-positive Double, it will return a NegZDouble * representing that value, wrapped in a Right. * Otherwise, the passed Double value is not non-positive, 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 non-positive, return * wrapped in a Right(NegZDouble). * @return the specified Double value wrapped * in a Right(NegZDouble), if it is non-positive, else a Left(f(value)). */ def rightOrElse[L](value: Double)(f: Double => L): Either[L, NegZDouble] = if (NegZDoubleMacro.isValid(value)) Right(NegZDouble.ensuringValid(value)) else Left(f(value)) /** * A predicate method that returns true if a given * Double value is non-positive. * * @param value the Double to inspect, and if non-positive, return true. * @return true if the specified Double is positive, else false. */ def isValid(value: Double): Boolean = NegZDoubleMacro.isValid(value) /** * A factory method that produces a NegZDouble given a * Double value and a default NegZDouble. * *

* This method will inspect the passed Double value and if * it is a non-positive Double, it will return a NegZDouble * representing that value. Otherwise, the passed Double value is 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 Double literals at * compile time, whereas from inspects * Double values at run time. *

* * @param value the Double to inspect, and if non-positive, return. * @param default the NegZDouble to return if the passed * Double value is not non-positive. * @return the specified Double value wrapped in a * NegZDouble, if it is non-positive, else the * default NegZDouble value. */ def fromOrElse(value: Double, default: => NegZDouble): NegZDouble = if (NegZDoubleMacro.isValid(value)) new NegZDouble(value) else default import language.experimental.macros import scala.language.implicitConversions /** * A factory method, implemented via a macro, that produces a * NegZDouble 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 non-positive Double literal, * it will return a NegZDouble representing that value. * Otherwise, the passed Double 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 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 non-positive, to return * wrapped in a NegZDouble at run time. * @return the specified, valid Double literal * value wrapped in a NegZDouble. (If the * specified expression is not a valid Double * literal, the invocation of this method will not * compile.) */ inline implicit def apply(value: => Double): NegZDouble = ${ NegZDoubleMacro('{value}) } /** * Implicit widening conversion from NegZDouble to * Double. * * @param pos the NegZDouble to widen * @return the Double value underlying the specified * NegZDouble */ implicit def widenToDouble(pos: NegZDouble): Double = pos.value /** * Implicit Ordering instance. */ implicit val ordering: Ordering[NegZDouble] = new Ordering[NegZDouble] { def compare(x: NegZDouble, y: NegZDouble): Int = x.toDouble.compare(y.toDouble) } /** * The negative infinity value, which is NegZDouble.ensuringValid(Double.NegativeInfinity). */ final val NegativeInfinity: NegZDouble = NegZDouble.ensuringValid(Double.NegativeInfinity) // Can't use the macro here }




© 2015 - 2024 Weber Informatics LLC | Privacy Policy