Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Higher order functions for comparison (#89)
- Loading branch information
Showing
16 changed files
with
336 additions
and
8 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,24 @@ | ||
| - [Overview](00-index.md) | ||
| - [Chapter 1: list comprehension](01-list-comprehension.md) | ||
| - [Chapter 2: partial application](02-partial-application.md) | ||
| - [Chapter 3: access functions](03-access-functions.md) | ||
| - [Chapter 4: function functions](04-function-functions.md) | ||
| - [Chapter 5: mathematical functions](05-mathematical-functions.md) | ||
| - [Chapter 6: transformation functions](06-transformation-functions.md) | ||
| - Chapter 7: comparator | ||
| - [Chapter 8: miscellaneous](08-miscellaneous.md) | ||
|
|
||
| # Higher order comparison functions | ||
|
|
||
| ## compare_on & compare_object_hash_on | ||
|
|
||
| ``callable compare_on(callable $comparison; callable $keyFunction = Functional\const_function)`` | ||
| Returns a compare function that can be used with e.g. `usort()`, `array_udiff`, `array_uintersect` and so on. Takes a | ||
| comparison function as the first argument, pick e.g. `strcmp`, `strnatcmp` or `strnatcasecmp`. Second argument can be a | ||
| key function that is applied to both parameters passed to the compare function. | ||
|
|
||
| ``callable compare_object_hash_on(callable $comparison = 'strnatcasecmp', callable $keyFunction = 'Functional\const_function')`` | ||
| Returns a compare function function that expects `$left` and `$right` to be an object and compares them using the value | ||
| of `spl_object_hash`. First argument is the comparison function, pick e.g. `strcmp`, `strnatcmp` or `strnatcasecmp`. | ||
| Takes a key function as an optional argument that is invoked on both parameters passed to the compare function. It is | ||
| just a shortcut to `compare_on` as it composes the given key function with `spl_object_hash()` as a key function. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,40 @@ | ||
| <?php | ||
| /** | ||
| * Copyright (C) 2011-2015 by Lars Strojny <lstrojny@php.net> | ||
| * | ||
| * Permission is hereby granted, free of charge, to any person obtaining a copy | ||
| * of this software and associated documentation files (the "Software"), to deal | ||
| * in the Software without restriction, including without limitation the rights | ||
| * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | ||
| * copies of the Software, and to permit persons to whom the Software is | ||
| * furnished to do so, subject to the following conditions: | ||
| * | ||
| * The above copyright notice and this permission notice shall be included in | ||
| * all copies or substantial portions of the Software. | ||
| * | ||
| * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | ||
| * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | ||
| * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | ||
| * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | ||
| * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | ||
| * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN | ||
| * THE SOFTWARE. | ||
| */ | ||
| namespace Functional; | ||
|
|
||
| use function Functional\compose; | ||
|
|
||
| /** | ||
| * Returns a comparison function that can be used with e.g. `usort()` | ||
| * | ||
| * @param callable $comparison A function that compares the two values. Pick e.g. strcmp() or strnatcasecmp() | ||
| * @param callable $keyFunction A function that takes an argument and returns the value that should be compared | ||
| * @return callable | ||
| */ | ||
| function compare_object_hash_on(callable $comparison, callable $keyFunction = null) | ||
| { | ||
| $keyFunction = $keyFunction ? compose($keyFunction, 'spl_object_hash') : 'spl_object_hash'; | ||
|
|
||
| return compare_on($comparison, $keyFunction); | ||
| } | ||
|
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,43 @@ | ||
| <?php | ||
| /** | ||
| * Copyright (C) 2011-2015 by Lars Strojny <lstrojny@php.net> | ||
| * | ||
| * Permission is hereby granted, free of charge, to any person obtaining a copy | ||
| * of this software and associated documentation files (the "Software"), to deal | ||
| * in the Software without restriction, including without limitation the rights | ||
| * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | ||
| * copies of the Software, and to permit persons to whom the Software is | ||
| * furnished to do so, subject to the following conditions: | ||
| * | ||
| * The above copyright notice and this permission notice shall be included in | ||
| * all copies or substantial portions of the Software. | ||
| * | ||
| * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | ||
| * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | ||
| * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | ||
| * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | ||
| * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | ||
| * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN | ||
| * THE SOFTWARE. | ||
| */ | ||
| namespace Functional; | ||
| /** | ||
| * Returns a comparison function that can be used with e.g. `usort()` | ||
| * | ||
| * @param callable $comparison A function that compares the two values. Pick e.g. strcmp() or strnatcasecmp() | ||
| * @param callable $reducer A function that takes an argument and returns the value that should be compared | ||
| * @return callable | ||
| */ | ||
| function compare_on(callable $comparison, callable $reducer = null) | ||
| { | ||
| if ($reducer === null) { | ||
| return static function ($left, $right) use ($comparison) { | ||
| return $comparison($left, $right); | ||
| }; | ||
| } | ||
|
|
||
| return static function ($left, $right) use ($reducer, $comparison) { | ||
| return $comparison($reducer($left), $reducer($right)); | ||
| }; | ||
| } | ||
|
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,42 @@ | ||
| <?php | ||
| /** | ||
| * Copyright (C) 2011 by Lars Strojny <lstrojny@php.net> | ||
| * | ||
| * Permission is hereby granted, free of charge, to any person obtaining a copy | ||
| * of this software and associated documentation files (the "Software"), to deal | ||
| * in the Software without restriction, including without limitation the rights | ||
| * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | ||
| * copies of the Software, and to permit persons to whom the Software is | ||
| * furnished to do so, subject to the following conditions: | ||
| * | ||
| * The above copyright notice and this permission notice shall be included in | ||
| * all copies or substantial portions of the Software. | ||
| * | ||
| * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | ||
| * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | ||
| * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | ||
| * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | ||
| * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | ||
| * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN | ||
| * THE SOFTWARE. | ||
| */ | ||
| namespace Functional; | ||
|
|
||
| use Traversable; | ||
| use Functional\Exceptions\InvalidArgumentException; | ||
|
|
||
| /** | ||
| * Returns a function that invokes method `$method` with arguments `$methodArguments` on the object | ||
| * | ||
| * @param string $methodName | ||
| * @param array $arguments | ||
| * @return callable | ||
| */ | ||
| function invoker($methodName, array $arguments = []) | ||
| { | ||
| InvalidArgumentException::assertMethodName($methodName, __FUNCTION__, 1); | ||
|
|
||
| return static function ($object) use ($methodName, $arguments) { | ||
| return $object->{$methodName}(...$arguments); | ||
| }; | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,45 @@ | ||
| <?php | ||
| /** | ||
| * Copyright (C) 2011-2015 by Lars Strojny <lstrojny@php.net> | ||
| * | ||
| * Permission is hereby granted, free of charge, to any person obtaining a copy | ||
| * of this software and associated documentation files (the "Software"), to deal | ||
| * in the Software without restriction, including without limitation the rights | ||
| * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | ||
| * copies of the Software, and to permit persons to whom the Software is | ||
| * furnished to do so, subject to the following conditions: | ||
| * | ||
| * The above copyright notice and this permission notice shall be included in | ||
| * all copies or substantial portions of the Software. | ||
| * | ||
| * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | ||
| * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | ||
| * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | ||
| * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | ||
| * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | ||
| * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN | ||
| * THE SOFTWARE. | ||
| */ | ||
| namespace Functional\Tests; | ||
|
|
||
| use function Functional\compare_object_hash_on; | ||
| use function Functional\const_function; | ||
| use stdClass; | ||
|
|
||
| class CompareObjectHashOnTest extends AbstractTestCase | ||
| { | ||
| public function testCompareValues() | ||
| { | ||
| $compare = compare_object_hash_on('strcmp'); | ||
|
|
||
| $this->assertSame(0, $compare($this, $this)); | ||
| $this->assertNotSame(0, $compare($this, new stdClass())); | ||
| } | ||
|
|
||
| public function testCompareWithReducer() | ||
| { | ||
| $compare = compare_object_hash_on('strcmp', const_function(new stdClass())); | ||
|
|
||
| $this->assertSame(0, $compare($this, new stdClass())); | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,45 @@ | ||
| <?php | ||
| /** | ||
| * Copyright (C) 2011-2015 by Lars Strojny <lstrojny@php.net> | ||
| * | ||
| * Permission is hereby granted, free of charge, to any person obtaining a copy | ||
| * of this software and associated documentation files (the "Software"), to deal | ||
| * in the Software without restriction, including without limitation the rights | ||
| * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | ||
| * copies of the Software, and to permit persons to whom the Software is | ||
| * furnished to do so, subject to the following conditions: | ||
| * | ||
| * The above copyright notice and this permission notice shall be included in | ||
| * all copies or substantial portions of the Software. | ||
| * | ||
| * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | ||
| * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | ||
| * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | ||
| * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | ||
| * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | ||
| * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN | ||
| * THE SOFTWARE. | ||
| */ | ||
| namespace Functional\Tests; | ||
|
|
||
| use function Functional\compare_on; | ||
| use function Functional\const_function; | ||
|
|
||
| class CompareOnTest extends AbstractTestCase | ||
| { | ||
| public function testCompareValues() | ||
| { | ||
| $comparator = compare_on('strcmp'); | ||
|
|
||
| $this->assertSame(-1, $comparator(1, 2)); | ||
| $this->assertSame(0, $comparator(2, 2)); | ||
| $this->assertSame(1, $comparator(20, 10)); | ||
| } | ||
|
|
||
| public function testCompareWithReducer() | ||
| { | ||
| $comparator = compare_on('strcmp', const_function(1)); | ||
|
|
||
| $this->assertSame(0, $comparator(0, 1)); | ||
| } | ||
| } |
Oops, something went wrong.