Recommend this page to a friend! |
Python-like sequences with iterators for PHP.
composer require smoren/sequence
| Functionality | Description | Code Snippet |
|---------------------------------------|------------------------------|---------------------------------------------------|
| Range-based for
| Python-like range-based loop | foreach(xrange($start, $size, $step) as $value)
|
| Class | Description | Code Snippet |
|----------------------------------------|---------------------------------|-----------------------------------------------------------------------------|
| Range
| Iterable arithmetic progression | new Range($start, $size, $step)
|
| Exponential
| Iterable geometric progression | new Exponential($start, $size, $step)
|
| DynamicSequence
| Callback-configurable sequence | new DynamicSequence($start, $size, $nextValueGetter, $indexedValueGetter)
|
| Class | Description | Code Snippet |
|----------------------------------|--------------------------|----------------------------|
| IndexedArray
| Python-like indexed list | new IndexedArray($array)
|
| Function | Description | Code Snippet |
|---------------------|--------------------------------------------------------------------------|------------------------------------------------|
| xrange
| Creates iterable range | xrange($start, $size, $step)
|
| map
| Maps iterable collections and returns IndexedArray of mapped values | map($mapper, ...$collections)
|
| filter
| Filters iterable collection and returning IndexedArray of filtered items | filter($collection, $filter)
|
| reduce
| Reduces an iterable collection | reduce($collection, $reducer, $initialValue)
|
Unlike the PHP built-in function range()
, xrange()
does not create an array, but a Traversable
object
that takes up a small amount of memory, regardless of the number of elements in the sequence.
use function Smoren\Sequence\Functions\xrange;
foreach(xrange(5) as $i) { // start: 0; count: 5; step: 1
echo "{$i} ";
}
// 0 1 2 3 4
foreach(xrange(1, 5) as $i) { // start: 1; count: 5; step: 1
echo "{$i} ";
}
// 1 2 3 4 5
foreach(xrange(1, 5, 2) as $i) { // start: 1; count: 5; step: 2
echo "{$i} ";
}
// 1 3 5 7 9
Iterable arithmetic progression.
For infinite sequence use `$size = null`.
use Smoren\Sequence\Structs\Range; use Smoren\Sequence\Exceptions\OutOfRangeException;
/Simple int range/ $range = new Range(1, 3, 2); // (from, size, step) var_dump($range->isInfinite()); // false
foreach($range as $value) {
echo "{$value} ";
} // 1 3 5
var_dump($range[0]); // 1 var_dump($range[1]); // 3 var_dump($range[2]); // 5
try {
$range[3];
} catch(OutOfRangeException $e) {
echo "cannot get value from index out of range\n";
}
var_dump($range[-1]); // 5 var_dump($range[-2]); // 3 var_dump($range[-3]); // 1
try {
$range[-4];
} catch(OutOfRangeException $e) {
echo "cannot get value from index out of range\n";
}
/Infinite int range/ $range = new Range(1, null, 2); var_dump($range->isInfinite()); // true
foreach($range as $i => $value) {
echo "{$value} ";
if($i > 100) break;
} // 1 3 5 7 9 11 13...
/Float range/ $range = new Range(1.1, 3, 2.1); var_dump($range->isInfinite()); // false
foreach($range as $value) {
echo "{$value} ";
} // 1.1 3.2 5.3
#### Exponential
Iterable geometric progression.
For infinite sequence use $size = null
.
use Smoren\Sequence\Structs\Exponential;
use Smoren\Sequence\Exceptions\OutOfRangeException;
/Simple int exponential sequence/
$sequence = new Exponential(1, 4, 2); // (from, size, step)
var_dump($sequence->isInfinite()); // false
foreach($sequence as $value) {
echo "{$value} ";
}
// 1 2 4 8
var_dump($sequence[0]); // 1
var_dump($sequence[1]); // 2
var_dump($sequence[2]); // 4
var_dump($sequence[3]); // 8
try {
$sequence[4];
} catch(OutOfRangeException $e) {
echo "cannot get value from index out of range\n";
}
var_dump($sequence[-1]); // 8
var_dump($sequence[-2]); // 4
var_dump($sequence[-3]); // 2
var_dump($sequence[-4]); // 1
try {
$sequence[-5];
} catch(OutOfRangeException $e) {
echo "cannot get value from index out of range\n";
}
/Infinite int exponential sequence/
$sequence = new Exponential(1, null, 2);
var_dump($sequence->isInfinite()); // true
foreach($sequence as $i => $value) {
echo "{$value} ";
if($i > 100) break;
}
// 1 2 4 8 16 32 64...
/Infinite float exponential sequence/
$sequence = new Exponential(0.5, null, 2);
var_dump($sequence->isInfinite()); // true
foreach($sequence as $value) {
echo "{$value} ";
}
// 0.5 0.25 0.125...
Implementation of sequence configured with callables.
For infinite sequence use `$size = null`.
use Smoren\Sequence\Structs\DynamicSequence;
// (from, size, nextValueGetter, indexValueGetter) $sequence = new DynamicSequence(1, 5, static function($previousValue) {
return $previousValue + 1;
}, static function($index, $startValue) {
return $startValue + $index;
});
var_dump(iterator_to_array($sequence)); // [1, 2, 3, 4, 5]
### Data containers
#### Indexed Array
Python-like indexed list.
Its keys are always an unbroken sequence of natural numbers starting from zero.
It is also allowed to access array elements from the end with negative indices.
OutOfRangeException will be thrown when trying to access a non-existent index.
use Smoren\Sequence\Structs\IndexedArray; use Smoren\Sequence\Exceptions\OutOfRangeException;
$array = new IndexedArray([10, 20, 30]);
$array[0] = 11; $array[-1] = 33; $array[1] = 22; var_dump(count($array)); // 3 print_r($array->toArray()); // [11, 22, 33]
unset($array[1]); print_r($array->toArray()); // [11, 33]
$array[] = 111; print_r($array->toArray()); // [11, 33, 111]
try {
$array[3];
} catch(OutOfRangeException $e) {
echo "cannot get value from index out of range\n";
}
try {
$array[3] = 1;
} catch(OutOfRangeException $e) {
echo "cannot set value from index out of range\n";
}
try {
unset($array[3]);
} catch(OutOfRangeException $e) {
echo "cannot unset value from index out of range\n";
}
### Functions
#### xrange
Creates iterable range.
Works like `xrange()` function in python2 or `range()` function in python3.
use function Smoren\Sequence\Functions\xrange;
$range = xrange(5);
print_r(iterator_to_array($range));
// [0, 1, 2, 3, 4]
$range = xrange(1, 5);
print_r(iterator_to_array($range));
// [1, 2, 3, 4, 5]
$range = xrange(1, 5, 2);
print_r(iterator_to_array($range));
// [1, 3, 5, 7, 9]
Maps iterable collection and creating IndexedArray of mapped values as a result.
use function Smoren\Sequence\Functions\map;
$ids = [1, 2, 3]; $names = ['Mary', 'Jane', 'Alice']; $result = map(static function(int $id, string $name) {
return "{$id}. {$name}";
}, $ids, $names); print_r($result->toArray()); // ['1. Mary', '2. Jane', '3. Alice']
#### filter
Filters iterable collection and returning IndexedArray of filtered items.
use function Smoren\Sequence\Functions\filter;
$input = [1, 2, 3, 4, 5];
$result = filter($input, static function($item) {
return $item > 2;
});
print_r($result->toArray());
// [3, 4, 5]
Reduces an iterable collection.
use function Smoren\Sequence\Functions\reduce;
$input = [1, 2, 3, 4, 5]; $result = reduce($input, static function($carry, $item) {
return $carry + $item;
}, 0); var_dump($result); // 15
## Unit testing
composer install composer test-init composer test
## Standards
PHP Sequence conforms to the following standards:
* PSR-1 ? Basic coding standard
* PSR-4 ? Autoloader
* PSR-12 ? Extended coding style guide
## License
PHP Sequence is licensed under the MIT License.
Classes of Smoren Freelight | > | PHP Iterator-based Sequences | > | Download .zip .tar.gz | > | Support forum | > | Blog | > | Latest changes |
|
Groups | Applications | Files |
Groups |
Algorithms | Numerical and statistical algorithms | View top rated classes |
Utilities and Tools | General purpose tools to simplify software development | View top rated classes |
Libraries | Frameworks and libraries of cooperating classes | View top rated classes |
Math | Math related classes. | View top rated classes |
PSR | Packages that implement PHP Standard Recommendations by FIG | View top rated classes |
Applications that use this package |
If you know an application of this package, send a message to the author to add a link here.
Files |
File | Role | Description | ||
---|---|---|---|---|
.github (1 directory) | ||||
docs (1 directory) | ||||
src (1 file, 4 directories) | ||||
tests (3 files, 2 directories) | ||||
.scrutinizer.yml | Data | Auxiliary data | ||
codeception.yml | Data | Auxiliary data | ||
composer.json | Data | Auxiliary data | ||
LICENSE | Lic. | License text | ||
phpcs.xml | Data | Auxiliary data | ||
phpstan.neon | Data | Auxiliary data | ||
README.md | Doc. | Documentation |
Files | / | src |
File | Role | Description | ||
---|---|---|---|---|
Exceptions (2 files) | ||||
Interfaces (3 files) | ||||
Iterators (2 files) | ||||
Structs (6 files) | ||||
functions.php | Example | Example script |
Files | / | src | / | Exceptions |
File | Role | Description |
---|---|---|
OutOfRangeException.php | Class | Class source |
ReadOnlyException.php | Class | Class source |
Files | / | src | / | Interfaces |
File | Role | Description |
---|---|---|
IndexedArrayInterface.php | Class | Class source |
SequenceInterface.php | Class | Class source |
SequenceIteratorInterface.php | Class | Class source |
Files | / | src | / | Iterators |
File | Role | Description |
---|---|---|
IndexedArrayIterator.php | Class | Class source |
SequenceIterator.php | Class | Class source |
Files | / | src | / | Structs |
File | Role | Description |
---|---|---|
DynamicSequence.php | Class | Class source |
Exponential.php | Class | Class source |
IndexedArray.php | Class | Class source |
Range.php | Class | Class source |
Sequence.php | Class | Class source |
StepSequence.php | Class | Class source |
Files | / | tests |
File | Role | Description | ||
---|---|---|---|---|
unit (5 files) | ||||
_support (1 file) | ||||
coding_standard.xml | Data | Auxiliary data | ||
unit.suite.yml | Data | Auxiliary data | ||
_bootstrap.php | Aux. | Auxiliary script |
Files | / | tests | / | unit |
File | Role | Description |
---|---|---|
DynamicSequenceTest.php | Class | Class source |
ExponentialTest.php | Class | Class source |
FunctionsTest.php | Class | Class source |
IndexedArrayTest.php | Class | Class source |
RangeTest.php | Class | Class source |
Download all files: sequence-php.tar.gz sequence-php.zip NOTICE: if you are using a download manager program like 'GetRight', please Login before trying to download this archive.
|
Files |
File | Role | Description | ||
---|---|---|---|---|
.github (1 directory) | ||||
docs (1 directory) | ||||
src (1 file, 4 directories) | ||||
tests (3 files, 2 directories) | ||||
.scrutinizer.yml | Data | Auxiliary data | ||
codeception.yml | Data | Auxiliary data | ||
composer.json | Data | Auxiliary data | ||
LICENSE | Lic. | License text | ||
phpcs.xml | Data | Auxiliary data | ||
phpstan.neon | Data | Auxiliary data | ||
README.md | Doc. | Documentation |
Files | / | src |
File | Role | Description | ||
---|---|---|---|---|
Exceptions (2 files) | ||||
Interfaces (3 files) | ||||
Iterators (2 files) | ||||
Structs (6 files) | ||||
functions.php | Example | Example script |
Files | / | src | / | Exceptions |
File | Role | Description |
---|---|---|
OutOfRangeException.php | Class | Class source |
ReadOnlyException.php | Class | Class source |
Files | / | src | / | Interfaces |
File | Role | Description |
---|---|---|
IndexedArrayInterface.php | Class | Class source |
SequenceInterface.php | Class | Class source |
SequenceIteratorInterface.php | Class | Class source |
Files | / | src | / | Iterators |
File | Role | Description |
---|---|---|
IndexedArrayIterator.php | Class | Class source |
SequenceIterator.php | Class | Class source |
Files | / | src | / | Structs |
File | Role | Description |
---|---|---|
DynamicSequence.php | Class | Class source |
Exponential.php | Class | Class source |
IndexedArray.php | Class | Class source |
Range.php | Class | Class source |
Sequence.php | Class | Class source |
StepSequence.php | Class | Class source |
Files | / | tests |
File | Role | Description | ||
---|---|---|---|---|
unit (5 files) | ||||
_support (1 file) | ||||
coding_standard.xml | Data | Auxiliary data | ||
unit.suite.yml | Data | Auxiliary data | ||
_bootstrap.php | Aux. | Auxiliary script |
Files | / | tests | / | unit |
File | Role | Description |
---|---|---|
DynamicSequenceTest.php | Class | Class source |
ExponentialTest.php | Class | Class source |
FunctionsTest.php | Class | Class source |
IndexedArrayTest.php | Class | Class source |
RangeTest.php | Class | Class source |
Download all files: sequence-php.tar.gz sequence-php.zip NOTICE: if you are using a download manager program like 'GetRight', please Login before trying to download this archive.
|