class DoubleComparator in Zircon Profile 8

Compares doubles for equality.

Hierarchy

• class \SebastianBergmann\Comparator\Comparator
  • class \SebastianBergmann\Comparator\ScalarComparator
    • class \SebastianBergmann\Comparator\NumericComparator
      • class \SebastianBergmann\Comparator\DoubleComparator

File

vendor/sebastian/comparator/src/DoubleComparator.php, line 16

Namespace

SebastianBergmann\Comparator

class DoubleComparator extends NumericComparator {

  /**
   * Smallest value available in PHP.
   *
   * @var float
   */
  const EPSILON = 1.0E-10;

  /**
   * Returns whether the comparator can compare two values.
   *
   * @param  mixed $expected The first value to compare
   * @param  mixed $actual   The second value to compare
   * @return bool
   */
  public function accepts($expected, $actual) {
    return (is_double($expected) || is_double($actual)) && is_numeric($expected) && is_numeric($actual);
  }

  /**
   * Asserts that two values are equal.
   *
   * @param  mixed             $expected     The first value to compare
   * @param  mixed             $actual       The second value to compare
   * @param  float             $delta        The allowed numerical distance between two values to
   *                                         consider them equal
   * @param  bool              $canonicalize If set to TRUE, arrays are sorted before
   *                                         comparison
   * @param  bool              $ignoreCase   If set to TRUE, upper- and lowercasing is
   *                                         ignored when comparing string values
   * @throws ComparisonFailure Thrown when the comparison
   *                                        fails. Contains information about the
   *                                        specific errors that lead to the failure.
   */
  public function assertEquals($expected, $actual, $delta = 0.0, $canonicalize = false, $ignoreCase = false) {
    if ($delta == 0) {
      $delta = self::EPSILON;
    }
    parent::assertEquals($expected, $actual, $delta, $canonicalize, $ignoreCase);
  }

}

Members

Name	Modifiers	Type	Description	Overrides
Comparator::$exporter	protected	property
Comparator::$factory	protected	property
Comparator::setFactory	public	function
Comparator::__construct	public	function
DoubleComparator::accepts	public	function	Returns whether the comparator can compare two values. Overrides NumericComparator::accepts
DoubleComparator::assertEquals	public	function	Asserts that two values are equal. Overrides NumericComparator::assertEquals
DoubleComparator::EPSILON		constant	Smallest value available in PHP.