Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Extract DELTA() and GESTEP() functions from the Engineering class into a dedicated Comparison classes #1853

Merged
merged 4 commits into from
Feb 13, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions src/PhpSpreadsheet/Calculation/Calculation.php
Original file line number Diff line number Diff line change
Expand Up @@ -839,7 +839,7 @@ class Calculation
],
'DELTA' => [
'category' => Category::CATEGORY_ENGINEERING,
'functionCall' => [Engineering::class, 'DELTA'],
'functionCall' => [Engineering\Compare::class, 'DELTA'],
'argumentCount' => '1,2',
],
'DEVSQ' => [
Expand Down Expand Up @@ -954,7 +954,7 @@ class Calculation
],
'ERFC.PRECISE' => [
'category' => Category::CATEGORY_ENGINEERING,
'functionCall' => [Engineering::class, 'ERFC'],
'functionCall' => [Engineering\ErfC::class, 'ERFC'],
'argumentCount' => '1',
],
'ERROR.TYPE' => [
Expand Down Expand Up @@ -1196,7 +1196,7 @@ class Calculation
],
'GESTEP' => [
'category' => Category::CATEGORY_ENGINEERING,
'functionCall' => [Engineering::class, 'GESTEP'],
'functionCall' => [Engineering\Compare::class, 'GESTEP'],
'argumentCount' => '1,2',
],
'GETPIVOTDATA' => [
Expand Down
29 changes: 13 additions & 16 deletions src/PhpSpreadsheet/Calculation/Engineering.php
Original file line number Diff line number Diff line change
Expand Up @@ -1091,24 +1091,23 @@ public static function IMPRODUCT(...$complexNumbers)
* DELTA.
*
* Tests whether two values are equal. Returns 1 if number1 = number2; returns 0 otherwise.
* Use this function to filter a set of values. For example, by summing several DELTA
* functions you calculate the count of equal pairs. This function is also known as the
* Kronecker Delta function.
* Use this function to filter a set of values. For example, by summing several DELTA
* functions you calculate the count of equal pairs. This function is also known as the
* Kronecker Delta function.
*
* Excel Function:
* DELTA(a[,b])
*
* @Deprecated 2.0.0 Use the DELTA() method in the Engineering\Compare class instead
*
* @param float $a the first number
* @param float $b The second number. If omitted, b is assumed to be zero.
*
* @return int
* @return int|string (string in the event of an error)
*/
public static function DELTA($a, $b = 0)
{
$a = Functions::flattenSingleValue($a);
$b = Functions::flattenSingleValue($b);

return (int) ($a == $b);
return Engineering\Compare::DELTA($a, $b);
}

/**
Expand All @@ -1119,20 +1118,18 @@ public static function DELTA($a, $b = 0)
*
* Returns 1 if number >= step; returns 0 (zero) otherwise
* Use this function to filter a set of values. For example, by summing several GESTEP
* functions you calculate the count of values that exceed a threshold.
* functions you calculate the count of values that exceed a threshold.
*
* @Deprecated 2.0.0 Use the GESTEP() method in the Engineering\Compare class instead
*
* @param float $number the value to test against step
* @param float $step The threshold value.
* If you omit a value for step, GESTEP uses zero.
* @param float $step The threshold value. If you omit a value for step, GESTEP uses zero.
*
* @return int
* @return int|string (string in the event of an error)
*/
public static function GESTEP($number, $step = 0)
{
$number = Functions::flattenSingleValue($number);
$step = Functions::flattenSingleValue($step);

return (int) ($number >= $step);
return Engineering\Compare::GESTEP($number, $step);
}

/**
Expand Down
63 changes: 63 additions & 0 deletions src/PhpSpreadsheet/Calculation/Engineering/Compare.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,63 @@
<?php

namespace PhpOffice\PhpSpreadsheet\Calculation\Engineering;

use PhpOffice\PhpSpreadsheet\Calculation\Functions;

class Compare
{
/**
* DELTA.
*
* Excel Function:
* DELTA(a[,b])
*
* Tests whether two values are equal. Returns 1 if number1 = number2; returns 0 otherwise.
* Use this function to filter a set of values. For example, by summing several DELTA
* functions you calculate the count of equal pairs. This function is also known as the
* Kronecker Delta function.
*
* @param float $a the first number
* @param float $b The second number. If omitted, b is assumed to be zero.
*
* @return int|string (string in the event of an error)
*/
public static function DELTA($a, $b = 0)
{
$a = Functions::flattenSingleValue($a);
$b = Functions::flattenSingleValue($b);

if (!is_numeric($a) || !is_numeric($b)) {
return Functions::VALUE();
}

return (int) ($a == $b);
}

/**
* GESTEP.
*
* Excel Function:
* GESTEP(number[,step])
*
* Returns 1 if number >= step; returns 0 (zero) otherwise
* Use this function to filter a set of values. For example, by summing several GESTEP
* functions you calculate the count of values that exceed a threshold.
*
* @param float $number the value to test against step
* @param float $step The threshold value. If you omit a value for step, GESTEP uses zero.
*
* @return int|string (string in the event of an error)
*/
public static function GESTEP($number, $step = 0)
{
$number = Functions::flattenSingleValue($number);
$step = Functions::flattenSingleValue($step);

if (!is_numeric($number) || !is_numeric($step)) {
return Functions::VALUE();
}

return (int) ($number >= $step);
}
}
5 changes: 5 additions & 0 deletions tests/data/Calculation/Engineering/DELTA.php
Original file line number Diff line number Diff line change
Expand Up @@ -126,4 +126,9 @@
1.5,
1.5,
],
[
'#VALUE!',
1,
true,
],
];
5 changes: 5 additions & 0 deletions tests/data/Calculation/Engineering/GESTEP.php
Original file line number Diff line number Diff line change
Expand Up @@ -406,4 +406,9 @@
4.5,
4.5,
],
[
'#VALUE!',
1,
true,
],
];