annotate vendor/sebastian/comparator/src/NumericComparator.php @ 19:fa3358dc1485 tip

Add ndrum files
author Chris Cannam
date Wed, 28 Aug 2019 13:14:47 +0100
parents 1fec387a4317
children
rev   line source
Chris@0 1 <?php
Chris@0 2 /*
Chris@14 3 * This file is part of sebastian/comparator.
Chris@0 4 *
Chris@0 5 * (c) Sebastian Bergmann <sebastian@phpunit.de>
Chris@0 6 *
Chris@0 7 * For the full copyright and license information, please view the LICENSE
Chris@0 8 * file that was distributed with this source code.
Chris@0 9 */
Chris@0 10
Chris@0 11 namespace SebastianBergmann\Comparator;
Chris@0 12
Chris@0 13 /**
Chris@0 14 * Compares numerical values for equality.
Chris@0 15 */
Chris@0 16 class NumericComparator extends ScalarComparator
Chris@0 17 {
Chris@0 18 /**
Chris@0 19 * Returns whether the comparator can compare two values.
Chris@0 20 *
Chris@14 21 * @param mixed $expected The first value to compare
Chris@14 22 * @param mixed $actual The second value to compare
Chris@14 23 *
Chris@0 24 * @return bool
Chris@0 25 */
Chris@0 26 public function accepts($expected, $actual)
Chris@0 27 {
Chris@0 28 // all numerical values, but not if one of them is a double
Chris@0 29 // or both of them are strings
Chris@14 30 return \is_numeric($expected) && \is_numeric($actual) &&
Chris@14 31 !(\is_float($expected) || \is_float($actual)) &&
Chris@14 32 !(\is_string($expected) && \is_string($actual));
Chris@0 33 }
Chris@0 34
Chris@0 35 /**
Chris@0 36 * Asserts that two values are equal.
Chris@0 37 *
Chris@0 38 * @param mixed $expected First value to compare
Chris@0 39 * @param mixed $actual Second value to compare
Chris@0 40 * @param float $delta Allowed numerical distance between two values to consider them equal
Chris@0 41 * @param bool $canonicalize Arrays are sorted before comparison when set to true
Chris@0 42 * @param bool $ignoreCase Case is ignored when set to true
Chris@0 43 *
Chris@0 44 * @throws ComparisonFailure
Chris@0 45 */
Chris@0 46 public function assertEquals($expected, $actual, $delta = 0.0, $canonicalize = false, $ignoreCase = false)
Chris@0 47 {
Chris@14 48 if (\is_infinite($actual) && \is_infinite($expected)) {
Chris@0 49 return;
Chris@0 50 }
Chris@0 51
Chris@14 52 if ((\is_infinite($actual) xor \is_infinite($expected)) ||
Chris@14 53 (\is_nan($actual) or \is_nan($expected)) ||
Chris@14 54 \abs($actual - $expected) > $delta) {
Chris@0 55 throw new ComparisonFailure(
Chris@0 56 $expected,
Chris@0 57 $actual,
Chris@0 58 '',
Chris@0 59 '',
Chris@0 60 false,
Chris@14 61 \sprintf(
Chris@0 62 'Failed asserting that %s matches expected %s.',
Chris@0 63 $this->exporter->export($actual),
Chris@0 64 $this->exporter->export($expected)
Chris@0 65 )
Chris@0 66 );
Chris@0 67 }
Chris@0 68 }
Chris@0 69 }