org.scalautils.Tolerance.scala Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of scalatest_2.9.0 Show documentation
Show all versions of scalatest_2.9.0 Show documentation
ScalaTest is a free, open-source testing toolkit for Scala and Java
programmers.
/*
* Copyright 2001-2012 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.scalautils
/**
* This class is part of the ScalaUtils tolerance DSL. Please see the documentation for ShouldMatchers
or MustMatchers
for an overview of
* the matchers DSL.
*
* @author Bill Venners
*/
final case class Interval[T : Numeric](right: T, tolerance: T) {
private val numeric = implicitly[Numeric[T]]
private val max = numeric.plus(right, tolerance)
private val min = numeric.minus(right, tolerance)
def isWithin(n: T): Boolean = {
numeric.gteq(n, min) && numeric.lteq(n, max)
}
def ===(fartherRight: T): Boolean = isWithin(fartherRight)
def !==(fartherRight: T): Boolean = !isWithin(fartherRight)
}
trait Tolerance {
/**
* This class is part of the ScalaUtils tolerance DSL. Please see the documentation for ShouldMatchers
or MustMatchers
for an overview of
* the matchers DSL.
*
* @author Bill Venners
*/
final class PlusOrMinusWrapper[T: Numeric](right: T) {
/**
* This method enables the following syntax:
*
*
* sevenDotOh should be (17.0 +- 0.2)
* ^
*
*/
def +-(tolerance: T): Interval[T] = {
val numeric = implicitly[Numeric[T]]
if (numeric.lteq(tolerance, numeric.zero))
throw new IllegalArgumentException(tolerance.toString + " passed to +- was zero or negative. Must be a positive non-zero number.")
// throw newTestFailedException(Resources("negativeOrZeroRange", tolerance.toString))
Interval(right, tolerance)
}
/**
* The plusOrMinus method has been deprecated and will be removed in a future version of ScalaTest. Please use +- instead.
*
* This method enables the following syntax:
*
*
* sevenDotOh should be (17.0 plusOrMinus 0.2)
* ^
*
*/
@deprecated("The plusOrMinus method has been deprecated and will be removed in a future version of ScalaTest. Please use +- instead.")
def plusOrMinus(tolerance: T): Interval[T] = {
val numeric = implicitly[Numeric[T]]
if (numeric.lteq(tolerance, numeric.zero))
throw new IllegalArgumentException(tolerance.toString + " passed to +- was zero or negative. Must be a positive non-zero number.")
// throw newTestFailedException(Resources("negativeOrZeroRange", tolerance.toString))
Interval(right, tolerance)
}
}
/**
* Implicitly converts an object of type Byte
to a BytePlusOrMinusWrapper
,
* to enable a +-
method to be invokable on that object.
*/
implicit def convertNumericToPlusOrMinusWrapper[T : Numeric](right: T): PlusOrMinusWrapper[T] = new PlusOrMinusWrapper(right)
}