itertools php

Итуолуты - Итерационные инструменты PHP для питания ваших петли

Вдохновленный Python, разработанный для PHP.

Функции

Итула делает вас суперзвездой итерации, предоставляя два типа инструментов:

• Петля итерационные инструменты
• Потоковые итерационные инструменты

Инструменты итерации петли пример

 foreach (Multi:: zip ([ ' a ' , ' b ' ], [ 1 , 2 ]) as [ $ letter , $ number ]) {
    print ( $ letter . $ number );  // a1, b2
}

Пример инструментов итерации потока

 $ result = Stream:: of ([ 1 , 1 , 2 , 2 , 3 , 4 , 5 ])
    -> distinct ()                 // [1, 2, 3, 4, 5]
    -> map ( fn ( $ x ) => $ x ** 2 )      // [1, 4, 9, 16, 25]
    -> filter ( fn ( $ x ) => $ x < 10 ) // [1, 4, 9]
    -> toSum ();                   // 14

Все функции работают над iterable коллекциями:

• array (тип)
• Generator (тип)
• Iterator (интерфейс)
• Traversable (интерфейс)

Документы Readme переведены на другие языки:

• Ррусский

Быстрая ссылка

Петля итерационные инструменты

Многочисленная итерация

Итератор	Описание	Код фрагмент
chain	Цепь несколько иеры вместе	Multi::chain($list1, $list2)
zip	Итерация нескольких коллекций одновременно, пока самый короткий итератор не завершится	Multi::zip($list1, $list2)
zipEqual	Одновременно идентифицировать множественные коллекции одинаковой длины, ошибка, если длина не равна	Multi::zipEqual($list1, $list2)
zipFilled	Итерация нескольких коллекций, используя значение наполнителя, если длины не равны	Multi::zipFilled($default, $list1, $list2)
zipLongest	Итерация нескольких коллекций одновременно, пока не завершится самый длинный итератор	Multi::zipLongest($list1, $list2)

Одиночная итерация

Итератор	Описание	Код фрагмент
chunkwise	Итерация кусочками	Single::chunkwise($data, $chunkSize)
chunkwiseOverlap	Итерация перекрывающимися кусочками	Single::chunkwiseOverlap($data, $chunkSize, $overlapSize)
compress	Отфильтровать элементы, не выбранные	Single::compress($data, $selectors)
compressAssociative	Отфильтруйте элементы по ключам, не выбранным	Single::compressAssociative($data, $selectorKeys)
dropWhile	Отбросить элементы, в то время как предикат верен	Single::dropWhile($data, $predicate)
filter	Фильтр для элементов, где предикат верен	Single::filterTrue($data, $predicate)
filterTrue	Фильтр для правдивых элементов	Single::filterTrue($data)
filterFalse	Фильтр для фальшивых элементов	Single::filterFalse($data)
filterKeys	Фильтр для ключей, где предикат верен	Single::filterKeys($data, $predicate)
flatMap	Функция карты на элементы и сплющите результат	Single::flaMap($data, $mapper)
flatten	Удивление многомерного итерационного	Single::flatten($data, [$dimensions])
groupBy	Групповые данные общего элемента	Single::groupBy($data, $groupKeyFunction, [$itemKeyFunc])
limit	Переходить до предела	Single::limit($data, $limit)
map	Функция карты по каждому элементу	Single::map($data, $function)
pairwise	Итерация последовательных перекрывающихся пар	Single::pairwise($data)
reindex	Ключи Reindex из ключевых значений иеры	Single::reindex($data, $reindexer)
repeat	Повторите элемент несколько раз	Single::repeat($item, $repetitions)
reverse	Итерационные элементы в обратном порядке	Single::reverse($data)
skip	Итерация после пропуска элементов	Single::skip($data, $count, [$offset])
slice	Извлечь кусок итерабильного	Single::slice($data, [$start], [$count], [$step])
string	Относить символы строки	Single::string($string)
takeWhile	Итерационные элементы, в то время как предикат верен	Single::takeWhile($data, $predicate)

Бесконечная итерация

Итератор	Описание	Код фрагмент
count	Считайте последовательно навсегда	Infinite::count($start, $step)
cycle	Цикл через коллекцию	Infinite::cycle($collection)
repeat	Повторите предмет навсегда	Infinite::repeat($item)

Случайная итерация

Итератор	Описание	Код фрагмент
choice	Случайный выбор из списка	Random::choice($list, $repetitions)
coinFlip	Случайные монеты (0 или 1)	Random::coinFlip($repetitions)
number	Случайные числа	Random::number($min, $max, $repetitions)
percentage	Случайный процент между 0 и 1	Random::percentage($repetitions)
rockPaperScissors	Случайные ручные руки	Random::rockPaperScissors($repetitions)

Математическая итерация

Итератор	Описание	Код фрагмент
frequencies	Частотное распределение данных	Math::frequencies($data, [$strict])
relativeFrequencies	Относительное распределение частот данных	Math::relativeFrequencies($data, [$strict])
runningAverage	Среднее время работы	Math::runningAverage($numbers, $initialValue)
runningDifference	Запуск разницы	Math::runningDifference($numbers, $initialValue)
runningMax	Запуск максимального накопления	Math::runningMax($numbers, $initialValue)
runningMin	Запуск минимального накопления	Math::runningMin($numbers, $initialValue)
runningProduct	Запуск накопления продукта	Math::runningProduct($numbers, $initialValue)
runningTotal	Запуск полного накопления	Math::runningTotal($numbers, $initialValue)

Установить и многосетская итерация

Итератор	Описание	Код фрагмент
distinct	Относить только отдельные предметы	Set::distinct($data)
distinctBy	Итерация только отдельные элементы с использованием пользовательского компаратора	Set::distinct($data, $compareBy)
intersection	Пересечение итерабл	Set::intersection(...$iterables)
intersectionCoercive	Пересечение с принуждением типа	Set::intersectionCoercive(...$iterables)
partialIntersection	Частичное пересечение итераблев	Set::partialIntersection($minCount, ...$iterables)
partialIntersectionCoercive	Частичное пересечение с принуждением к типу	Set::partialIntersectionCoercive($minCount, ...$iterables)
symmetricDifference	Симметричная разница в итерации	Set::symmetricDifference(...$iterables)
symmetricDifferenceCoercive	Симметричная разница с принуждением типа	Set::symmetricDifferenceCoercive(...$iterables)
union	Союз итерабл	Set::union(...$iterables)
unionCoercive	Союз с принуждением к типу	Set::unionCoercive(...$iterables)

Сортировать итерацию

Итератор	Описание	Код фрагмент
asort	Итерация сортированная коллекция, поддерживающая ключи	Sort::asort($data, [$comparator])
sort	Относит сортированную коллекцию	Sort::sort($data, [$comparator])

Итерация файла

Итератор	Описание	Код фрагмент
readCsv	Пересечение линии файла CSV по строке	File::readCsv($fileHandle)
readLines	Относить линию файла по строке	File::readLines($fileHandle)

Преобразовать итерацию

Итератор	Описание	Код фрагмент
tee	Итерация дублирующих итераторов	Transform::tee($data, $count)
toArray	Преобразовать итерабильно в массив	Transform::toArray($data)
toAssociativeArray	Преобразовать итерабильно в ассоциативный массив	Transform::toAssociativeArray($data, [$keyFunc], [$valueFunc])
toIterator	Преобразовать в итератор	Transform::toIterator($data)

Краткое содержание

Краткое содержание	Описание	Код фрагмент
allMatch	Правда, если все элементы верны в соответствии с предикатом	Summary::allMatch($data, $predicate)
allUnique	Правда, если все предметы уникальны	Summary::allUnique($data, [$strict])
anyMatch	Правда, если какой -либо элемент верен в соответствии с предикатом	Summary::anyMatch($data, $predicate)
arePermutations	Правда, если итерации являются перестановками друг друга	Summary::arePermutations(...$iterables)
arePermutationsCoercive	Правда, если итерации являются перестановкой друг друга с принуждением к типу	Summary::arePermutationsCoercive(...$iterables)
exactlyN	Правда, если точно n элементы верны в соответствии с предикатом	Summary::exactlyN($data, $n, $predicate)
isEmpty	Правда, если итерально не имеет предметов	Summary::isEmpty($data)
isPartitioned	Правда, если разделены с предметами истинными в соответствии с предикатом перед другими	Summary::isPartitioned($data, $predicate)
isSorted	Правда, если итератно отсортировано	Summary::isSorted($data)
isReversed	Правда, если итерабильный обратный отсортирован	Summary::isReversed($data)
noneMatch	Правда, если ни один из пунктов не правдиво в соответствии с предикатом	Summary::noneMatch($data, $predicate)
same	Правда, если иеры одинаковы	Summary::same(...$iterables)
sameCount	Правда, если итерабют имеют одинаковую длину	Summary::sameCount(...$iterables)

Уменьшать

Редуктор	Описание	Код фрагмент
toAverage	Среднее среднее значение элементов	Reduce::toAverage($numbers)
toCount	Уменьшить до длины итерации	Reduce::toCount($data)
toFirst	Уменьшить его первое значение	Reduce::toFirst($data)
toFirstAndLast	Уменьшить до первого и последнего значения	Reduce::toFirstAndLast($data)
toLast	Уменьшить его последнее значение	Reduce::toLast()
toMax	Уменьшить его самый большой элемент	Reduce::toMax($numbers, [$compareBy])
toMin	Уменьшить его самый маленький элемент	Reduce::toMin($numbers, [$compareBy])
toMinMax	Уменьшить до массива верхних и нижних границ	Reduce::toMinMax($numbers, [$compareBy])
toNth	Уменьшить до стоимости в n -й позиции	Reduce::toNth($data, $position)
toProduct	Уменьшить продукт его элементов	Reduce::toProduct($numbers)
toRandomValue	Уменьшить до случайного значения от итерационного	Reduce::toRandomValue($data)
toRange	Уменьшить разницу в максимальных и минимальных значениях	Reduce::toRange($numbers)
toString	Уменьшить до соединенной строки	Reduce::toString($data, [$separator], [$prefix], [$suffix])
toSum	Уменьшить сумму его элементов	Reduce::toSum($numbers)
toValue	Уменьшить до значения, используя Callible Reducer	Reduce::toValue($data, $reducer, $initialValue)

Потоковые итерационные инструменты

Потоковые источники

Источник	Описание	Код фрагмент
of	Создайте поток из итерабильного	Stream::of($iterable)
ofCoinFlips	Создайте поток случайных монет	Stream::ofCoinFlips($repetitions)
ofCsvFile	Создайте поток из файла CSV	Stream::ofCsvFile($fileHandle)
ofEmpty	Создать пустой поток	Stream::ofEmpty()
ofFileLines	Создайте поток из строк файла	Stream::ofFileLines($fileHandle)
ofRandomChoice	Создать поток случайных выборов	Stream::ofRandomChoice($items, $repetitions)
ofRandomNumbers	Создайте поток случайных чисел (целые числа)	Stream::ofRandomNumbers($min, $max, $repetitions)
ofRandomPercentage	Создайте поток случайных процентов от 0 до 1	Stream::ofRandomPercentage($repetitions)
ofRange	Создайте поток ряда чисел	Stream::ofRange($start, $end, $step)
ofRockPaperScissors	Создайте ручки с рок-бумажниками	Stream::ofRockPaperScissors($repetitions)

Операции потока

Операция	Описание	Код фрагмент
asort	Сортирует итерабильный источник, поддерживающий ключи	$stream->asort([$comparator])
chainWith	Цепочка итерабируемого источника с предоставлением итерам вместе в одну итерацию	$stream->chainWith(...$iterables)
compress	Сжатие источника путем фильтрации данных, не выбранных	$stream->compress($selectors)
compressAssociative	Сжатие источника путем фильтрации клавиш не выбран	$stream->compressAssociative($selectorKeys)
chunkwise	Итерация кусочками	$stream->chunkwise($chunkSize)
chunkwiseOverlap	Итерация перекрывающимися кусочками	$stream->chunkwiseOverlap($chunkSize, $overlap)
distinct	Отфильтруйте элементы: обращайте только уникальные элементы	$stream->distinct([$strict])
distinctBy	Отфильтруйте элементы: итерация только уникальные элементы с использованием пользовательского компаратора	$stream->distinct($compareBy)
dropWhile	Отбрасывать элементы из итерабильного источника, в то время как функция предиката верна	$stream->dropWhile($predicate)
filter	Фильтр только для элементов, где функция предиката верна	$stream->filterTrue($predicate)
filterTrue	Фильтр только для правдивых элементов	$stream->filterTrue()
filterFalse	Фильтр только для фальшивых элементов	$stream->filterFalse()
filterKeys	Фильтр для ключей, где функция предиката верна	$stream->filterKeys($predicate)
flatMap	Карта функции на элементы и сплющивание результата	$stream->flatMap($function)
flatten	Удивление многомерного потока	$stream->flatten($dimensions)
frequencies	Распределение частот	$stream->frequencies([$strict])
groupBy	Групповой итерабильный источник с помощью общего элемента данных	$stream->groupBy($groupKeyFunction, [$itemKeyFunc])
infiniteCycle	Циклу через элементы итерабильного источника последовательно навсегда	$stream->infiniteCycle()
intersectionWith	Пересекайте итерабильный источник и дает итерабют	$stream->intersectionWith(...$iterables)
intersection CoerciveWith	Пересекайте итерабильный источник и дает итерабют с принуждением к типу	$stream->intersectionCoerciveWith(...$iterables)
limit	Ограничьте итерацию потока	$stream->limit($limit)
map	Функция карты на элементы	$stream->map($function)
pairwise	Вернуть пары элементов из итерационного источника	$stream->pairwise()
partialIntersectionWith	Частично пересекайте итерабильный источник и с учетом итераблев	$stream->partialIntersectionWith( $minIntersectionCount, ...$iterables)
partialIntersection CoerciveWith	Частично пересекайте итерабильный источник и с учетом итераблев с принуждением типа	$stream->partialIntersectionCoerciveWith( $minIntersectionCount, ...$iterables)
reindex	Ключи реиндекса потока клавишных значений	$stream->reindex($reindexer)
relativeFrequencies	Относительное распределение частот	$stream->relativeFrequencies([$strict])
reverse	Обратные элементы потока	$stream->reverse()
runningAverage	Накапливать среднее (среднее) по сравнению	$stream->runningAverage($initialValue)
runningDifference	Накапливайте разницу в работе по сравнению с итерационным источником	$stream->runningDifference($initialValue)
runningMax	Накапливать максимальный источник максимума	$stream->runningMax($initialValue)
runningMin	Накапливать бегущий мин над итерабильным источником	$stream->runningMin($initialValue)
runningProduct	Накапливайте работающий продукт из -за итерабильного источника	$stream->runningProduct($initialValue)
runningTotal	Накапливайте общее количество работы по сравнению с итерационным источником	$stream->runningTotal($initialValue)
skip	Пропустить несколько элементов потока	$stream->skip($count, [$offset])
slice	Извлечь кусок потока	$stream->slice([$start], [$count], [$step])
sort	Сортирует поток	$stream->sort([$comparator])
symmetricDifferenceWith	Симметричная разница итерабильного источника и с учетом итераблев	$this->symmetricDifferenceWith(...$iterables)
symmetricDifference CoerciveWith	Симметричная разница в итерабильном источнике и с учетом итераблев с принуждением типа	$this->symmetricDifferenceCoerciveWith( ...$iterables)
takeWhile	Возврат элементы из итерабильного источника, пока предикат верен	$stream->takeWhile($predicate)
unionWith	Союз потока с итерами	$stream->unionWith(...$iterables)
unionCoerciveWith	Союз потока с итерами с принуждением к типу	$stream->unionCoerciveWith(...$iterables)
zipWith	Итератируемый источник с другой итерабильной коллекцией одновременно	$stream->zipWith(...$iterables)
zipEqualWith	Итератируемый источник с другой итерабильной коллекцией равных длины одновременно	$stream->zipEqualWith(...$iterables)
zipFilledWith	Итератируемый источник итератируется с другой итерабильной коллекцией, используя заполнитель по умолчанию	$stream->zipFilledWith($default, ...$iterables)
zipLongestWith	Итератируемый источник с другой итерабильной коллекцией одновременно	$stream->zipLongestWith(...$iterables)

Потоковые операции терминала

Сводные операции терминала

Операция терминала	Описание	Код фрагмент
allMatch	Возвращает True, если все элементы в потоке соответствуют предикату	$stream->allMatch($predicate)
allUnique	Возвращает True, если все элементы в потоке уникальны	$stream->allUnique([$strict]])
anyMatch	Возвращает True, если какой -либо элемент в потоке соответствует предикату	$stream->anyMatch($predicate)
arePermutationsWith	Возвращает True, если все итерации перестановки потока	$stream->arePermutationsWith(...$iterables)
arePermutationsCoerciveWith	Возвращает True, если все итерации перестановки потока с принуждением к типу	$stream->arePermutationsCoerciveWith(...$iterables)
exactlyN	Возвращает True, если точно n элементы верны в соответствии с предикатом	$stream->exactlyN($n, $predicate)
isEmpty	Возвращает True, если у потока нет элементов	$stream::isEmpty()
isPartitioned	Возвращает True, если разделено с предметами True в соответствии с предикатом перед другими	$stream::isPartitioned($predicate)
isSorted	Возвращает True, если поток отсортирован в порядке возрастания	$stream->isSorted()
isReversed	Возвращает True, если поток отсортирован в обратном порядке убывания	$stream->isReversed()
noneMatch	Возвращает True, если ни один из элементов в потоке не соответствует предикату	$stream->noneMatch($predicate)
sameWith	Возвращает True, если поток и все данные коллекции одинаковы	$stream->sameWith(...$iterables)
sameCountWith	Возвращает True, если поток и все данные коллекции имеют одинаковую длину	$stream->sameCountWith(...$iterables)

Операции по сокращению терминалов

Операция терминала	Описание	Код фрагмент
toAverage	Уменьшает потоки до среднего значения его элементов	$stream->toAverage()
toCount	Уменьшает потоки до его длины	$stream->toCount()
toFirst	Уменьшает поток до первого значения	$stream->toFirst()
toFirstAndLast	Уменьшает поток до первого и последнего значения	$stream->toFirstAndLast()
toLast	Уменьшает поток до последнего значения	$stream->toLast()
toMax	Уменьшает поток до своего максимального значения	$stream->toMax([$compareBy])
toMin	Уменьшает поток до его значения MIN	$stream->toMin([$compareBy])
toMinMax	Уменьшает поток до массива верхних и нижних границ	$stream->toMinMax([$compareBy])
toNth	Уменьшает поток до значения в Nth Position	$stream->toNth($position)
toProduct	Уменьшает поток до продукта его предметов	$stream->toProduct()
toString	Снижает поток до соединения строки	$stream->toString([$separator], [$prefix], [$suffix])
toSum	Уменьшает поток до суммы его элементов	$stream->toSum()
toRandomValue	Снижает потоку до случайного значения внутри него	$stream->toRandomValue()
toRange	Снижает потоковой разницу в значениях максимума и мин	$stream->toRange()
toValue	Уменьшает функцию потока как array_reduce ()	$stream->toValue($reducer, $initialValue)

Терминальные операции трансформации

Операция терминала	Описание	Код фрагмент
toArray	Возвращает множество элементов потока	$stream->toArray()
toAssociativeArray	Возвращает карту ключей элементов потока	$stream->toAssociativeArray($keyFunc, $valueFunc)
tee	Возвращает массив нескольких идентичных потоков	$stream->tee($count)

Операции терминалов побочного эффекта

Операция терминала	Описание	Код фрагмент
callForEach	Выполнить действие через функцию по каждому элементу	$stream->callForEach($function)
print	print каждый элемент в потоке	$stream->print([$separator], [$prefix], [$suffix])
printLn	print каждый элемент на новой строке	$stream->printLn()
toCsvFile	Напишите содержимое потока в файл CSV	$stream->toCsvFile($fileHandle, [$headers])
toFile	Напишите содержимое потока в файл	$stream->toFile($fileHandle)

Потоковые отладочные операции

Отладочная операция	Описание	Код фрагмент
peek	Посмотрите на каждый элемент между операциями потока	$stream->peek($peekFunc)
peekStream	Загляните во весь поток между операциями	$stream->peekStream($peekFunc)
peekPrint	Посмотрите на каждый элемент, печатая между операциями	$stream->peekPrint()
peekPrintR	Посмотрите на каждый элемент, выполняя Print-R между операциями	$stream->peekPrintR()
printR	print_r Каждый элемент	$stream->printR()
varDump	var_dump каждый элемент	$stream->varDump()

Настраивать

Добавьте библиотеку в свой файл composer.json в вашем проекте:

{
  "require" : {
      "markrogoyski/itertools-php" : " 1.* "
  }
}

Используйте композитор для установки библиотеки:

$ php composer.phar install

Composer установит итул в папке поставщика. Затем вы можете добавить следующее в ваши файлы .php, чтобы использовать библиотеку с автозагрузкой.

 require_once __DIR__ . ' /vendor/autoload.php ' ;

В качестве альтернативы используйте композитор в командной строке, чтобы потребовать и установить итул:

 $ php composer.phar require markrogoyski/itertools-php:1.*

Минимальные требования

• PHP 7.4

Использование

Все функции работают над iterable коллекциями:

• array (тип)
• Generator (тип)
• Iterator (интерфейс)
• Traversable (интерфейс)

Многочисленная итерация

Цепь

Цепь множественные итерации вместе в одну непрерывную последовательность.

Multi::chain(iterable ...$iterables)

 use IterTools  Multi ;

$ prequels  = [ ' Phantom Menace ' , ' Attack of the Clones ' , ' Revenge of the Sith ' ];
$ originals = [ ' A New Hope ' , ' Empire Strikes Back ' , ' Return of the Jedi ' ];

foreach (Multi:: chain ( $ prequels , $ originals ) as $ movie ) {
    print ( $ movie );
}
// 'Phantom Menace', 'Attack of the Clones', 'Revenge of the Sith', 'A New Hope', 'Empire Strikes Back', 'Return of the Jedi'

Молния

Относит многочисленные итерабируемые коллекции одновременно.

Multi::zip(iterable ...$iterables)

 use IterTools  Multi ;

$ languages = [ ' PHP ' , ' Python ' , ' Java ' , ' Go ' ];
$ mascots   = [ ' elephant ' , ' snake ' , ' bean ' , ' gopher ' ];

foreach (Multi:: zip ( $ languages , $ mascots ) as [ $ language , $ mascot ]) {
    print ( " The { $ language } language mascot is an { $ mascot } . " );
}
// The PHP language mascot is an elephant.
// ...

Zip работает с несколькими итерационными входами-не ограничивается только двумя.

 $ names          = [ ' Ryu ' , ' Ken ' , ' Chun Li ' , ' Guile ' ];
$ countries      = [ ' Japan ' , ' USA ' , ' China ' , ' USA ' ];
$ signatureMoves = [ ' hadouken ' , ' shoryuken ' , ' spinning bird kick ' , ' sonic boom ' ];

foreach (Multi:: zip ( $ names , $ countries , $ signatureMoves ) as [ $ name , $ country , $ signatureMove ]) {
    $ streetFighter = new StreetFighter ( $ name , $ country , $ signatureMove );
}

ПРИМЕЧАНИЕ. Для неравномерной длины итерация останавливается, когда самый короткий итерабильный исчерпана.

Зипекваль

Итерация множества итерабируемых коллекций с одинаковой длиной одновременно.

Бросает LengthException если длины не равны, то есть, что по крайней мере один итератор заканчивается перед другими.

Multi::zipEqual(iterable ...$iterables)

 use IterTools  Multi ;

$ letters = [ ' A ' , ' B ' , ' C ' ];
$ numbers = [ 1 , 2 , 3 ];

foreach (Multi:: zipEqual ( $ letters , $ numbers ) as [ $ letter , $ number ]) {
    // ['A', 1], ['B', 2], ['C', 3]
}

Застегнутый

Итерация множественных итерационных коллекций одновременно, используя значение заполнителя по умолчанию, если длины не равны.

Multi::zipFilled(mixed $filler, iterable ...$iterables)

 use IterTools  Multi ;

$ default = ' ? ' ;
$ letters = [ ' A ' , ' B ' ];
$ numbers = [ 1 , 2 , 3 ];

foreach (Multi:: zipFilled ( $ default , $ letters , $ numbers ) as [ $ letter , $ number ]) {
    // ['A', 1], ['B', 2], ['?', 3]
}

Ziplongest

Относит многочисленные итерабируемые коллекции одновременно.

Multi::zipLongest(iterable ...$iterables)

Для неравномерных длины исчерпываемые иеры будут производить null для оставшихся итераций.

 use IterTools  Multi ;

$ letters = [ ' A ' , ' B ' , ' C ' ];
$ numbers = [ 1 , 2 ];

foreach (Multi:: zipLongest ( $ letters , $ numbers ) as [ $ letter , $ number ]) {
    // ['A', 1], ['B', 2], ['C', null]
}

Одиночная итерация

Кусок

Возвращаются элементы в кусках определенного размера.

Single::chunkwise(iterable $data, int $chunkSize)

Размер куски должен быть не менее 1.

 use IterTools  Single ;

$ movies = [
    ' Phantom Menace ' , ' Attack of the Clones ' , ' Revenge of the Sith ' ,
    ' A New Hope ' , ' Empire Strikes Back ' , ' Return of the Jedi ' ,
    ' The Force Awakens ' , ' The Last Jedi ' , ' The Rise of Skywalker '
];

foreach (Single:: chunkwise ( $ movies , 3 ) as $ trilogy ) {
    $ trilogies [] = $ trilogy ;
}
// [
//     ['Phantom Menace', 'Attack of the Clones', 'Revenge of the Sith'],
//     ['A New Hope', 'Empire Strikes Back', 'Return of the Jedi'],
//     ['The Force Awakens', 'The Last Jedi', 'The Rise of Skywalker]'
// ]

Через перекрытие

Вернуть перекрытые куски элементов.

Single::chunkwiseOverlap(iterable $data, int $chunkSize, int $overlapSize, bool $includeIncompleteTail = true)

• Размер куски должен быть не менее 1.
• Размер перекрытия должен быть меньше, чем размер чанка.

 use IterTools  Single ;

$ numbers = [ 1 , 2 , 3 , 4 , 5 , 6 , 7 , 8 , 9 , 10 ];

foreach (Single:: chunkwiseOverlap ( $ numbers , 3 , 1 ) as $ chunk ) {
    // [1, 2, 3], [3, 4, 5], [5, 6, 7], [7, 8, 9], [9, 10]
}

Компресс

Сжатие иерно, отфильтровав данные, которые не выбраны.

Single::compress(string $data, $selectors)

 use IterTools  Single ;

$ movies = [
    ' Phantom Menace ' , ' Attack of the Clones ' , ' Revenge of the Sith ' ,
    ' A New Hope ' , ' Empire Strikes Back ' , ' Return of the Jedi ' ,
    ' The Force Awakens ' , ' The Last Jedi ' , ' The Rise of Skywalker '
];
$ goodMovies = [ 0 , 0 , 0 , 1 , 1 , 1 , 1 , 0 , 0 ];

foreach (Single:: compress ( $ movies , $ goodMovies ) as $ goodMovie ) {
    print ( $ goodMovie );
}
// 'A New Hope', 'Empire Strikes Back', 'Return of the Jedi', 'The Force Awakens'

Сжатие ассоциативной

Сжатие итерабируемых путем фильтрации клавиш, которые не выбраны.

Single::compressAssociative(string $data, array $selectorKeys)

• Стандартные только клавиши массива PHP/итератора (строка, целое число).

 use IterTools  Single ;

$ starWarsEpisodes = [
    ' I '    => ' The Phantom Menace ' ,
    ' II '   => ' Attack of the Clones ' ,
    ' III '  => ' Revenge of the Sith ' ,
    ' IV '   => ' A New Hope ' ,
    ' V '    => ' The Empire Strikes Back ' ,
    ' VI '   => ' Return of the Jedi ' ,
    ' VII '  => ' The Force Awakens ' ,
    ' VIII ' => ' The Last Jedi ' ,
    ' IX '   => ' The Rise of Skywalker ' ,
];
$ originalTrilogyNumbers = [ ' IV ' , ' V ' , ' VI ' ];

foreach (Single:: compressAssociative ( $ starWarsEpisodes , $ originalTrilogyNumbers ) as $ episode => $ title ) {
    print ( " $ episode : $ title " .  PHP_EOL );
}
// IV: A New Hope
// V: The Empire Strikes Back
// VI: Return of the Jedi

Бросить в то время как

Отбросьте элементы из итерации, пока функция предиката верна.

Как только функция предиката возвращается в False, все оставшиеся элементы возвращаются.

Single::dropWhile(iterable $data, callable $predicate)

 use IterTools  Single ;

$ scores    = [ 50 , 60 , 70 , 85 , 65 , 90 ];
$ predicate = fn ( $ x ) => $ x < 70 ;

foreach (Single:: dropWhile ( $ scores , $ predicate ) as $ score ) {
    print ( $ score );
}
// 70, 85, 65, 90

Фильтр

Отфильтруйте элементы из итерационных только возвращающихся элементов, где функция предиката верна.

Single::filter(iterable $data, callable $predicate)

 use IterTools  Single ;

$ starWarsEpisodes   = [ 1 , 2 , 3 , 4 , 5 , 6 , 7 , 8 , 9 ];
$ goodMoviePredicate = fn ( $ episode ) => $ episode > 3 && $ episode < 8 ;

foreach (Single:: filter ( $ starWarsEpisodes , $ goodMoviePredicate ) as $ goodMovie ) {
    print ( $ goodMovie );
}
// 4, 5, 6, 7

Фильтр правда

Отфильтруйте элементы из иерных только возвращающихся элементов, которые являются правдой.

Single::filterTrue(iterable $data)

 use IterTools  Single ;

$ reportCardGrades = [ 100 , 0 , 95 , 85 , 0 , 94 , 0 ];

foreach (Single:: filterTrue ( $ reportCardGrades ) as $ goodGrade ) {
    print ( $ goodGrade );
}
// 100, 95, 85, 94

Фильтр ложный

Отфильтруйте элементы из итерационных только возвращающихся элементов, где функция предиката является ложным.

Если предикат не предоставляется, используется логическое значение данных.

Single::filterFalse(iterable $data, callable $predicate)

 use IterTools  Single ;

$ alerts = [ 0 , 1 , 1 , 0 , 1 , 0 , 0 , 1 , 1 ];

foreach (Single:: filterFalse ( $ alerts ) as $ noAlert ) {
    print ( $ noAlert );
}
// 0, 0, 0, 0

Ключи фильтра

Отфильтруйте элементы из итерационных только возвращающихся элементов, для которых ключи функции предиката верны.

Single::filterKeys(iterable $data, callable $predicate)

 use IterTools  Single ;

$ olympics = [
    2000 => ' Sydney ' ,
    2002 => ' Salt Lake City ' ,
    2004 => ' Athens ' ,
    2006 => ' Turin ' ,
    2008 => ' Beijing ' ,
    2010 => ' Vancouver ' ,
    2012 => ' London ' ,
    2014 => ' Sochi ' ,
    2016 => ' Rio de Janeiro ' ,
    2018 => ' Pyeongchang ' ,
    2020 => ' Tokyo ' ,
    2022 => ' Beijing ' ,
];

$ summerFilter = fn ( $ year ) => $ year % 4 === 0 ;

foreach (Single:: filterKeys ( $ olympics , $ summerFilter ) as $ year => $ hostCity ) {
    print ( " $ year : $ hostCity " .  PHP_EOL );
}
// 2000: Sydney
// 2004: Athens
// 2008: Beijing
// 2012: London
// 2016: Rio de Janeiro
// 2020: Tokyo

Плоская карта

Сопоставьте функцию только элементы итерабильного, а затем выравнивайте результаты.

Single::flatMap(iterable $data, callable $mapper)

 use IterTools  Single ;

$ data   = [ 1 , 2 , 3 , 4 , 5 ];
$ mapper = fn ( $ item ) => [ $ item , - $ item ];

foreach (Single:: flatMap ( $ data , $ mapper ) as $ number ) {
    print ( $ number . ' ' );
}
// 1 -1 2 -2 3 -3 4 -4 5 -5

Сглаживать

Сплющите многомерную итерационную.

Single::flatten(iterable $data, int $dimensions = 1)

 use IterTools  Single ;

$ multidimensional = [ 1 , [ 2 , 3 ], [ 4 , 5 ]];

$ flattened = [];
foreach (Single:: flatten ( $ multidimensional ) as $ number ) {
    $ flattened [] = $ number ;
}
// [1, 2, 3, 4, 5]

Группа по

Групповые данные общего элемента данных.

Single::groupBy(iterable $data, callable $groupKeyFunction, callable $itemKeyFunction = null)

• $groupKeyFunction определяет ключ к групповым элементам.
• Дополнительная $itemKeyFunction допускает пользовательские индексы в каждом члене группы.

 use IterTools  Single ;

$ cartoonCharacters = [
    [ ' Garfield ' , ' cat ' ],
    [ ' Tom ' , ' cat ' ],
    [ ' Felix ' , ' cat ' ],
    [ ' Heathcliff ' , ' cat ' ],
    [ ' Snoopy ' , ' dog ' ],
    [ ' Scooby-Doo ' , ' dog ' ],
    [ ' Odie ' , ' dog ' ],
    [ ' Donald ' , ' duck ' ],
    [ ' Daffy ' , ' duck ' ],
];

$ charactersGroupedByAnimal = [];
foreach (Single:: groupBy ( $ cartoonCharacters , fn ( $ x ) => $ x [ 1 ]) as $ animal => $ characters ) {
    $ charactersGroupedByAnimal [ $ animal ] = $ characters ;
}
/*
'cat' => [
    ['Garfield', 'cat'],
    ['Tom', 'cat'],
    ['Felix', 'cat'],
    ['Heathcliff', 'cat'],
],
'dog' => [
    ['Snoopy', 'dog'],
    ['Scooby-Doo', 'dog'],
    ['Odie', 'dog'],
],
'duck' => [
    ['Donald', 'duck'],
    ['Daffy', 'duck'],
*/

Предел

Итерация до предела.

Остановка, даже если больше данных доступно, если ограничен достигнут.

Single::limit(iterable $data, int $limit)

 use IterTools  Single ;

$ matrixMovies = [ ' The Matrix ' , ' The Matrix Reloaded ' , ' The Matrix Revolutions ' , ' The Matrix Resurrections ' ];
$ limit        = 1 ;

foreach (Single:: limit ( $ matrixMovies , $ limit ) as $ goodMovie ) {
    print ( $ goodMovie );
}
// 'The Matrix' (and nothing else)

Карта

Сопоставьте функцию на каждый элемент.

Single::map(iterable $data, callable $function)

 use IterTools  Single ;

$ grades               = [ 100 , 99 , 95 , 98 , 100 ];
$ strictParentsOpinion = fn ( $ g ) => $ g === 100 ? ' A ' : ' F ' ;

foreach (Single:: map ( $ grades , $ strictParentsOpinion ) as $ actualGrade ) {
    print ( $ actualGrade );
}
// A, F, F, F, A

Пары

Возвращает последовательные перекрывающиеся пары.

Возвращает пустой генератор, если дан сборы, содержит менее 2 элементов.

Single::pairwise(iterable $data)

 use IterTools  Single ;

$ friends = [ ' Ross ' , ' Rachel ' , ' Chandler ' , ' Monica ' , ' Joey ' , ' Phoebe ' ];

foreach (Single:: pairwise ( $ friends ) as [ $ leftFriend , $ rightFriend ]) {
    print ( "{ $ leftFriend } and { $ rightFriend }" );
}
// Ross and Rachel, Rachel and Chandler, Chandler and Monica, ...

Повторить

Повторите элемент.

Single::repeat(mixed $item, int $repetitions)

 use IterTools  Single ;

$ data        = ' Beetlejuice ' ;
$ repetitions = 3 ;

foreach (Single:: repeat ( $ data , $ repetitions ) as $ repeated ) {
    print ( $ repeated );
}
// 'Beetlejuice', 'Beetlejuice', 'Beetlejuice'

Reindex

Клавиши Reindex из ключа итерационные с использованием функции индексера.

Single::reindex(string $data, callable $indexer)

 use IterTools  Single ;

$ data = [
    [
        ' title '   => ' Star Wars: Episode IV – A New Hope ' ,
        ' episode ' => ' IV ' ,
        ' year '    => 1977 ,
    ],
    [
        ' title '   => ' Star Wars: Episode V – The Empire Strikes Back ' ,
        ' episode ' => ' V ' ,
        ' year '    => 1980 ,
    ],
    [
        ' title ' => ' Star Wars: Episode VI – Return of the Jedi ' ,
        ' episode ' => ' VI ' ,
        ' year ' => 1983 ,
    ],
];
$ reindexFunc = fn ( array $ swFilm ) => $ swFilm [ ' episode ' ];

$ reindexedData = [];
foreach (Single:: reindex ( $ data , $ reindexFunc ) as $ key => $ filmData ) {
    $ reindexedData [ $ key ] = $ filmData ;
}
// [
//     'IV' => [
//         'title'   => 'Star Wars: Episode IV – A New Hope',
//         'episode' => 'IV',
//         'year'    => 1977,
//     ],
//     'V' => [
//         'title'   => 'Star Wars: Episode V – The Empire Strikes Back',
//         'episode' => 'V',
//         'year'    => 1980,
//     ],
//     'VI' => [
//         'title' => 'Star Wars: Episode VI – Return of the Jedi',
//         'episode' => 'VI',
//         'year' => 1983,
//     ],
// ]

Обеспечить регресс

Отмените элементы итерабильного.

Single::reverse(iterable $data)

 use IterTools  Single ;

$ words = [ ' Alice ' , ' answers ' , ' your ' , ' questions ' , ' Bob ' ];

foreach (Single:: reverse ( $ words ) as $ word ) {
    print ( $ word . ' ' );
}
// Bob questions your answers Alice

Пропускать

Пропустить n элементов в иерных после необязательного смещения смещения.

Single::skip(iterable $data, int $count, int $offset = 0)

 use IterTools  Single ;

$ movies = [
    ' The Phantom Menace ' , ' Attack of the Clones ' , ' Revenge of the Sith ' ,
    ' A New Hope ' , ' The Empire Strikes Back ' , ' Return of the Jedi ' ,
    ' The Force Awakens ' , ' The Last Jedi ' , ' The Rise of Skywalker '
];

$ prequelsRemoved = [];
foreach (Single:: skip ( $ movies , 3 ) as $ nonPrequel ) {
    $ prequelsRemoved [] = $ nonPrequel ;
} // Episodes IV - IX

$ onlyTheBest = [];
foreach (Single:: skip ( $ prequelsRemoved , 3 , 3 ) as $ nonSequel ) {
    $ onlyTheBest [] = $ nonSequel ;
}
// 'A New Hope', 'The Empire Strikes Back', 'Return of the Jedi'

Среза

Извлеките кусок итерабильного.

Single::slice(iterable $data, int $start = 0, int $count = null, int $step = 1)

 use IterTools  Single ;

$ olympics = [ 1992 , 1994 , 1996 , 1998 , 2000 , 2002 , 2004 , 2006 , 2008 , 2010 , 2012 , 2014 , 2016 , 2018 , 2020 , 2022 ];
$ winterOlympics = [];

foreach (Single:: slice ( $ olympics , 1 , 8 , 2 ) as $ winterYear ) {
    $ winterOlympics [] = $ winterYear ;
}
// [1994, 1998, 2002, 2006, 2010, 2014, 2018, 2022]

Нить

Относит отдельные символы строки.

Single::string(string $string)

 use IterTools  Single ;

$ string = ' MickeyMouse ' ;

$ listOfCharacters = [];
foreach (Single:: string ( $ string ) as $ character ) {
    $ listOfCharacters [] = $ character ;
}
// ['M', 'i', 'c', 'k', 'e', 'y', 'M', 'o', 'u', 's', 'e']

Возьми, пока

Возвращающиеся элементы из итерации до тех пор, пока предикат верен.

Останавливает итерацию, как только предикат вернется ложным, даже если другие элементы в конечном итоге вернут истину (отличается от фильтра).

Single::takeWhile(iterable $data, callable $predicate)

 use IterTools  Single ;

$ prices = [ 0 , 0 , 5 , 10 , 0 , 0 , 9 ];
$ isFree = fn ( $ price ) => $ price == 0 ;

foreach (Single:: takeWhile ( $ prices , $ isFree ) as $ freePrice ) {
    print ( $ freePrice );
}
// 0, 0 

Бесконечная итерация

Считать

Считайте последовательно навсегда.

Infinite::count(int $start = 1, int $step = 1)

 use IterTools  Infinite ;

$ start = 1 ;
$ step  = 1 ;

foreach (Infinite:: count ( $ start , $ step ) as $ i ) {
    print ( $ i );
}
// 1, 2, 3, 4, 5 ...

Цикл

Циклу через элементы сбора последовательно навсегда.

Infinite::cycle(iterable $iterable)

 use IterTools  Infinite ;

$ hands = [ ' rock ' , ' paper ' , ' scissors ' ];

foreach (Infinite:: cycle ( $ hands ) as $ hand ) {
    RockPaperScissors:: playHand ( $ hand );
}
// rock, paper, scissors, rock, paper, scissors, ...

Повторите (бесконечно)

Повторите элемент навсегда.

Infinite::repeat(mixed $item)

 use IterTools  Infinite ;

$ dialogue = ' Are we there yet? ' ;

foreach (Infinite:: repeat ( $ dialogue ) as $ repeated ) {
    print ( $ repeated );
}
// 'Are we there yet?', 'Are we there yet?', 'Are we there yet?', ... 

Случайная итерация

Выбор

Генерировать случайные выборы из массива значений.

Random::choice(array $items, int $repetitions)

 use IterTools  Random ;

$ cards       = [ ' Ace ' , ' King ' , ' Queen ' , ' Jack ' , ' Joker ' ];
$ repetitions = 10 ;

foreach (Random:: choice ( $ cards , $ repetitions ) as $ card ) {
    print ( $ card );
}
// 'King', 'Jack', 'King', 'Ace', ... [random]

Coinflip

Генерировать случайные переворачивания монет (0 или 1).

Random::coinFlip(int $repetitions)

 use IterTools  Random ;

$ repetitions = 10 ;

foreach (Random:: coinFlip ( $ repetitions ) as $ coinFlip ) {
    print ( $ coinFlip );
}
// 1, 0, 1, 1, 0, ... [random]

Число

Генерировать случайные числа (целые числа).

Random::number(int $min, int $max, int $repetitions)

 use IterTools  Random ;

$ min         = 1 ;
$ max         = 4 ;
$ repetitions = 10 ;

foreach (Random:: number ( $ min , $ max , $ repetitions ) as $ number ) {
    print ( $ number );
}
// 3, 2, 5, 5, 1, 2, ... [random]

Процент

Генерировать случайный процент от 0 до 1.

Random::percentage(int $repetitions)

 use IterTools  Random ;

$ repetitions = 10 ;

foreach (Random:: percentage ( $ repetitions ) as $ percentage ) {
    print ( $ percentage );
}
// 0.30205562629132, 0.59648594775233, ... [random]

Rockpaperscissors

Генерировать случайные ручки с ножом в скалах.

Random::rockPaperScissors(int $repetitions)

 use IterTools  Random ;

$ repetitions = 10 ;

foreach (Random:: rockPaperScissors ( $ repetitions ) as $ rpsHand ) {
    print ( $ rpsHand );
}
// 'paper', 'rock', 'rock', 'scissors', ... [random] 

Математическая итерация

Частоты

Возвращает частотное распределение данных.

Math::frequencies(iterable $data, bool $strict = true): Generator

По умолчанию строгие сравнения типа. Установите строгое значение false для сравнения принуждения типа.

 use IterTools  Math ;

$ grades = [ ' A ' , ' A ' , ' B ' , ' B ' , ' B ' , ' C ' ];

foreach (Math:: frequencies ( $ grades ) as $ grade => $ frequency ) {
    print ( " $ grade : $ frequency " .  PHP_EOL );
}
// A: 2, B: 3, C: 1

Относительные частоты

Возвращает относительное распределение частот данных.

Math::relativeFrequencies(iterable $data, bool $strict = true): Generator

По умолчанию строгие сравнения типа. Установите строгое значение false для сравнения принуждения типа.

 use IterTools  Math ;

$ grades = [ ' A ' , ' A ' , ' B ' , ' B ' , ' B ' , ' C ' ];

foreach (Math:: relativeFrequencies ( $ grades ) as $ grade => $ frequency ) {
    print ( " $ grade : $ frequency " .  PHP_EOL );
}
// A: 0.33, B: 0.5, C: 0.166

Среднее время бега

Накапливайте среднее значение по списку чисел.

Math::runningAverage(iterable $numbers, int|float $initialValue = null)

 use IterTools  Math ;

$ grades = [ 100 , 80 , 80 , 90 , 85 ];

foreach (Math:: runningAverage ( $ grades ) as $ runningAverage ) {
    print ( $ runningAverage );
}
// 100, 90, 86.667, 87.5, 87

Разница в беге

Накапливайте разницу в списке чисел.

Math::runningDifference(iterable $numbers, int|float $initialValue = null)

 use IterTools  Math ;

$ credits = [ 1 , 2 , 3 , 4 , 5 ];

foreach (Math:: runningDifference ( $ credits ) as $ runningDifference ) {
    print ( $ runningDifference );
}
// -1, -3, -6, -10, -15

Предоставьте дополнительное начальное значение, чтобы вывести разницу в запуске.

 use IterTools  Math ;

$ dartsScores   = [ 50 , 50 , 25 , 50 ];
$ startingScore = 501 ;

foreach (Math:: runningDifference ( $ dartsScores , $ startingScore ) as $ runningScore ) {
    print ( $ runningScore );
}
// 501, 451, 401, 376, 326

Запуск макс

Накапливайте максимум бега по списку чисел.

Math::runningMax(iterable $numbers, int|float $initialValue = null)

 use IterTools  Math ;

$ numbers = [ 1 , 2 , 1 , 3 , 5 ];

foreach (Math:: runningMax ( $ numbers ) as $ runningMax ) {
    print ( $ runningMax );
}
// 1, 2, 2, 3, 5

Бег мин

Накапливайте минимум работы по списку чисел.

Math::runningMin(iterable $numbers, int|float $initialValue = null)

 use IterTools  Math ;

$ numbers = [ 3 , 4 , 2 , 5 , 1 ];

foreach (Math:: runningMin ( $ numbers ) as $ runningMin ) {
    print ( $ runningMin );
}
// 3, 3, 2, 2, 1

Работающий продукт

Накапливайте работающий продукт по списку чисел.

Math::runningProduct(iterable $numbers, int|float $initialValue = null)

 use IterTools  Math ;

$ numbers = [ 1 , 2 , 3 , 4 , 5 ];

foreach (Math:: runningProduct ( $ numbers ) as $ runningProduct ) {
    print ( $ runningProduct );
}
// 1, 2, 6, 24, 120

Предоставьте дополнительное начальное значение, чтобы вывести работающий продукт.

 use IterTools  Math ;

$ numbers      = [ 1 , 2 , 3 , 4 , 5 ];
$ initialValue = 5 ;

foreach (Math:: runningProduct ( $ numbers , $ initialValue ) as $ runningProduct ) {
    print ( $ runningProduct );
}
// 5, 5, 10, 30, 120, 600

Запуск всего

Накапливайте общее количество запуска по списку чисел.

Math::runningTotal(iterable $numbers, int|float $initialValue = null)

 use IterTools  Math ;

$ prices = [ 1 , 2 , 3 , 4 , 5 ];

foreach (Math:: runningTotal ( $ prices ) as $ runningTotal ) {
    print ( $ runningTotal );
}
// 1, 3, 6, 10, 15

Предоставьте дополнительное начальное значение, чтобы вывести общее количество работы.

 use IterTools  Math ;

$ prices       = [ 1 , 2 , 3 , 4 , 5 ];
$ initialValue = 5 ;

foreach (Math:: runningTotal ( $ prices , $ initialValue ) as $ runningTotal ) {
    print ( $ runningTotal );
}
// 5, 6, 8, 11, 15, 20 

SET и MULTISET

Отчетливый

Отфильтруйте элементы из итерабильных только возвращающихся отдельных элементов.

Set::distinct(iterable $data, bool $strict = true)

По умолчанию строгие сравнения типа. Установите строгое значение false для сравнения принуждения типа.

 use IterTools  Set ;

$ chessSet = [ ' rook ' , ' rook ' , ' knight ' , ' knight ' , ' bishop ' , ' bishop ' , ' king ' , ' queen ' , ' pawn ' , ' pawn ' , ... ];

foreach (Set:: distinct ( $ chessSet ) as $ chessPiece ) {
    print ( $ chessPiece );
}
// rook, knight, bishop, king, queen, pawn

$ mixedTypes = [ 1 , ' 1 ' , 2 , ' 2 ' , 3 ];

foreach (Set:: distinct ( $ mixedTypes , false ) as $ datum ) {
    print ( $ datum );
}
// 1, 2, 3

Отличается по

Отфильтруйте элементы из итерационных только возврата различных элементов в соответствии с пользовательской функцией компаратора.

Set::distinctBy(iterable $data, callable $compareBy)

 use IterTools  Set ;

$ streetFighterConsoleReleases = [
    [ ' id ' => ' 112233 ' , ' name ' => ' Street Fighter 3 3rd Strike ' , ' console ' => ' Dreamcast ' ],
    [ ' id ' => ' 223344 ' , ' name ' => ' Street Fighter 3 3rd Strike ' , ' console ' => ' PS4 ' ],
    [ ' id ' => ' 334455 ' , ' name ' => ' Street Fighter 3 3rd Strike ' , ' console ' => ' PS5 ' ],
    [ ' id ' => ' 445566 ' , ' name ' => ' Street Fighter VI ' , ' console ' => ' PS4 ' ],
    [ ' id ' => ' 556677 ' , ' name ' => ' Street Fighter VI ' , ' console ' => ' PS5 ' ],
    [ ' id ' => ' 667788 ' , ' name ' => ' Street Fighter VI ' , ' console ' => ' PC ' ],
];
$ compareBy = fn ( $ sfTitle ) => $ sfTitle [ ' name ' ];

$ uniqueTitles = [];
foreach (Set:: distinctBy ( $ streetFighterConsoleReleases , $ compareBy ) as $ sfTitle ) {
    $ uniqueTitles [] = $ sfTitle ;
}

// Contains one SF3 3rd Strike entry and one SFVI entry.

Пересечение

Итерат пересечения итерабл.

Set::intersection(iterable ...$iterables)

Если входные итерационные характеристики производят дубликаты элементов, то применяются правила MultiSet.

 use IterTools  Set ;

$ chessPieces = [ ' rook ' , ' knight ' , ' bishop ' , ' queen ' , ' king ' , ' pawn ' ];
$ shogiPieces = [ ' rook ' , ' knight ' , ' bishop ' 'king', ' pawn ' , ' lance ' , ' gold general ' , ' silver general ' ];

foreach (Set:: intersection ( $ chessPieces , $ shogiPieces ) as $ commonPiece ) {
    print ( $ commonPiece );
}
// rook, knight, bishop, king, pawn

Пересечение принудительное

Итерат пересечения итераблев с использованием принуждения типа.

Set::intersectionCoercive(iterable ...$iterables)

Если входные итерационные характеристики производят дубликаты элементов, то применяются правила MultiSet.

 use IterTools  Set ;

$ numbers  = [ 1 , 2 , 3 , 4 , 5 ];
$ numerics = [ ' 1 ' , ' 2 ' , 3 ];

foreach (Set:: intersectionCoercive ( $ numbers , $ numerics ) as $ commonNumber ) {
    print ( $ commonNumber );
}
// 1, 2, 3

Частичное пересечение

Итераты М-часовой пересечения итераблев.

Set::partialIntersection(int $minIntersectionCount, iterable ...$iterables)

• Если входные итерационные характеристики производят дубликаты элементов, то применяются правила MultiSet.

 use IterTools  Set ;

$ staticallyTyped    = [ ' c++ ' , ' java ' , ' c# ' , ' go ' , ' haskell ' ];
$ dynamicallyTyped   = [ ' php ' , ' python ' , ' javascript ' , ' typescript ' ];
$ supportsInterfaces = [ ' php ' , ' java ' , ' c# ' , ' typescript ' ];

foreach (Set:: partialIntersection ( 2 , $ staticallyTyped , $ dynamicallyTyped , $ supportsInterfaces ) as $ language ) {
    print ( $ language );
}
// c++, java, c#, go, php

Частичное перекрестное принуждение

Итераты М-часового пересечения итераблев с использованием принуждения типа.

Set::partialIntersectionCoercive(int $minIntersectionCount, iterable ...$iterables)

• Если входные итерационные характеристики производят дубликаты элементов, то применяются правила MultiSet.

 use IterTools  Set ;

$ set1 = [ 1 , 2 , 3 ],
$ set2 = [ ' 2 ' , ' 3 ' , 4 , 5 ],
$ set3 = [ 1 , ' 2 ' ],

foreach (Set:: partialIntersectionCoercive ( 2 , $ set1 , $ set2 , $ set3 ) as $ partiallyCommonNumber ) {
    print ( $ partiallyCommonNumber );
}
// 1, 2, 3

Симметричная разница

Итерации симметричной разницы в итерации.

Set::symmetricDifference(iterable ...$iterables)

Если входные итерационные характеристики производят дублирующие элементы, то применяются правила разности мультисетов.

 use IterTools  Set ;

$ a = [ 1 , 2 , 3 , 4 , 7 ];
$ b = [ ' 1 ' , 2 , 3 , 5 , 8 ];
$ c = [ 1 , 2 , 3 , 6 , 9 ];

foreach (Set:: symmetricDifference ( $ a , $ b , $ c ) as $ item ) {
    print ( $ item );
}
// 1, 4, 5, 6, 7, 8, 9

Симметричная разница принудительно

Отитерирует симметричную разницу итераблев с принуждением типа.

Set::symmetricDifferenceCoercive(iterable ...$iterables)

Если входные итерационные характеристики производят дублирующие элементы, то применяются правила разности мультисетов.

 use IterTools  Set ;

$ a = [ 1 , 2 , 3 , 4 , 7 ];
$ b = [ ' 1 ' , 2 , 3 , 5 , 8 ];
$ c = [ 1 , 2 , 3 , 6 , 9 ];

foreach (Set:: symmetricDifferenceCoercive ( $ a , $ b , $ c ) as $ item ) {
    print ( $ item );
}
// 4, 5, 6, 7, 8, 9

Союз

Итерат союз иеры.

Set::union(iterable ...$iterables)

Если входные итерационные характеристики производят дубликаты элементов, то применяются правила MultiSet Union.

 use IterTools  Set ;

$ a = [ 1 , 2 , 3 ];
$ b = [ 3 , 4 ];
$ c = [ 1 , 2 , 3 , 6 , 7 ];

foreach (Set:: union ( $ a , $ b , $ c ) as $ item ) {
    print ( $ item );
}
//1, 2, 3, 4, 6, 7

Союз принудительный

Отитерирует союз итераблев с принуждением типа.

Set::unionCoercive(iterable ...$iterables)

Если входные итерационные характеристики производят дубликаты элементов, то применяются правила MultiSet Union.

 use IterTools  Set ;

$ a = [ ' 1 ' , 2 , 3 ];
$ b = [ 3 , 4 ];
$ c = [ 1 , 2 , 3 , 6 , 7 ];

foreach (Set:: unionCoercive ( $ a , $ b , $ c ) as $ item ) {
    print ( $ item );
}
//1, 2, 3, 4, 6, 7 

Сортировать итерацию

Асорт

Относительно сортируется коллекция при сохранении отношений с индексом ассоциативного ключа.

Sort::sort(iterable $data, callable $comparator = null)

Использует сортировку по умолчанию, если не предоставлена ​​необязательная функция компаратора.

 use IterTools  Single ;

$ worldPopulations = [
    ' China '     => 1_439_323_776 ,
    ' India '     => 1_380_004_385 ,
    ' Indonesia ' => 273_523_615 ,
    ' Pakistan '  => 220_892_340 ,
    ' USA '       => 331_002_651 ,
];

foreach (Sort:: sort ( $ worldPopulations ) as $ country => $ population ) {
    print ( " $ country : $ population " .  PHP_EOL );
}
// Pakistan: 220,892,340
// Indonesia: 273,523,615
// USA: 331,002,651
// India: 1,380,004,385
// China: 1,439,323,776

Сортировка

Относит сортировку коллекции.

Sort::sort(iterable $data, callable $comparator = null)

Использует сортировку по умолчанию, если не предоставлена ​​необязательная функция компаратора.

 use IterTools  Single ;

$ data = [ 3 , 4 , 5 , 9 , 8 , 7 , 1 , 6 , 2 ];

foreach (Sort:: sort ( $ data ) as $ datum ) {
    print ( $ datum );
}
// 1, 2, 3, 4, 5, 6, 7, 8, 9 

Файл

Читать CSV

Относительно строки файла CSV.

File::readCsv(resource $fileHandle, string $separator = ',', string $enclosure = '"', string $escape = '\')

 use IterTools  File ;

$ fileHandle = fopen ( ' path/to/file.csv ' , ' r ' );

foreach (File:: readCsv ( $ fileHandle ) as $ row ) {
    print_r ( $ row );
}
// Each column field is an element of the array

Читать строки

Относит строки файла.

File::readLines(resource $fileHandle)

 use IterTools  File ;

$ fileHandle = fopen ( ' path/to/file.txt ' , ' r ' );

foreach (File:: readLines ( $ fileHandle ) as $ line ) {
    print ( $ line );
}

Преобразование

Тройник

Верните несколько независимых (дублированных) итераторов из одного итерабильного.

Transform::tee(iterable $data, int $count): array

 use IterTools  Transform ;

$ daysOfWeek = [ ' Mon ' , ' Tues ' , ' Wed ' , ' Thurs ' , ' Fri ' , ' Sat ' , ' Sun ' ];
$ count = 3 ;

[ $ week1 , $ week2 , $ week3 ] = Transform:: tee ( $ data , $ count );
// Each $week contains iterator containing ['Mon', 'Tues', 'Wed', 'Thurs', 'Fri', 'Sat', 'Sun']

На массив

Превращает любое итерационное в массив.

Transform::toArray(iterable $data): array

 use IterTools  Transform ;

$ iterator = new  ArrayIterator ([ 1 , 2 , 3 , 4 , 5 ]);

$ array = Transform:: toArray ( $ iterator );

В ассоциативном массиве

Преобразует любое итерационное в ассоциативный массив.

Transform::toAssociativeArray(iterable $data, callable $keyFunc = null, callable $valueFunc = null): array

 use IterTools  Transform ;

$ messages = [ ' message 1 ' , ' message 2 ' , ' message 3 ' ];

$ keyFunc   = fn ( $ msg ) => md5 ( $ msg );
$ valueFunc = fn ( $ msg ) => strtoupper ( $ msg );

$ associativeArray = Transform:: toAssociativeArray ( $ messages , $ keyFunc , $ valueFunc );
// [
//     '1db65a6a0a818fd39655b95e33ada11d' => 'MESSAGE 1',
//     '83b2330607fe8f817ce6d24249dea373' => 'MESSAGE 2',
//     '037805d3ad7b10c5b8425427b516b5ce' => 'MESSAGE 3',
// ]

К итератору

Превращает любое итерационное в итератор.

Transform::toArray(iterable $data): array

 use IterTools  Transform ;

$ array = [ 1 , 2 , 3 , 4 , 5 ];

$ iterator = Transform:: toIterator ( $ array );

Краткое содержание

Все матч

Возвращает True, если все элементы соответствуют функции предиката.

Summary::allMatch(iterable $data, callable $predicate): bool

 use IterTools  Summary ;

$ finalFantasyNumbers = [ 4 , 5 , 6 ];
$ isOnSuperNintendo   = fn ( $ ff ) => $ ff >= 4 && $ ff <= 6 ;

$ boolean = Summary:: allMatch ( $ finalFantasyNumbers , $ isOnSuperNintendo );
// true

$ isOnPlaystation = fn ( $ ff ) => $ ff >= 7 && $ ff <= 9 ;

$ boolean = Summary:: allMatch ( $ finalFantasyNumbers , $ isOnPlaystation );
// false

Все уникальные

Возвращает правда, если все элементы уникальны.

Summary::allUnique(iterable $data, bool $strict = true): bool

По умолчанию строгие сравнения типа. Установите строгое значение false для сравнения принуждения типа.

 use IterTools  Summary ;

$ items = [ ' fingerprints ' , ' snowflakes ' , ' eyes ' , ' DNA ' ]

$ boolean = Summary:: allUnique ( $ items );
// true

Любой матч

Возвращает True, если какой -либо элемент соответствует функции предиката.

Summary::anyMatch(iterable $data, callable $predicate): bool

 use IterTools  Summary ;

$ answers          = [ ' fish ' , ' towel ' , 42 , " don't panic " ];
$ isUltimateAnswer = fn ( $ a ) => a == 42 ;

$ boolean = Summary:: anyMatch ( $ answers , $ isUltimateAnswer );
// true

Являются перестановками

Возвращает True, если все итерации являются перестановками друг друга.

Summary::arePermutations(iterable ...$iterables): bool

 use IterTools  Summary ;

$ iter = [ ' i ' , ' t ' , ' e ' , ' r ' ];
$ rite = [ ' r ' , ' i ' , ' t ' , ' e ' ];
$ reit = [ ' r ' , ' e ' , ' i ' , ' t ' ];
$ tier = [ ' t ' , ' i ' , ' e ' , ' r ' ];
$ tire = [ ' t ' , ' i ' , ' r ' , ' e ' ];
$ trie = [ ' t ' , ' r ' , ' i ' , ' e ' ];

$ boolean = Summary:: arePermutations ( $ iter , $ rite , $ reit , $ tier , $ tire , $ trie );
// true

Перестановки являются принудительными

Возвращает True, если все итерации являются перестановкой друг друга с принуждением типа.

Summary::arePermutationsCoercive(iterable ...$iterables): bool

 use IterTools  Summary ;

$ set1 = [ 1 , 2.0 , ' 3 ' ];
$ set2 = [ 2.0 , ' 1 ' , 3 ];
$ set3 = [ 3 , 2 , 1 ];

$ boolean = Summary:: arePermutationsCoercive ( $ set1 , $ set2 , $ set3 );
// true

Точно n

Возвращает True, если точно n элементы верны в соответствии с предикатом.

• ПРЕДУПРЕЖДЕНИЕ ОПЛАТА.
• Предикат по умолчанию является логическим значением каждого элемента.

Summary::exactlyN(iterable $data, int $n, callable $predicate): bool

 use IterTools  Summary ;

$ twoTruthsAndALie = [ true , true , false ];
$ n                = 2 ;

$ boolean = Summary:: exactlyN ( $ twoTruthsAndALie , $ n );
// true

$ ages      = [ 18 , 21 , 24 , 54 ];
$ n         = 4 ;
$ predicate = fn ( $ age ) => $ age >= 21 ;

$ boolean = Summary:: exactlyN ( $ ages , $ n , $ predicate );
// false

Пусто

Возвращает True, если итерационная пуста не имеет предметов.

Summary::isEmpty(iterable $data): bool

 use IterTools  Summary ;

$ data = []

$ boolean = Summary:: isEmpty ( $ data );
// true

Разделен

Возвращает True, если все элементы данной коллекции, которые удовлетворяют предикату, появляются перед всеми элементами, которые нет.

• Возвращает True для пустой коллекции или для коллекции с одним элементом.
• Предикат по умолчанию, если не предоставлен, является логическим значением каждого элемента данных.

Summary::isPartitioned(iterable $data, callable $predicate = null): bool

 use IterTools  Summary ;

$ numbers          = [ 0 , 2 , 4 , 1 , 3 , 5 ];
$ evensBeforeOdds = fn ( $ item ) => $ item % 2 === 0 ;

$ boolean = Summary:: isPartitioned ( $ numbers , $ evensBeforeOdds );

Отсортирован

Возвращает True, если элементы отсортированы, в противном случае неверно.

• Элементы должны быть сопоставимы.
• Возвращает true, если пуст или имеет только один элемент.

Summary::isSorted(iterable $data): bool

 use IterTools  Summary ;

$ numbers = [ 1 , 2 , 3 , 4 , 5 ];

$ boolean = Summary:: isSorted ( $ numbers );
// true

$ numbers = [ 3 , 2 , 3 , 4 , 5 ];

$ boolean = Summary:: isSorted ( $ numbers );
// false

Перевернут

Возвращает True, если элементы отсортированы, в противном случае неверно.

• Элементы должны быть сопоставимы.
• Возвращает true, если пуст или имеет только один элемент.

Summary::isReversed(iterable $data): bool

 use IterTools  Summary ;

$ numbers = [ 5 , 4 , 3 , 2 , 1 ];

$ boolean = Summary:: isReversed ( $ numbers );
// true

$ numbers = [ 1 , 4 , 3 , 2 , 1 ];

$ boolean = Summary:: isReversed ( $ numbers );
// false

Никто не совпадает

Возвращает true, если ни один элемент соответствует функции предиката.

Summary::noneMatch(iterable $data, callable $predicate): bool

 use IterTools  Summary ;

$ grades         = [ 45 , 50 , 61 , 0 ];
$ isPassingGrade = fn ( $ grade ) => $ grade >= 70 ;

$ boolean = Summary:: noneMatch ( $ grades , $ isPassingGrade );
// true

Такой же

Возвращает True, если все данные коллекции одинаковы.

Для одиночных иерных или пустых итераблевых списков возвращает True.

Summary::same(iterable ...$iterables): bool

 use IterTools  Summary ;

$ cocaColaIngredients = [ ' carbonated water ' , ' sugar ' , ' caramel color ' , ' phosphoric acid ' ];
$ pepsiIngredients    = [ ' carbonated water ' , ' sugar ' , ' caramel color ' , ' phosphoric acid ' ];

$ boolean = Summary:: same ( $ cocaColaIngredients , $ pepsiIngredients );
// true

$ cocaColaIngredients = [ ' carbonated water ' , ' sugar ' , ' caramel color ' , ' phosphoric acid ' ];
$ spriteIngredients   = [ ' carbonated water ' , ' sugar ' , ' citric acid ' , ' lemon lime flavorings ' ];

$ boolean = Summary:: same ( $ cocaColaIngredients , $ spriteIngredients );
// false

Тот же счет

Возвращает True, если все данные коллекции имеют одинаковую длину.

Для одиночных иерных или пустых итераблевых списков возвращает True.

Summary::sameCount(iterable ...$iterables): bool

 use IterTools  Summary ;

$ prequels  = [ ' Phantom Menace ' , ' Attack of the Clones ' , ' Revenge of the Sith ' ];
$ originals = [ ' A New Hope ' , ' Empire Strikes Back ' , ' Return of the Jedi ' ];
$ sequels   = [ ' The Force Awakens ' , ' The Last Jedi ' , ' The Rise of Skywalker ' ];

$ boolean = Summary:: sameCount ( $ prequels , $ originals , $ sequels );
// true

$ batmanMovies = [ ' Batman Begins ' , ' The Dark Knight ' , ' The Dark Knight Rises ' ];
$ matrixMovies = [ ' The Matrix ' , ' The Matrix Reloaded ' , ' The Matrix Revolutions ' , ' The Matrix Resurrections ' ];

$ result = Summary:: sameCount ( $ batmanMovies , $ matrixMovies );
// false 

Уменьшать

В среднем

Сводится к среднему среднему.

Возвращает NULL, если коллекция пуста.

Reduce::toAverage(iterable $data): float

 use IterTools  Reduce ;

$ grades = [ 100 , 90 , 95 , 85 , 94 ];

$ finalGrade = Reduce:: toAverage ( $ numbers );
// 92.8

Считать

Уменьшается до его длины.

Reduce::toCount(iterable $data): int

 use IterTools  Reduce ;

$ someIterable = ImportantThing:: getCollectionAsIterable ();

$ length = Reduce:: toCount ( $ someIterable );
// 3

К первым

Снижает итерабильный до своего первого элемента.

Reduce::toFirst(iterable $data): mixed

Бросает LengthException если коллекция пуста.

 use IterTools  Reduce ;

$ medals = [ ' gold ' , ' silver ' , ' bronze ' ];

$ first = Reduce:: toFirst ( $ medals );
// gold

В первую очередь

Снижение итерабильно до его первого и последнего элементов.

Reduce::toFirstAndLast(iterable $data): array{mixed, mixed}

Бросает LengthException если коллекция пуста.

 use IterTools  Reduce ;

$ weekdays = [ ' Monday ' , ' Tuesday ' , ' Wednesday ' , ' Thursday ' , ' Friday ' ];

$ firstAndLast = Reduce:: toFirstAndLast ( $ weekdays );
// [Monday, Friday]

Последнее

Уменьшается до последнего элемента.

Reduce::toLast(iterable $data): mixed

Бросает LengthException если коллекция пуста.

 use IterTools  Reduce ;

$ gnomesThreePhasePlan = [ ' Collect underpants ' , ' ? ' , ' Profit ' ];

$ lastPhase = Reduce:: toLast ( $ gnomesThreePhasePlan );
// Profit

Макс

Сводит к максимальному значению.

Reduce::toMax(iterable $data, callable $compareBy = null): mixed|null

• Необязательный Callable Param $compareBy должен вернуть сопоставимое значение.
• Если $compareBy не предоставлен, то предметы данной коллекции должны быть сопоставимы.
• Возвращает NULL, если коллекция пуста.

 use IterTools  Reduce ;

$ numbers = [ 5 , 3 , 1 , 2 , 4 ];

$ result = Reduce:: toMax ( $ numbers );
// 5

$ movieRatings = [
    [
        ' title ' => ' Star Wars: Episode IV - A New Hope ' ,
        ' rating ' => 4.6
    ],
    [
        ' title ' => ' Star Wars: Episode V - The Empire Strikes Back ' ,
        ' rating ' => 4.8
    ],
    [
        ' title ' => ' Star Wars: Episode VI - Return of the Jedi ' ,
        ' rating ' => 4.6
    ],
];
$ compareBy = fn ( $ movie ) => $ movie [ ' rating ' ];

$ highestRatedMovie = Reduce:: toMax ( $ movieRatings , $ compareBy );
// [
//     'title' => 'Star Wars: Episode V - The Empire Strikes Back',
//     'rating' => 4.8
// ];

До мин

Снижение до значения MIN.

Reduce::toMin(iterable $data, callable $compareBy = null): mixed|null

• Необязательный Callable Param $compareBy должен вернуть сопоставимое значение.
• Если $compareBy не предоставлен, то предметы данной коллекции должны быть сопоставимы.
• Возвращает NULL, если коллекция пуста.

 use IterTools  Reduce ;

$ numbers = [ 5 , 3 , 1 , 2 , 4 ];

$ result = Reduce:: toMin ( $ numbers );
// 1


$ movieRatings = [
    [
        ' title ' => ' The Matrix ' ,
        ' rating ' => 4.7
    ],
    [
        ' title ' => ' The Matrix Reloaded ' ,
        ' rating ' => 4.3
    ],
    [
        ' title ' => ' The Matrix Revolutions ' ,
        ' rating ' => 3.9
    ],
    [
        ' title ' => ' The Matrix Resurrections ' ,
        ' rating ' => 2.5
    ],
];
$ compareBy = fn ( $ movie ) => $ movie [ ' rating ' ];

$ lowestRatedMovie = Reduce:: toMin ( $ movieRatings , $ compareBy );
// [
//     'title' => 'The Matrix Resurrections',
//     'rating' => 2.5
// ]

Мин макс

Снижение до массива его верхних и нижних границ (макс и мин).

Reduce::toMinMax(iterable $numbers, callable $compareBy = null): array

• Необязательный Callable Param $compareBy должен вернуть сопоставимое значение.
• Если $compareBy не предоставлен, то предметы данной коллекции должны быть сопоставимы.
• Возвращает [null, null] , если данная коллекция пуста.

 use IterTools  Reduce ;

$ numbers = [ 1 , 2 , 7 , - 1 , - 2 , - 3 ];

[ $ min , $ max ] = Reduce:: toMinMax ( $ numbers );
// [-3, 7]

$ reportCard = [
    [
        ' subject ' => ' history ' ,
        ' grade ' => 90
    ],
    [
        ' subject ' => ' math ' ,
        ' grade ' => 98
    ],
    [
        ' subject ' => ' science ' ,
        ' grade ' => 92
    ],
    [
        ' subject ' => ' english ' ,
        ' grade ' => 85
    ],
    [
        ' subject ' => ' programming ' ,
        ' grade ' => 100
    ],
];
$ compareBy = fn ( $ class ) => $ class [ ' grade ' ];

$ bestAndWorstSubject = Reduce:: toMinMax ( $ reportCard , $ compareBy );
// [
//     [
//         'subject' => 'english',
//         'grade' => 85
//     ],
//     [
//         'subject' => 'programming',
//         'grade' => 100
//     ],
// ]

До nth

Снижается до стоимости в NTH Position.

Reduce::toNth(iterable $data, int $position): mixed

 use IterTools  Reduce ;

$ lotrMovies = [ ' The Fellowship of the Ring ' , ' The Two Towers ' , ' The Return of the King ' ];

$ rotk = Reduce:: toNth ( $ lotrMovies , 2 );
// 20

К продукту

Сводится к продукту его элементов.

Возвращает NULL, если коллекция пуста.

Reduce::toProduct(iterable $data): number|null

 use IterTools  Reduce ;

$ primeFactors = [ 5 , 2 , 2 ];

$ number = Reduce:: toProduct ( $ primeFactors );
// 20

К случайному значению

Снижает данную сбору до случайного значения внутри него.

Reduce::toRandomValue(iterable $data): mixed

 use IterTools  Reduce ;

$ sfWakeupOptions = [ ' mid ' , ' low ' , ' overhead ' , ' throw ' , ' meaty ' ];

$ wakeupOption = Reduce:: toRandomValue ( $ sfWakeupOptions );
// e.g., throw

В диапазоне

Снижает приведенную коллекцию до его диапазона (разница между Максом и Мин).

Reduce::toRange(iterable $numbers): int|float

Возвращает 0 , если итерабильный источник пуст.

 use IterTools  Reduce ;

$ grades = [ 100 , 90 , 80 , 85 , 95 ];

$ range = Reduce:: toRange ( $ numbers );
// 20

К строке

Снижается до строки, соединяющей все элементы.

• Дополнительный сепаратор для вставки между элементами.
• Необязательный префикс для подготовки к строке.
• Дополнительный суффикс для добавления к строке.

Reduce::toString(iterable $data, string $separator = '', string $prefix = '', string $suffix = ''): string

 use IterTools  Reduce ;

$ words = [ ' IterTools ' , ' PHP ' , ' v1.0 ' ];

$ string = Reduce:: toString ( $ words );
// IterToolsPHPv1.0
$ string = Reduce:: toString ( $ words , ' - ' );
// IterTools-PHP-v1.0
$ string = Reduce:: toString ( $ words , ' - ' , ' Library: ' );
// Library: IterTools-PHP-v1.0
$ string = Reduce:: toString ( $ words , ' - ' , ' Library: ' , ' ! ' );
// Library: IterTools-PHP-v1.0!

Суммировать

Сводится к сумме его элементов.

Reduce::toSum(iterable $data): number

 use IterTools  Reduce ;

$ parts = [ 10 , 20 , 30 ];

$ sum = Reduce:: toSum ( $ parts );
// 60

По цене

Уменьшите элементы до одного значения, используя функцию Reducer.

Reduce::toValue(iterable $data, callable $reducer, mixed $initialValue): mixed

 use IterTools  Reduce ;

$ input = [ 1 , 2 , 3 , 4 , 5 ];
$ sum   = fn ( $ carry , $ item ) => $ carry + $ item ;

$ result = Reduce:: toValue ( $ input , $ sum , 0 );
// 15 

Транслировать

Потоки обеспечивают свободный интерфейс для преобразования массивов и итераций через трубопровод операций.

Потоки состоят из:

1. Один метод фабрики источника потока для создания потока.
2. Ноль или более операторов потока, которые преобразуют поток в новый поток.
3. Терминальная работа любого:
   • Операция потока терминала для преобразования потока в значение или структуру данных.

    $ result = Stream:: of ([ 1 , 1 , 2 , 2 , 3 , 4 , 5 ])
      -> distinct ()                  // [1, 2, 3, 4, 5]
      -> map ( fn ( $ x ) => $ x ** 2 )       // [1, 4, 9, 16, 25]
      -> filter ( fn ( $ x ) => $ x < 10 )  // [1, 4, 9]
      -> toSum ();                    // 14

   • Поток повторяется через петлю foreach .

    $ result = Stream:: of ([ 1 , 1 , 2 , 2 , 3 , 4 , 5 ])
      -> distinct ()                  // [1, 2, 3, 4, 5]
      -> map ( fn ( $ x ) => $ x ** 2 )       // [1, 4, 9, 16, 25]
      -> filter ( fn ( $ x ) => $ x < 10 ); // [1, 4, 9]
   
   foreach ( $ result as $ item ) {
       // 1, 4, 9
   }

Потоковые источники

Из

Создает поток из итерабильного.

Stream::of(iterable $iterable): Stream

 use IterTools  Stream ;

$ iterable = [ 1 , 2 , 3 ];

$ result = Stream:: of ( $ iterable )
    -> chainWith ([ 4 , 5 , 6 ], [ 7 , 8 , 9 ])
    -> zipEqualWith ([ 1 , 2 , 3 , 4 , 5 , 6 , 7 , 8 , 9 ])
    -> toValue ( fn ( $ carry , $ item ) => $ carry + array_sum ( $ item ));
// 90 

Монетных переворот

Создает поток n случайных монет.

Stream::ofCoinFlips(int $repetitions): Stream

 use IterTools  Stream ;

$ result = Stream:: ofCoinFlips ( 10 )
    -> filterTrue ()
    -> toCount ();
// 5 (random) 

Файла CSV

Создает поток рядов файла CSV.

Stream::ofCsvFile(resource $fileHandle, string $separator = ',', string $enclosure = '"', string = $escape = '\'): Stream

 use IterTools  Stream ;

$ fileHandle = fopen ( ' path/to/file.csv ' , ' r ' );

$ result = Stream:: of ( $ fileHandle )
    -> toArray ();

Пустого

Создает поток ничего.

Stream::ofEmpty(): Stream

 use IterTools  Stream ;

$ result = Stream:: ofEmpty ()
    -> chainWith ([ 1 , 2 , 3 ])
    -> toArray ();
// 1, 2, 3 

Файловых строк

Создает поток строк файла.

Stream::ofFileLines(resource $fileHandle): Stream

 use IterTools  Stream ;

$ fileHandle = fopen ( ' path/to/file.txt ' , ' r ' );

$ result = Stream:: of ( $ fileHandle )
    -> map ( ' strtoupper ' );
    -> toArray ();

Случайного выбора

Создает поток случайных выборов из массива значений.

Stream::ofRandomChoice(array $items, int $repetitions): Stream

 use IterTools  Stream ;

$ languages = [ ' PHP ' , ' Go ' , ' Python ' ];

$ languages = Stream:: ofRandomChoice ( $ languages , 5 )
    -> toArray ();
// 'Go', 'PHP', 'Python', 'PHP', 'PHP' (random) 

Случайных чисел

Создает поток случайных чисел (целые числа).

Stream::ofRandomNumbers(int $min, int $max, int $repetitions): Stream

 use IterTools  Stream ;

$ min  = 1 ;
$ max  = 3 ;
$ reps = 7 ;

$ result = Stream:: ofRandomNumbers ( $ min , $ max , $ reps )
    -> toArray ();
// 1, 2, 2, 1, 3, 2, 1 (random) 

Случайного процента

Создает поток случайных процентов от 0 до 1.

Stream::ofRandomPercentage(int $repetitions): Stream

 use IterTools  Stream ;

$ stream = Stream:: ofRandomPercentage ( 3 )
    -> toArray ();
// 0.8012566976245, 0.81237281724151, 0.61676896329459 [random] 

Диапазона

Создает поток ряда чисел.

Stream::ofRange(int|float $start, int|float $end, int|float $step = 1): Stream

 use IterTools  Stream ;

$ numbers = Stream:: ofRange ( 0 , 5 )
    -> toArray ();
// 0, 1, 2, 3, 4, 5 

Ножницы для рок -бумаги

Создает поток рук с помощью рок-бумаги.

Stream::ofRockPaperScissors(int $repetitions): Stream

 use IterTools  Stream ;

$ rps = Stream:: ofRockPaperScissors ( 5 )
    -> toArray ();
// 'paper', 'rock', 'rock', 'scissors', 'paper' [random]

Операции потока

Асорт

Сортирует поток, поддерживая ключи.

$stream->asort(callable $comparator = null)

Если компаратор не предоставлен, элементы итерабильного источника должны быть сопоставимы.

 use IterTools  Stream ;

$ worldPopulations = [
    ' China '     => 1_439_323_776 ,
    ' India '     => 1_380_004_385 ,
    ' Indonesia ' => 273_523_615 ,
    ' USA '       => 331_002_651 ,
];

$ result = Stream:: of ( $ worldPopulations )
    -> filter ( fn ( $ pop ) => $ pop > 300_000_000 )
    -> asort ()
    -> toAssociativeArray ();
// USA   => 331_002_651,
// India => 1_380_004_385,
// China => 1_439_323_776, 

Цепь с

Верните потоковую цепочку дополнительных источников вместе в один последовательный поток.

$stream->chainWith(iterable ...$iterables): Stream

 use IterTools  Stream ;

$ input = [ 1 , 2 , 3 ];

$ result = Stream:: of ( $ input )
    -> chainWith ([ 4 , 5 , 6 ])
    -> chainWith ([ 7 , 8 , 9 ])
    -> toArray ();
// 1, 2, 3, 4, 5, 6, 7, 8, 9 

Компресс

Сжатие к новому потоку путем фильтрации данных, которые не выбраны.

$stream->compress(iterable $selectors): Stream

Селекторы указывают, какие данные. Истинное значение выбирает элемент. Ложное значение фильтрует данные.

 use IterTools  Stream ;

$ input = [ 1 , 2 , 3 ];

$ result = Stream:: of ( $ input )
    -> compress ([ 0 , 1 , 1 ])
    -> toArray ();
// 2, 3 

Сжатие ассоциативной

Сжатие к новому потоку, отфильтровав клавиши, которые не выбраны.

$stream->compressAssociative(array $keys): Stream

• Стандартные только клавиши массива PHP/итератора (строка, целое число).

 use IterTools  Stream ;

$ starWarsEpisodes = [
    ' I '    => ' The Phantom Menace ' ,
    ' II '   => ' Attack of the Clones ' ,
    ' III '  => ' Revenge of the Sith ' ,
    ' IV '   => ' A New Hope ' ,
    ' V '    => ' The Empire Strikes Back ' ,
    ' VI '   => ' Return of the Jedi ' ,
    ' VII '  => ' The Force Awakens ' ,
    ' VIII ' => ' The Last Jedi ' ,
    ' IX '   => ' The Rise of Skywalker ' ,
];
$ sequelTrilogyNumbers = [ ' VII ' , ' VIII ' , ' IX ' ];

$ sequelTrilogy = Stream:: of ( $ starWarsEpisodes )
    -> compressAssociative ( $ sequelTrilogyNumbers )
    -> toAssociativeArray ();
// 'VII'  => 'The Force Awakens',
// 'VIII' => 'The Last Jedi',
// 'IX'   => 'The Rise of Skywalker', 

Кусок

Верните поток, состоящий из кусков элементов из потока.

$stream->chunkwise(int $chunkSize): Stream

Размер куски должен быть не менее 1.

 use IterTools  Stream ;

$ friends = [ ' Ross ' , ' Rachel ' , ' Chandler ' , ' Monica ' , ' Joey ' ];

$ result = Stream:: of ( $ friends )
    -> chunkwise ( 2 )
    -> toArray ();
// ['Ross', 'Rachel'], ['Chandler', 'Monica'], ['Joey'] 

Через перекрытие

Верните поток, состоящий из перекрывающихся кусков элементов из потока.

$stream->chunkwiseOverlap(int $chunkSize, int $overlapSize, bool $includeIncompleteTail = true): Stream

• Размер куски должен быть не менее 1.
• Размер перекрытия должен быть меньше, чем размер чанка.

 use IterTools  Stream ;

$ numbers = [ 1 , 2 , 3 , 4 , 5 , 6 , 7 , 8 , 9 ];

$ result = Stream:: of ( $ friends )
    -> chunkwiseOverlap ( 3 , 1 )
    -> toArray ()
// [1, 2, 3], [3, 4, 5], [5, 6, 7], [7, 8, 9] 

Отчетливый

Верните потоковую фильтрацию элементов из потока, возвращающих различные элементы.

$stream->distinct(bool $strict = true): Stream

По умолчанию строгие сравнения типа. Установите строгое значение false для сравнения принуждения типа.

 use IterTools  Stream ;

$ input = [ 1 , 2 , 1 , 2 , 3 , 3 , ' 1 ' , ' 1 ' , ' 2 ' , ' 3 ' ];
$ stream = Stream:: of ( $ input )
    -> distinct ()
    -> toArray ();
// 1, 2, 3, '1', '2', '3'

$ stream = Stream:: of ( $ input )
    -> distinct ( false )
    -> toArray ();
// 1, 2, 3 

Отличается по

Возврат потоковой фильтрации элементов из потока только возврата различных элементов в соответствии с пользовательской функцией компаратора.

$stream->distinctBy(callable $compareBy): Stream

 use IterTools  Stream ;

$ streetFighterConsoleReleases = [
    [ ' id ' => ' 112233 ' , ' name ' => ' Street Fighter 3 3rd Strike ' , ' console ' => ' Dreamcast ' ],
    [ ' id ' => ' 223344 ' , ' name ' => ' Street Fighter 3 3rd Strike ' , ' console ' => ' PS4 ' ],
    [ ' id ' => ' 334455 ' , ' name ' => ' Street Fighter 3 3rd Strike ' , ' console ' => ' PS5 ' ],
    [ ' id ' => ' 445566 ' , ' name ' => ' Street Fighter VI ' , ' console ' => ' PS4 ' ],
    [ ' id ' => ' 556677 ' , ' name ' => ' Street Fighter VI ' , ' console ' => ' PS5 ' ],
    [ ' id ' => ' 667799 ' , ' name ' => ' Street Fighter VI ' , ' console ' => ' PC ' ],
];
$ stream = Stream:: of ( $ streetFighterConsoleReleases )
    -> distinctBy ( fn ( $ sfTitle ) => $ sfTitle [ ' name ' ])
    -> toArray ();
// Contains one SF3 3rd Strike entry and one SFVI entry 

Бросить в то время как

Отбрасывать элементы из потока, пока функция предиката верна.

$stream->dropWhile(callable $predicate): Stream

Как только функция предиката возвращается в False, все оставшиеся элементы возвращаются.

 use IterTools  Stream ;

$ input = [ 1 , 2 , 3 , 4 , 5 ]

$ result = Stream:: of ( $ input )
    -> dropWhile ( fn ( $ value ) => $ value < 3 )
    -> toArray ();
// 3, 4, 5 

Фильтр

Отфильтруйте элементы из потока только для хранения элементов, в которых существует функция предиката.

$stream->filter(callable $predicate): Stream

 use IterTools  Stream ;

$ input = [ 1 , - 1 , 2 , - 2 , 3 , - 3 ];

$ result = Stream:: of ( $ input )
    -> filter ( fn ( $ value ) => $ value > 0 )
    -> toArray ();
// 1, 2, 3 

Фильтр правда

Отфильтровывать элементы из потока только сохраняют правдивые элементы.

$stream->filterTrue(): Stream

 use IterTools  Stream ;

$ input = [ 0 , 1 , 2 , 3 , 0 , 4 ];

$ result = Stream:: of ( $ input )
    -> filterTrue ()
    -> toArray ();
// 1, 2, 3, 4 

Фильтр ложный

Отфильтровывать элементы из потока только сохраняют элементы, которые являются фальшивыми.

$stream->filterFalse(): Stream

 use IterTools  Stream ;

$ input = [ 0 , 1 , 2 , 3 , 0 , 4 ];

$ result = Stream:: of ( $ input )
    -> filterFalse ()
    -> toArray ();
// 0, 0 

Ключи фильтра

Отфильтруйте элементы из потока, сохраняя только элементы, где функция предиката на ключах верна.

$stream->filterKeys(callable $filter): Stream

 $ olympics = [
    2000 => ' Sydney ' ,
    2002 => ' Salt Lake City ' ,
    2004 => ' Athens ' ,
    2006 => ' Turin ' ,
    2008 => ' Beijing ' ,
    2010 => ' Vancouver ' ,
    2012 => ' London ' ,
    2014 => ' Sochi ' ,
    2016 => ' Rio de Janeiro ' ,
    2018 => ' Pyeongchang ' ,
    2020 => ' Tokyo ' ,
    2022 => ' Beijing ' ,
];

$ winterFilter = fn ( $ year ) => $ year % 4 === 2 ;

$ result = Stream:: of ( $ olympics )
    -> filterKeys ( $ winterFilter )
    -> toAssociativeArray ();
}
// 2002 => Salt Lake City
// 2006 => Turin
// 2010 => Vancouver
// 2014 => Sochi
// 2018 => Pyeongchang
// 2022 => Beijing 

Плоская карта

Сопоставьте функцию на элементы потока и выравнивайте результаты.

$stream->flatMap(callable $mapper): Stream

 $ data    = [ 1 , 2 , 3 , 4 , 5 ];
$ mapper  fn ( $ item ) => ( $ item % 2 === 0 ) ? [ $ item , $ item ] : $ item ;

$ result = Stream:: of ( $ data )
    -> flatMap ( $ mapper )
    -> toArray ();
// [1, 2, 2, 3, 4, 4, 5] 

Сглаживать

Сплющите многомерный поток.

$stream->flatten(int $dimensions = 1): Stream

 $ data = [ 1 , [ 2 , 3 ], [ 4 , 5 ]];

$ result = Stream:: of ( $ data )
    -> flatten ( $ mapper )
    -> toArray ();
// [1, 2, 3, 4, 5] 

Частоты

Частотное распределение элементов потока.

$stream->frequencies(bool $strict = true): Stream

 use IterTools  Stream ;

$ grades = [ ' A ' , ' A ' , ' B ' , ' B ' , ' B ' , ' C ' ];

$ result = Stream:: of ( $ grades )
    -> frequencies ()
    -> toAssociativeArray ();

// ['A' => 2, 'B' => 3, 'C' => 1] 

Группа по

Вернуть группировку потока общим элементом данных.

$stream->groupBy(callable $groupKeyFunction, callable $itemKeyFunction = null): Stream

• $groupKeyFunction определяет ключ к групповым элементам.
• Дополнительная $itemKeyFunction допускает пользовательские индексы в каждом члене группы.

 use IterTools  Stream ;

$ input = [ 1 , - 1 , 2 , - 2 , 3 , - 3 ];

$ groups = Stream:: of ( $ input )
    -> groupBy ( fn ( $ item ) => $ item > 0 ? ' positive ' : ' negative ' );

foreach ( $ groups as $ group => $ item ) {
    // 'positive' => [1, 2, 3], 'negative' => [-1, -2, -3]
}

Бесконечный цикл

Верните потоковой велосипед через элементы потока последовательно навсегда.

$stream->infiniteCycle(): Stream

 use IterTools  Stream ;

$ input = [ 1 , 2 , 3 ];

$ result = Stream:: of ( $ input )
    -> infiniteCycle ()
    -> print ();
// 1, 2, 3, 1, 2, 3, ... 

Пересечение с

Верните поток, пересекающий поток с входными итерами.

$stream->intersectionWith(iterable ...$iterables): Stream

 use IterTools  Stream ;

$ numbers    = [ 1 , 2 , 3 , 4 , 5 , 6 , 7 , 8 , 9 ];
$ numerics   = [ ' 1 ' , ' 2 ' , 3 , 4 , 5 , 6 , 7 , ' 8 ' , ' 9 ' ];
$ oddNumbers = [ 1 , 3 , 5 , 7 , 9 , 11 ];

$ stream = Stream:: of ( $ numbers )
    -> intersectionWith ( $ numerics , $ oddNumbers )
    -> toArray ();
// 3, 5, 7 

Пересечение принудительно с

Верните поток, пересекающий поток с входными итерами, используя принуждение типа.

$stream->intersectionCoerciveWith(iterable ...$iterables): Stream

 use IterTools  Stream ;

$ languages          = [ ' php ' , ' python ' , ' c++ ' , ' java ' , ' c# ' , ' javascript ' , ' typescript ' ];
$ scriptLanguages    = [ ' php ' , ' python ' , ' javascript ' , ' typescript ' ];
$ supportsInterfaces = [ ' php ' , ' java ' , ' c# ' , ' typescript ' ];

$ stream = Stream:: of ( $ languages )
    -> intersectionCoerciveWith ( $ scriptLanguages , $ supportsInterfaces )
    -> toArray ();
// 'php', 'typescript' 

Предел

Вернуть поток до предела.

Остановка, даже если больше данных доступно, если ограничен достигнут.

$stream->limit(int $limit): Stream

 Use IterTools  Single ;

$ matrixMovies = [ ' The Matrix ' , ' The Matrix Reloaded ' , ' The Matrix Revolutions ' , ' The Matrix Resurrections ' ];
$ limit        = 1 ;

$ goodMovies = Stream:: of ( $ matrixMovies )
    -> limit ( $ limit )
    -> toArray ();
// 'The Matrix' (and nothing else) 

Карта

Верните поток, содержащий результат отображения функции на каждом элементе потока.

$stream->map(callable $function): Stream

 use IterTools  Stream ;

$ grades = [ 100 , 95 , 98 , 89 , 100 ];

$ result = Stream:: of ( $ grades )
    -> map ( fn ( $ grade ) => $ grade === 100 ? ' A ' : ' F ' )
    -> toArray ();
// A, F, F, F, A 

Пары

Верните поток, состоящий из пар элементов из потока.

$stream->pairwise(): Stream

Возвращает пустой поток, если данный сбор содержит менее 2 элементов.

 use IterTools  Stream ;

$ input = [ 1 , 2 , 3 , 4 , 5 ];

$ stream = Stream:: of ( $ input )
    -> pairwise ()
    -> toArray ();
// [1, 2], [2, 3], [3, 4], [4, 5] 

Частичное пересечение с

Верните поток, частично пересекающий поток с входными итерами.

$stream->partialIntersectionWith(int $minIntersectionCount, iterable ...$iterables): Stream

 use IterTools  Stream ;

$ numbers    = [ 1 , 2 , 3 , 4 , 5 , 6 , 7 , 8 , 9 ];
$ numerics   = [ ' 1 ' , ' 2 ' , 3 , 4 , 5 , 6 , 7 , ' 8 ' , ' 9 ' ];
$ oddNumbers = [ 1 , 3 , 5 , 7 , 9 , 11 ];

$ stream = Stream:: of ( $ numbers )
    -> partialIntersectionWith ( $ numerics , $ oddNumbers )
    -> toArray ();
// 1, 3, 4, 5, 6, 7, 9 

Частичное перекрестное принуждение с

Верните поток, частично пересекающий поток с входными итерами, используя принуждение типа.

$stream->partialIntersectionCoerciveWith(int $minIntersectionCount, iterable ...$iterables): Stream

 use IterTools  Stream ;

$ languages          = [ ' php ' , ' python ' , ' c++ ' , ' java ' , ' c# ' , ' javascript ' , ' typescript ' ];
$ scriptLanguages    = [ ' php ' , ' python ' , ' javascript ' , ' typescript ' ];
$ supportsInterfaces = [ ' php ' , ' java ' , ' c# ' , ' typescript ' ];

$ stream = Stream:: of ( $ languages )
    -> partialIntersectionCoerciveWith ( 2 , $ scriptLanguages , $ supportsInterfaces )
    -> toArray ();
// 'php', 'python', 'java', 'typescript', 'c#', 'javascript' 

Reindex

Верните новый поток элементов клавиш-значений, реиндексированных функцией индексера ключа.

$stream->reindex(callable $indexer): Stream

 use IterTools  Stream ;

$ data = [
    [
        ' title '   => ' Star Wars: Episode IV – A New Hope ' ,
        ' episode ' => ' IV ' ,
        ' year '    => 1977 ,
    ],
    [
        ' title '   => ' Star Wars: Episode V – The Empire Strikes Back ' ,
        ' episode ' => ' V ' ,
        ' year '    => 1980 ,
    ],
    [
        ' title ' => ' Star Wars: Episode VI – Return of the Jedi ' ,
        ' episode ' => ' VI ' ,
        ' year ' => 1983 ,
    ],
];
$ reindexFunc = fn ( array $ swFilm ) => $ swFilm [ ' episode ' ];

$ reindexResult = Stream:: of ( $ data )
    -> reindex ( $ reindexFunc )
    -> toAssociativeArray ();
// [
//     'IV' => [
//         'title'   => 'Star Wars: Episode IV – A New Hope',
//         'episode' => 'IV',
//         'year'    => 1977,
//     ],
//     'V' => [
//         'title'   => 'Star Wars: Episode V – The Empire Strikes Back',
//         'episode' => 'V',
//         'year'    => 1980,
//     ],
//     'VI' => [
//         'title' => 'Star Wars: Episode VI – Return of the Jedi',
//         'episode' => 'VI',
//         'year' => 1983,
//     ],
// ] 

Относительные частоты

Относительное распределение частоты элементов потока.

$stream->relativeFrequencies(bool $strict = true): Stream

 use IterTools  Stream ;

$ grades = [ ' A ' , ' A ' , ' B ' , ' B ' , ' B ' , ' C ' ];

$ result = Stream:: of ( $ grades )
    -> relativeFrequencies ()
    -> toAssociativeArray ();

// A => 0.33, B => 0.5, C => 0.166 

Обеспечить регресс

Поверните элементы потока.

$stream->reverse(): Stream

 use IterTools  Stream ;

$ words = [ ' are ' , ' you ' , ' as ' , ' bored ' , ' as ' , ' I ' , ' am ' ];

$ reversed = Stream:: of ( $ words )
    -> reverse ()
    -> toString ( ' ' );
// am I as bored as you are 

Среднее время бега

Верните поток, накопленный средний (средний) по потоку.

$stream->runningAverage(int|float|null $initialValue = null): Stream

 use IterTools  Stream ;

$ input = [ 1 , 3 , 5 ];

$ result = Stream:: of ( $ input )
    -> runningAverage ()
    -> toArray ();
// 1, 2, 3 

Разница в беге

Верните поток, накапливающий разницу в потоке.

$stream->runningDifference(int|float|null $initialValue = null): Stream

 use IterTools  Stream ;

$ input = [ 1 , 2 , 3 , 4 , 5 ];

$ result = Stream:: of ( $ input )
    -> runningDifference ()
    -> toArray ();
// -1, -3, -6, -10, -15 

Запуск макс

Верните поток, накапливающий максимальный макс.

$stream->runningMax(int|float|null $initialValue = null): Stream

 use IterTools  Stream ;

$ input = [ 1 , - 1 , 2 , - 2 , 3 , - 3 ];

$ result = Stream:: of ( $ input )
    -> runningMax ()
    -> toArray ();
// 1, 1, 2, 2, 3, 3 

Бег мин

Верните поток, накапливающий ходовой мин над потоком.

$stream->runningMin(int|float|null $initialValue = null): Stream

 use IterTools  Stream ;

$ input = [ 1 , - 1 , 2 , - 2 , 3 , - 3 ];

$ result = Stream:: of ( $ input )
    -> runningMin ()
    -> toArray ();
// 1, -1, -1, -2, -2, -3 

Работающий продукт

Верните поток, накопленный работающий продукт через поток.

$stream->runningProduct(int|float|null $initialValue = null): Stream

 use IterTools  Stream ;

$ input = [ 1 , 2 , 3 , 4 , 5 ];

$ result = Stream:: of ( $ input )
    -> runningProduct ()
    -> toArray ();
// 1, 2, 6, 24, 120 

Запуск всего

Верните поток, накапливая общее количество запуска над потоком.

$stream->runningTotal(int|float|null $initialValue = null): Stream

 use IterTools  Stream ;

$ input = [ 1 , 2 , 3 , 4 , 5 ];

$ result = Stream:: of ( $ input )
    -> runningTotal ()
    -> toArray ();
// 1, 3, 6, 10, 15 

Пропускать

Пропустите несколько элементов потока.

$stream->skip(int $count, int $offset = 0): Stream

 use IterTools  Stream ;

$ movies = [
    ' The Phantom Menace ' , ' Attack of the Clones ' , ' Revenge of the Sith ' ,
    ' A New Hope ' , ' The Empire Strikes Back ' , ' Return of the Jedi ' ,
    ' The Force Awakens ' , ' The Last Jedi ' , ' The Rise of Skywalker '
];

$ onlyTheBest = Stream:: of ( $ movies )
    -> skip ( 3 )
    -> skip ( 3 , 3 )
    -> toArray ();
// 'A New Hope', 'The Empire Strikes Back', 'Return of the Jedi' 

Среза

Извлеките кусок потока.

$stream->slice(int $start = 0, int $count = null, int $step = 1)

 use IterTools  Stream ;

$ olympics = [ 1992 , 1994 , 1996 , 1998 , 2000 , 2002 , 2004 , 2006 , 2008 , 2010 , 2012 , 2014 , 2016 , 2018 , 2020 , 2022 ];

$ summerOlympics = Stream:: of ( $ olympics )
    -> slice ( 0 , 8 , 2 )
    -> toArray ();
// [1992, 1996, 2000, 2004, 2008, 2012, 2016, 2020] 

Сортировка

Сортирует поток.

$stream->sort(callable $comparator = null)

Если компаратор не предоставлен, элементы итерабильного источника должны быть сопоставимы.

 use IterTools  Stream ;

$ input = [ 3 , 4 , 5 , 9 , 8 , 7 , 1 , 6 , 2 ];

$ result = Stream:: of ( $ input )
    -> sort ()
    -> toArray ();
// 1, 2, 3, 4, 5, 6, 7, 8, 9 

Симметричная разница с

Верните поток симметричной разницы потока и данных итераблев.

$stream->symmetricDifferenceWith(iterable ...$iterables): Stream

ПРИМЕЧАНИЕ. Если входные итерационные иеры производят дубликаты элементов, то применяются правила MultiSet.

 use IterTools  Stream ;

$ a = [ 1 , 2 , 3 , 4 , 7 ];
$ b = [ ' 1 ' , 2 , 3 , 5 , 8 ];
$ c = [ 1 , 2 , 3 , 6 , 9 ];

$ stream = Stream:: of ( $ a )
    -> symmetricDifferenceWith ( $ b , $ c )
    -> toArray ();
// '1', 4, 5, 6, 7, 8, 9 

Симметричная разница принудительно с

Верните поток симметричной разницы потока и данных итераблев, используя принуждение типа.

$stream->symmetricDifferenceCoerciveWith(iterable ...$iterables): Stream

ПРИМЕЧАНИЕ. Если входные итерационные иеры производят дубликаты элементов, то применяются правила MultiSet.

 use IterTools  Stream ;

$ a = [ 1 , 2 , 3 , 4 , 7 ];
$ b = [ ' 1 ' , 2 , 3 , 5 , 8 ];
$ c = [ 1 , 2 , 3 , 6 , 9 ];

$ stream = Stream:: of ( $ a )
    -> symmetricDifferenceCoerciveWith ( $ b , $ c )
    -> toArray ();
// 4, 5, 6, 7, 8, 9 

Возьми, пока

Держите элементы от потока до тех пор, пока предикат верен.

$stream->takeWhile(callable $predicate): Stream

Если предикат не предоставляется, используется логическое значение данных.

 use IterTools  Stream ;

$ input = [ 1 , - 1 , 2 , - 2 , 3 , - 3 ];

$ result = Stream:: of ( $ input )
    -> takeWhile ( fn ( $ value ) => abs ( $ value ) < 3 )
    -> toArray ();
// 1, -1, 2, -2 

Союз с

Верните поток, состоящий из союза потока и входных итераблев.

$stream->unionWith(iterable ...$iterables): Stream

ПРИМЕЧАНИЕ. Если входные итерационные характеристики производят дубликаты элементов, то применяются правила MultiSet Union.

 use IterTools  Stream ;

$ input = [ 1 , 2 , 3 ];

$ stream = Stream:: of ( $ input )
    -> unionWith ([ 3 , 4 , 5 , 6 ])
    -> toArray ();
// [1, 2, 3, 4, 5, 6] 

Союз принудительно с

Верните поток, состоящий из объединения потока и входных итераблев с использованием принуждения типа.

$stream->unionCoerciveWith(iterable ...$iterables): Stream

ПРИМЕЧАНИЕ. Если входные итерационные характеристики производят дубликаты элементов, то применяются правила MultiSet Union.

 use IterTools  Stream ;

$ input = [ 1 , 2 , 3 ];

$ stream = Stream:: of ( $ input )
    -> unionCoerciveWith ([ ' 3 ' , 4 , 5 , 6 ])
    -> toArray ();
// [1, 2, 3, 4, 5, 6] 

Zip с

Верните поток, состоящий из множества итерабируемых коллекций, транслируемых одновременно.

$stream->zipWith(iterable ...$iterables): Stream

Для неравномерной длины итерации останавливаются, когда самый короткий итерабильный исчерпан.

 use IterTools  Stream ;

$ input = [ 1 , 2 , 3 ];

$ stream = Stream:: of ( $ input )
    -> zipWith ([ 4 , 5 , 6 ])
    -> zipWith ([ 7 , 8 , 9 ])
    -> toArray ();
// [1, 4, 7], [2, 5, 8], [3, 6, 9] 

Zip заполнен

Верните поток, состоящий из нескольких итерабируемых коллекций, используя значение заполнителя по умолчанию, если длины не равны.

$stream->zipFilledWith(mixed $default, iterable ...$iterables): Stream

 use IterTools  Stream ;

$ input = [ 1 , 2 , 3 ];

$ stream = Stream:: of ( $ input )
    -> zipFilledWith ( ' ? ' , [ ' A ' , ' B ' ]);

foreach ( $ stream as $ zipped ) {
    // [1, A], [2, B], [3, ?]
}

Zip равен

Верните поток, состоящий из множества итерабируемых коллекций равных длин, потоковых одновременно.

$stream->zipEqualWith(iterable ...$iterables): Stream

Работает как метод Stream::zipWith() , но бросает lengthException, если длины не равны, то есть, по крайней мере, один итератор заканчивается перед другими.

 use IterTools  Stream ;

$ input = [ 1 , 2 , 3 ];

$ stream = Stream:: of ( $ input )
    -> zipEqualWith ([ 4 , 5 , 6 ])
    -> zipEqualWith ([ 7 , 8 , 9 ]);

foreach ( $ stream as $ zipped ) {
    // [1, 4, 7], [2, 5, 8], [3, 6, 9]
}

Zip дольше всего с

Верните поток, состоящий из множества итерабируемых коллекций, транслируемых одновременно.

$stream->zipLongestWith(iterable ...$iterables): Stream

• Итерация продолжается до тех пор, пока самая длинная итерабильная не исчерпана.
• Для неравномерных длины исчерпываемые иеры будут производить NULL для оставшихся итераций.

 use IterTools  Stream ;

$ input = [ 1 , 2 , 3 , 4 , 5 ];

$ stream = Stream:: of ( $ input )
    -> zipLongestWith ([ 4 , 5 , 6 ])
    -> zipLongestWith ([ 7 , 8 , 9 , 10 ]);

foreach ( $ stream as $ zipped ) {
    // [1, 4, 7], [2, 5, 8], [3, 6, 9], [4, null, 10], [null, null, 5]
}

Потоковые операции терминала

Сводные операции по трансляции потоков

Все матч

Возвращает True, если все элементы соответствуют функции предиката.

$stream->allMatch(callable $predicate): bool

 use IterTools  Summary ;

$ finalFantasyNumbers = [ 4 , 5 , 6 ];
$ isOnSuperNintendo   = fn ( $ ff ) => $ ff >= 4 && $ ff <= 6 ;

$ boolean = Stream:: of ( $ finalFantasyNumbers )
    -> allMatch ( $ isOnSuperNintendo );
// true 

Все уникальные

Возвращает правда, если все элементы уникальны.

$stream->allUnique(bool $strict = true): bool

По умолчанию строгие сравнения типа. Установите строгое значение false для сравнения принуждения типа.

 use IterTools  Summary ;

$ items = [ ' fingerprints ' , ' snowflakes ' , ' eyes ' , ' DNA ' ]

$ boolean = Stream:: of ( $ items )
    -> allUnique ();
// true 

Любой матч

Возвращает True, если какой -либо элемент соответствует функции предиката.

$stream->anyMatch(callable $predicate): bool

 use IterTools  Summary ;

$ answers          = [ ' fish ' , ' towel ' , 42 , " don't panic " ];
$ isUltimateAnswer = fn ( $ a ) => a == 42 ;

$ boolean = Stream:: of ( $ answers )
    -> anyMatch ( $ answers , $ isUltimateAnswer );
// true 

Перестановки с

Возвращает True, если все итерации являются перестановкой с потоком.

$stream->arePermutationsWith(...$iterables): bool

 use IterTools  Summary ;

$ rite = [ ' r ' , ' i ' , ' t ' , ' e ' ];
$ reit = [ ' r ' , ' e ' , ' i ' , ' t ' ];
$ tier = [ ' t ' , ' i ' , ' e ' , ' r ' ];
$ tire = [ ' t ' , ' i ' , ' r ' , ' e ' ];
$ trie = [ ' t ' , ' r ' , ' i ' , ' e ' ];

$ boolean = Stream:: of ([ ' i ' , ' t ' , ' e ' , ' r ' ])
    -> arePermutationsWith ( $ rite , $ reit , $ tier , $ tire , $ trie );
// true 

Оставляют ли перестановки с

Возвращает True, если все итерации являются перестановкой с потоком с принуждением типа.

$stream->arePermutationsCoerciveWith(...$iterables): bool

 use IterTools  Summary ;

$ set2 = [ 2.0 , ' 1 ' , 3 ];
$ set3 = [ 3 , 2 , 1 ];

$ boolean = Stream:: of ([ 1 , 2.0 , ' 3 ' ])
    -> arePermutationsCoerciveWith ( $ set2 , $ set3 );
// true 

Точно n

Возвращает True, если точно n элементы верны в соответствии с предикатом.

• ПРЕДУПРЕЖДЕНИЕ ОПЛАТА.
• Предикат по умолчанию является логическим значением каждого элемента.

$stream->exactlyN(int $n, callable $predicate = null): bool

 use IterTools  Summary ;

$ twoTruthsAndALie = [ true , true , false ];
$ n                = 2 ;

$ boolean = Stream:: of ( $ twoTruthsAndALie )-> exactlyN ( $ n );
// true 

Пусто

Возвращает True, если поток пуст, не имея элементов.

$stream->isEmpty(): bool

 use IterTools  Summary ;

$ numbers    = [ 0 , 1 , 2 , 3 , 4 , 5 ];
$ filterFunc = fn ( $ x ) => $ x > 10 ;

$ boolean = Stream::( $ numbers )
    -> filter ( $ filterFunc )
    -> isEmpty ();
// true 

Разделен

Возвращает True, если все элементы данной коллекции, которые удовлетворяют предикату, появляются перед всеми элементами, которые нет.

• Возвращает True для пустой коллекции или для коллекции с одним элементом.
• Предикат по умолчанию, если не предоставлен, является логическим значением каждого элемента данных.

$stream->isPartitioned(callable $predicate = null): bool

 use IterTools  Summary ;

$ numbers          = [ 0 , 2 , 4 , 1 , 3 , 5 ];
$ evensBeforeOdds = fn ( $ item ) => $ item % 2 === 0 ;

$ boolean = Stream::( $ numbers )
    -> isPartitioned ( $ evensBeforeOdds );
// true 

Отсортирован

Возвращает True, если итерабильный источник сортируется в порядке возрастания; в противном случае ложь.

$stream->isSorted(): bool

Элементы итерабильного источника должны быть сопоставимы.

Возвращает True, если итерабильный источник пуст или имеет только один элемент.

 use IterTools  Stream ;

$ input = [ 1 , 2 , 3 , 4 , 5 ];

$ result = Stream:: of ( $ input )
    -> isSorted ();
// true

$ input = [ 1 , 2 , 3 , 2 , 1 ];

$ result = Stream:: of ( $ input )
    -> isSorted ();
// false 

Перевернут

Возвращает True, если итерабильный источник сортируется в обратном порядке убывания; в противном случае ложь.

$stream->isReversed(): bool

Элементы итерабильного источника должны быть сопоставимы.

Возвращает True, если итерабильный источник пуст или имеет только один элемент.

 use IterTools  Stream ;

$ input = [ 5 , 4 , 3 , 2 , 1 ];

$ result = Stream:: of ( $ input )
    -> isReversed ();
// true

$ input = [ 1 , 2 , 3 , 2 , 1 ];

$ result = Stream:: of ( $ input )
    -> isReversed ();
// false 

Никто не совпадает

Возвращает true, если ни один элемент соответствует функции предиката.

$stream->noneMatch(callable $predicate): bool

 use IterTools  Summary ;

$ grades         = [ 45 , 50 , 61 , 0 ];
$ isPassingGrade = fn ( $ grade ) => $ grade >= 70 ;

$ boolean = Stream:: of ( $ grades )-> noneMatch ( $ isPassingGrade );
// true 

То же самое с

Возвращает True, если итерабильный источник и все данные коллекции одинаковы.

$stream->sameWith(iterable ...$iterables): bool

Для пустых итерационных списков возвращает True.

 use IterTools  Stream ;

$ input = [ 1 , 2 , 3 , 4 , 5 ];

$ result = Stream:: of ( $ input )
    -> sameWith ([ 1 , 2 , 3 , 4 , 5 ]);
// true

$ result = Stream:: of ( $ input )
    -> sameWith ([ 5 , 4 , 3 , 2 , 1 ]);
// false 

То же самое с

Возвращает True, если итерабильный источник и все данные коллекции имеют одинаковую длину.

$stream->sameCountWith(iterable ...$iterables): bool

Для пустых итерационных списков возвращает True.

 use IterTools  Stream ;

$ input = [ 1 , 2 , 3 , 4 , 5 ];

$ result = Stream:: of ( $ input )
    -> sameCountWith ([ 5 , 4 , 3 , 2 , 1 ]);
// true

$ result = Stream:: of ( $ input )
    -> sameCountWith ([ 1 , 2 , 3 ]);
// false 

Операции терминалов уменьшения потока

В среднем

Снижает итерабильный источник до среднего среднего значения его предметов.

$stream->toAverage(): mixed

Возвращает NULL, если итерабильный источник пуст.

 use IterTools  Stream ;

$ input = [ 2 , 4 , 6 , 8 ];

$ result = Stream:: of ( $ iterable )
    -> toAverage ();
// 5 

Считать

Уменьшает итерабильный источник до его длины.

$stream->toCount(): mixed

 use IterTools  Stream ;

$ input = [ 10 , 20 , 30 , 40 , 50 ];

$ result = Stream:: of ( $ iterable )
    -> toCount ();
// 5 

К первым

Снижает итерабильный источник до своего первого элемента.

$stream->toFirst(): mixed

Бросает LengthException , если итерабильный источник пуст.

 use IterTools  Stream ;

$ input = [ 10 , 20 , 30 ];

$ result = Stream:: of ( $ input )
    -> toFirst ();
// 10 

В первую очередь

Снижает итерабильный источник до первого и последнего элемента.

$stream->toFirstAndLast(): array{mixed, mixed}

Бросает LengthException , если итерабильный источник пуст.

 use IterTools  Stream ;

$ input = [ 10 , 20 , 30 ];

$ result = Stream:: of ( $ input )
    -> toFirstAndLast ();
// [10, 30] 

Последнее

Снижает итерабильный источник до последнего элемента.

$stream->toLast(): mixed

Бросает LengthException , если итерабильный источник пуст.

 use IterTools  Stream ;

$ input = [ 10 , 20 , 30 ];

$ result = Stream:: of ( $ input )
    -> toLast ();
// 30 

Макс

Снижает итерабильный источник до своего максимального значения.

$stream->toMax(callable $compareBy = null): mixed

• Необязательный Callable Param $compareBy должен вернуть сопоставимое значение.
• Если $compareBy не предоставлен, то предметы данной коллекции должны быть сопоставимы.
• Возвращает NULL, если коллекция пуста.

 use IterTools  Stream ;

$ input = [ 1 , - 1 , 2 , - 2 , 3 , - 3 ];

$ result = Stream:: of ( $ iterable )
    -> toMax ();
// 3 

До мин

Снижает итерабильный источник до его значения MIN.

$stream->toMin(callable $compareBy = null): mixed

• Необязательный Callable Param $compareBy должен вернуть сопоставимое значение.
• Если $compareBy не предоставлен, то предметы данной коллекции должны быть сопоставимы.
• Возвращает NULL, если коллекция пуста.

 use IterTools  Stream ;

$ input = [ 1 , - 1 , 2 , - 2 , 3 , - 3 ];

$ result = Stream:: of ( $ iterable )
    -> toMin ();
// -3 

Мин макс

Уменьшает поток до массива его верхних и нижних границ (макс и мин).

$stream->toMinMax(callable $compareBy = null): array

• Необязательный Callable Param $compareBy должен вернуть сопоставимое значение.
• Если $compareBy не предоставлен, то предметы данной коллекции должны быть сопоставимы.
• Возвращает [null, null] , если данная коллекция пуста.

 use IterTools  Stream ;

$ numbers = [ 1 , 2 , 7 , - 1 , - 2 , - 3 ];

[ $ min , $ max ] = Stream:: of ( $ numbers )
    -> toMinMax ();
// [-3, 7] 

До nth

Снижает поток до значения в n -й положении.

$stream->toNth(int $position): mixed

Возвращает NULL, если итерабильный источник пуст.

 use IterTools  Stream ;

$ lotrMovies = [ ' The Fellowship of the Ring ' , ' The Two Towers ' , ' The Return of the King ' ];

$ result = Stream:: of ( $ lotrMovies )
    -> toNth ( 2 );
// The Return of the King 

К продукту

Снижает поток до продукта его предметов.

$stream->toProduct(): mixed

Возвращает NULL, если итерабильный источник пуст.

 use IterTools  Stream ;

$ input = [ 1 , 2 , 3 , 4 , 5 ];

$ result = Stream:: of ( $ iterable )
    -> toProduct ();
// 120 

К случайному значению

Снижает поток до случайного значения внутри него.

$stream->toRandomValue(): mixed

 use IterTools  Stream ;

$ rpsHands = [ ' rock ' , ' paper ' , ' scissors ' ]

$ range = Stream:: of ( $ numbers )
    -> map ( ' strtoupper ' )
    -> toRandomValue ();
// e.g., rock 

В диапазоне

Снижает поток до его диапазона (разница между максимумом и мин).

$stream->toRange(): int|float

Возвращает 0 , если итерабильный источник пуст.

 use IterTools  Stream ;

$ grades = [ 100 , 90 , 80 , 85 , 95 ];

$ range = Stream:: of ( $ numbers )
    -> toRange ();
// 20 

К строке

Снижается до строки, соединяющей все элементы.

• Дополнительный сепаратор для вставки между элементами.
• Необязательный префикс для подготовки к строке.
• Дополнительный суффикс для добавления к строке.

$stream->toString(string $separator = '', string $prefix = '', string $suffix = ''): string

 use IterTools  Stream ;

$ words = [ ' IterTools ' , ' PHP ' , ' v1.0 ' ];

$ string = Stream:: of ( $ words )-> toString ( $ words );
// IterToolsPHPv1.0
$ string = Stream:: of ( $ words )-> toString ( $ words , ' - ' );
// IterTools-PHP-v1.0
$ string = Stream:: of ( $ words )-> toString ( $ words , ' - ' , ' Library: ' );
// Library: IterTools-PHP-v1.0
$ string = Stream:: of ( $ words )-> toString ( $ words , ' - ' , ' Library: ' , ' ! ' );
// Library: IterTools-PHP-v1.0! 

Суммировать

Снижает итерабильный источник до суммы его предметов.

$stream->toSum(): mixed

 use IterTools  Stream ;

$ input = [ 1 , 2 , 3 , 4 , 5 ];

$ result = Stream:: of ( $ iterable )
    -> toSum ();
// 15 

По цене

Уменьшает итерабильный источник, как функция array_reduce ().

Но в отличие от array_reduce() , он работает со всеми iterable типами.

$stream->toValue(callable $reducer, mixed $initialValue): mixed

 use IterTools  Stream ;

$ input = [ 1 , 2 , 3 , 4 , 5 ];

$ result = Stream:: of ( $ iterable )
    -> toValue ( fn ( $ carry , $ item ) => $ carry + $ item );
// 15 

Терминальные операции трансформации

На массив

Возвращает множество элементов потока.

$stream->toArray(): array

 use IterTools  Stream ;

$ array = Stream:: of ([ 1 , 1 , 2 , 2 , 3 , 4 , 5 ])
    -> distinct ()
    -> map ( fn ( $ x ) => $ x ** 2 )
    -> toArray ();
// [1, 4, 9, 16, 25] 

В ассоциативном массиве

Возвращает карту ключа элементов потока.

$stream->toAssociativeArray(callable $keyFunc, callable $valueFunc): array

 use IterTools  Stream ;

$ keyFunc

$ array = Stream:: of ([ ' message 1 ' , ' message 2 ' , ' message 3 ' ])
    -> map ( ' strtoupper ' )
    -> toAssociativeArray (
        fn ( $ s ) => md5 ( $ s ),
        fn ( $ s ) => $ s
    );
// [3b3f2272b3b904d342b2d0df2bf31ed4 => MESSAGE 1, 43638d919cfb8ea31979880f1a2bb146 => MESSAGE 2, ... ] 

Тройник

Вернуть несколько независимых (дублированных) потоков.

$stream->tee(int $count): array

 use IterTools  Transform ;

$ daysOfWeek = [ ' Mon ' , ' Tues ' , ' Wed ' , ' Thurs ' , ' Fri ' , ' Sat ' , ' Sun ' ];
$ count = 3 ;

[ $ week1Stream , $ week2Stream , $ week3Stream ] = Stream:: of ( $ daysOfWeek )
    -> tee ( $ count );

// Each $weekStream contains ['Mon', 'Tues', 'Wed', 'Thurs', 'Fri', 'Sat', 'Sun'] 

Операции терминалов побочного эффекта

Звоните для каждого

Выполните действие через вызов на каждом элементе в потоке.

$stream->callForEach(callable $function): void

 use IterTools  Stream ;

$ languages = [ ' PHP ' , ' Python ' , ' Java ' , ' Go ' ];
$ mascots   = [ ' elephant ' , ' snake ' , ' bean ' , ' gopher ' ];

$ zipPrinter = fn ( $ zipped ) => print ( "{ $ zipped [ 0 ]} 's mascot: { $ zipped [ 1 ]}" );

Stream:: of ( $ languages )
    -> zipWith ( $ mascots )
    -> callForEach ( $ zipPrinter );
// PHP's mascot: elephant
// Python's mascot: snake
// ... 

Печать

Отпечатает каждый элемент в потоке.

• Предметы должны быть печатными.

$stream->print(string $separator = '', string $prefix = '', string $suffix = ''): void

 use IterTools  Stream ;

$ words = [ ' IterTools ' , ' PHP ' , ' v1.0 ' ];

Stream:: of ( $ words )-> print ();                       // IterToolsPHPv1.0
Stream:: of ( $ words )-> print ( ' - ' );                    // IterTools-PHP-v1.0
Stream:: of ( $ words )-> print ( ' - ' , ' Library: ' );       // Library: IterTools-PHP-v1.0
Stream:: of ( $ words )-> print ( ' - ' , ' Library: ' , ' ! ' );  // Library: IterTools-PHP-v1.0! 

Печатная линия

Отпечатает каждый элемент в потоке на собственной линии.

• Предметы должны быть печатными.

$stream->println(): void

 use IterTools  Stream ;

$ words = [ ' IterTools ' , ' PHP ' , ' v1.0 ' ];

Stream:: of ( $ words )-> printLn ();
// IterTools
// PHP
// v1.0 

К файлу CSV

Напишите содержимое потока в файл CSV.

$stream->toCsvFile(resource $fileHandle, array $header = null, string 'separator = ',', string $enclosure = '"', string $escape = '\'): void

 use IterTools  Stream ;

$ starWarsMovies = [
    [ ' Star Wars: Episode IV – A New Hope ' , ' IV ' , 1977 ],
    [ ' Star Wars: Episode V – The Empire Strikes Back ' , ' V ' , 1980 ],
    [ ' Star Wars: Episode VI – Return of the Jedi ' , ' VI ' , 1983 ],
];
$ header = [ ' title ' , ' episode ' , ' year ' ];

Stream:: of ( $ data )
    -> toCsvFile ( $ fh , $ header );
// title,episode,year
// "Star Wars: Episode IV – A New Hope",IV,1977
// "Star Wars: Episode V – The Empire Strikes Back",V,1980
// "Star Wars: Episode VI – Return of the Jedi",VI,1983 

Подать

Напишите содержимое потока в файл.

$stream->toFile(resource $fileHandle, string $newLineSeparator = PHP_EOL, string $header = null, string $footer = null): void

 use IterTools  Stream ;

$ data = [ ' item1 ' , ' item2 ' , ' item3 ' ];
$ header = ' <ul> ' ;
$ footer = ' </ul> ' ;

Stream:: of ( $ data )
    -> map ( fn ( $ item ) => "  <li> $ item </li> " )
    -> toFile ( $ fh ,  PHP_EOL , $ header , $ footer );

// <ul>
//   <li>item1</li>
//   <li>item2</li>
//   <li>item3</li>
// </ul>

Потоковые отладочные операции

Заглядывать

Загляните в каждый элемент между другими операциями потока, чтобы выполнить какое -то действие без изменения потока.

$stream->peek(callable $callback): Stream

 use IterTools  Stream ;

$ logger = new SimpleLog  Logger ( ' /tmp/log.txt ' , ' iterTools ' );

Stream:: of ([ ' some ' , ' items ' ])
  -> map ( ' strtoupper ' )
  -> peek ( fn ( $ x ) => $ logger -> info ( $ x ))
  -> foreach ( $ someComplexCallable );

Peek Stream

Загляните во весь поток между другими операциями потока, чтобы выполнить некоторые действия, не изменяя поток.

$stream->peekStream(callable $callback): Stream

 use IterTools  Stream ;

$ logger = new SimpleLog  Logger ( ' /tmp/log.txt ' , ' iterTools ' );

Stream:: of ([ ' some ' , ' items ' ])
  -> map ( ' strtoupper ' )
  -> peekStream ( fn ( $ stream ) => $ logger -> info ( $ stream ))
  -> foreach ( $ someComplexCallable );

Peek Print

Загляните в каждый элемент между другими операциями потока, чтобы распечатать каждый элемент без изменения потока.

$stream->peekPrint(string $separator = '', string $prefix = '', string $suffix = ''): void

 use IterTools  Stream ;

Stream:: of ([ ' some ' , ' items ' ])
  -> map ( ' strtoupper ' )
  -> peekPrint ()
  -> foreach ( $ someComplexCallable );

Peek printr

Загляните в каждый элемент между другими операциями потока, чтобы print_r Каждый элемент без изменения потока.

$stream->peekPrintR(callable $callback): void

 use IterTools  Stream ;

Stream:: of ([ ' some ' , ' items ' ])
  -> map ( ' strtoupper ' )
  -> peekPrintR ()
  -> foreach ( $ someComplexCallable );

Печать

print_r Каждый элемент в потоке.

$stream->printR(): void

 use IterTools  Stream ;

$ items = [ $ string , $ array , $ object ];

Stream:: of ( $ words )-> printR ();
// print_r output 

Вар дамп

var_dump каждый элемент в потоке.

$stream->varDump(): void

 use IterTools  Stream ;

$ items = [ $ string , $ array , $ object ];

Stream:: of ( $ words )-> varDump ();
// var_dump output 

Композиция

Иртул можно объединить, чтобы создать новые итерабируемые композиции.

Струны на молнии

 use IterTools  Multi ;
use IterTools  Single ;

$ letters = ' ABCDEFGHI ' ;
$ numbers = ' 123456789 ' ;

foreach (Multi:: zip (Single:: string ( $ letters ), Single:: string ( $ numbers )) as [ $ letter , $ number ]) {
     $ battleshipMove = new BattleshipMove( $ letter , $ number )
}
// A1, B2, C3 

Цепные струны

 use IterTools  Multi ;
use IterTools  Single ;

$ letters = ' abc ' ;
$ numbers = ' 123 ' ;

foreach (Multi:: chain (Single:: string ( $ letters ), Single:: string ( $ numbers )) as $ character ) {
    print ( $ character );
}
// a, b, c, 1, 2, 3 

Строгие и принудительные типы

Когда есть вариант, по умолчанию будет выполнять строгие сравнения типа:

• Скаларс: строго сравнивается по типу
• Объекты: всегда рассматривают разные случаи как не равные друг другу
• Массивы: сравнивает сериализованные

При наличии типа принуждение (не строгих типов) доступно и включено через необязательный флаг:

• Скаларс: сравнивается по значению с помощью жонглирования типа
• Объекты: сравнивает сериализованные
• Массивы: сравнивает сериализованные

Стандарты

IterTools PHP соответствует следующим стандартам:

• PSR-1-базовый стандарт кодирования (http://www.php-fig.org/psr/psr-1/)
• PSR-4-AutoLoader (http://www.php-fig.org/psr/psr-4/)
• PSR-12-Руководство по расширенному стилю кодирования (http://www.php-fig.org/psr/psr-12/)

Лицензия

Itertools PHP лицензирован по лицензии MIT.

Подобные библиотеки на других языках

IterTools functionality is not limited to PHP and Python. Other languages have similar libraries. Familiar functionality is available when working in other languages.

• IterTools TypeScript/Javascript
• IterTools Python: The original!