iter_utils

incl

Alias for iter_utils.includes

Returns

boolean 

includes

Checks if an iterable includes a value. Uses iter_utils.count.

Returns

boolean 

alleq(iter) → boolean

Checks if all items in an iterable are equal

Returns

boolean 

append(array, ...items) → Array of T

Same as the built in Array.push

Returns

Array of T 

The resulting array

at(iter, index) → T

Gets the element at index in iter. Indices wrap around using math_utils.wrapindex. If index is a Vec, iter will be treated as a grid, or if index is a list of integers, a list of elements at those indices will be returned.

Returns

T 

chunks(iter[, size]) → Array of Array of T

Creates a list of contiguous non-overlapping chunks of iter, each of length size

[1, 2, 3, 4, 5, 6].chunks() // [[1, 2], [3, 4], [5, 6]]

[1, 2, 3, 4, 5, 6].chunks(3) // [[1, 2, 3], [4, 5, 6]]

Returns

Array of Array of T 

count(iter, value[, string_like_match]) → number

Counts the number of times value appears in iter. If value is a function, it's will do the same as .filter(f).length, if iter is a string or string_like_match is explicitly set to true, ["a", "b"] will match abcd or ["a", "b", "c", "d"] as well as something like ["arstneio", ["a", "b], 4].

[4, 2, 3, 1, 2].count(2) // 2

"abababa".count("aba") // 2

[3, 2, 1, 2, 1].count([2, 1]) // 0

[3, 2, 1, 2, 1].count([2, 1], true) // 2

Returns

number 

countol(iter, value[, string_like_match]) → number

Same as iter_utils.count but counts overlapping matches

"abababa".countol("aba") // 3

[1, 2, 1, 2, 1].countol([1, 2, 1]) // 2

Returns

number 

deltas(iter) → Array of number

Gets the differences between consecutive elements of an iterable

[1, 2, 9, -4].deltas // [1, 7, -13]

Returns

Array of number 

dropnth(iter, index) → Array of T

Removes the nth element from an iterable value

Returns

Array of T 

The resulting array

each(iter, callback) → Iterable containing T

Same as the built in Array.forEach

Returns

Iterable containing T 

The original iterable

everynth(iter, n[, start]) → Array of T

Return a list with every nth element of iter starting at index start

Returns

Array of T 

filterout(array, filter_fn) → Array of T

Same as the built in Array.filter but inverted. For consistency with builtins like Array.filter and Array.map which don't work on any iterable. This must also be called on an array.

Returns

Array of T 

first(iter) → any

Gets the first element of an iterable value

Returns

any 

firstn(iter, n) → Array of T

Gets the first n elements of an iterable value and returns them in an array

Returns

Array of T 

flat(iter) → Array of T

Deep flattens an iterable

[[1, [2]], [[[[3, [4, 5]]]]], 6].flat // [1, 2, 3, 4, 5, 6]

Returns

Array of T 

for(iter, callback) → Iterable containing T

Same as the built in Array.forEach

Returns

Iterable containing T 

The original iterable

iwhere(iter, fn) → Array of number

Returns list of indices where the function fn returns true. fn receives the value, index and the iterable as arguments, in that order.

[1, 2, 3, 4, 5].iwhere(x => x % 2 === 0) // [1, 3]

Returns

Array of number 

last(iter) → any

Gets the last element of an iterable value

Returns

any 

lastn(iter, n) → Array of T

Gets the last n elements of an iterable value and returns them in an array

Returns

Array of T 

max(iter) → number

Same as the built in Math.max but it takes an iterable as a single argument

Returns

number 

min(iter) → number

Same as the built in Math.min but it takes an iterable as a single argument

Returns

number 

nflat(iter[, depth]) → Array of T

Flattens an iterable to a certain depth. Alias for the builtin Array.flat.

Returns

Array of T 

none(array, fn) → boolean

Checks if there are no elements in array that satisfy fn. fn is passed to the built in Array.some so refer to those docs if needed.

Returns

boolean 

nsort(iter) → Array of T

Sorts an iterable (of numbers) in ascending order

Returns

Array of T 

The sorted array

perms(iter) → Array of Array of T

Generates all permutations of an iterable

Returns

Array of Array of T 

pieces(iter, n) → Array of Array of T

Splits an iterable into n pieces. Rounds up if the split is uneven.

[1, 2, 3, 4, 5, 6].pieces(3) // [[1, 2], [3, 4], [5, 6]]

[1, 2, 3].pieces(2) // [[1, 2], [3]]

Returns

Array of Array of T 

prepend(array, ...items) → Array of T

Same as the built in Array.unshift

Returns

Array of T 

The resulting array

prod(iter) → number

Calculates the product of all values in an iterable

Returns

number 

rev(iter) → Array of T

Reverses the elements of an iterable (not in place)

Returns

Array of T 

The reversed array

rsort(iter) → Array of T

Sorts an iterable (of numbers) in descending order

Returns

Array of T 

The sorted array

rsortby(iter, func) → Array of T

Sorts an iterable in descending order by the result of applying a given function to each element

Returns

Array of T 

The sorted array

seqs(iter) → Array of Array of T

Returns a list of sublists containing consecutive elements of iter

Returns

Array of Array of T 

sliding(iter, size[, wrap]) → Array of Array of T

Creates a list of sublists of length size each of which is a sliding window looking into iter starting at index 0 moving along by 1 each time. If loop is true, there will be some extra windows at the end which wrap around to the start.

[1, 2, 3, 4, 5].sliding(3) // [[1, 2, 3], [2, 3, 4], [3, 4, 5]]

[1, 2, 3].sliding(2, true) // [[1, 2], [2, 3], [3, 1]]

Returns

Array of Array of T 

sortby(iter, func) → Array of T

Sorts an iterable in ascending order by the result of applying a given function to each element

Returns

Array of T 

The sorted array

sorted(iter, compare_fn) → Array of T

Sorts an iterable given a comparison function (same as Array.sort) but not in place

Returns

Array of T 

The sorted array

sum(iter) → (number or string)

Sums the elements of an iterable value

Returns

(number or string) 

swap(array, index_a, index_b) → Array of T

Swaps the elements at indices index_a and index_b in array. Only works on arrays so that it can be done in place.

Returns

Array of T 

The resulting array

uniq(iter) → _Set

Creates a new _Set from an iterable. Same as constructors.set.

Returns

_Set 

zip(...iters) → Array of Array of T

[Global] Zips multiple iterable into a single array of arrays, each containing a single element from each iterable. The result will only be as long as the shortest input.

zip([1, 2, 3], [4, 5, 6]) // [[1, 4], [2, 5], [3, 6]]

zip([1, 2]) // [[1], [2]]

Returns

Array of Array of T