dev.marksman.enhancediterables

Interface FiniteIterable<A>

Type Parameters:

A - the element type

All Superinterfaces:

EnhancedIterable<A>, Iterable<A>

All Known Subinterfaces:

ImmutableFiniteIterable<A>, ImmutableNonEmptyFiniteIterable<A>, NonEmptyFiniteIterable<A>

public interface FiniteIterable<A>
extends EnhancedIterable<A>

An EnhancedIterable that is finite.

Method Summary

Modifier and Type	Method and Description
default NonEmptyFiniteIterable<A>	append(A element)
default FiniteIterable<A>	concat(FiniteIterable<A> other)
default <B> FiniteIterable<com.jnape.palatable.lambda.adt.hlist.Tuple2<A,B>>	cross(FiniteIterable<B> other) Returns the lazily computed cartesian product of this FiniteIterable with another FiniteIterable.
default FiniteIterable<A>	drop(int count) Returns a new FiniteIterable that drops the first count elements of this FiniteIterable.
default FiniteIterable<A>	dropWhile(com.jnape.palatable.lambda.functions.Fn1<? super A,? extends Boolean> predicate)
default FiniteIterable<A>	filter(com.jnape.palatable.lambda.functions.Fn1<? super A,? extends Boolean> predicate)
static <A> FiniteIterable<A>	finiteIterable(Collection<A> collection)
static <A> FiniteIterable<A>	finiteIterable(int maxCount, Iterable<A> iterable)
default <B> FiniteIterable<B>	fmap(com.jnape.palatable.lambda.functions.Fn1<? super A,? extends B> f)
default <B> B	foldLeft(com.jnape.palatable.lambda.functions.Fn2<? super B,? super A,? extends B> op, B z) Applies a binary operator to a start value and all elements of this FiniteIterable, going left to right.
default NonEmptyIterable<? extends FiniteIterable<A>>	inits()
default FiniteIterable<A>	intersperse(A a)
static <A> ImmutableNonEmptyFiniteIterable<A>	of(A first, A... more)
default <B,C> com.jnape.palatable.lambda.adt.hlist.Tuple2<? extends FiniteIterable<B>,? extends FiniteIterable<C>>	partition(com.jnape.palatable.lambda.functions.Fn1<? super A,? extends com.jnape.palatable.lambda.adt.coproduct.CoProduct2<B,C,?>> function) Partitions this FiniteIterable given a disjoint mapping function.
default NonEmptyFiniteIterable<A>	prepend(A element)
default FiniteIterable<A>	prependAll(A a)
default FiniteIterable<A>	reverse()
default FiniteIterable<? extends NonEmptyFiniteIterable<A>>	slide(int k) "Slide" a window of k elements across the FiniteIterable by one element at a time.
default com.jnape.palatable.lambda.adt.hlist.Tuple2<? extends FiniteIterable<A>,? extends FiniteIterable<A>>	span(com.jnape.palatable.lambda.functions.Fn1<? super A,? extends Boolean> predicate)
default NonEmptyIterable<? extends FiniteIterable<A>>	tails()
default EnhancedIterable<A>	takeWhile(com.jnape.palatable.lambda.functions.Fn1<? super A,? extends Boolean> predicate)
default <B,C> FiniteIterable<C>	zipWith(com.jnape.palatable.lambda.functions.Fn2<A,B,C> fn, Iterable<B> other)

Methods inherited from interface dev.marksman.enhancediterables.EnhancedIterable

concat, enhance, find, isEmpty, take, toArray, toCollection

Methods inherited from interface java.lang.Iterable

forEach, iterator, spliterator

Method Detail

append

default NonEmptyFiniteIterable<A> append(A element)

Specified by:

append in interface EnhancedIterable<A>

concat

default FiniteIterable<A> concat(FiniteIterable<A> other)

cross

default <B> FiniteIterable<com.jnape.palatable.lambda.adt.hlist.Tuple2<A,B>> cross(FiniteIterable<B> other)

Returns the lazily computed cartesian product of this FiniteIterable with another FiniteIterable.

Type Parameters:

B - the type of the other FiniteIterable

Parameters:

other - a FiniteIterable of any type

Returns:

a FiniteIterable<Tuple2<A, B>>

drop

default FiniteIterable<A> drop(int count)

Returns a new FiniteIterable that drops the first count elements of this FiniteIterable.

Specified by:

drop in interface EnhancedIterable<A>

Parameters:

count - the number of elements to drop from this FiniteIterable. Must be >= 0. May exceed size of this FiniteIterable, in which case, the result will be an empty FiniteIterable.

Returns:

a FiniteIterable<A>

dropWhile

default FiniteIterable<A> dropWhile(com.jnape.palatable.lambda.functions.Fn1<? super A,? extends Boolean> predicate)

Specified by:

dropWhile in interface EnhancedIterable<A>

filter

default FiniteIterable<A> filter(com.jnape.palatable.lambda.functions.Fn1<? super A,? extends Boolean> predicate)

Specified by:

filter in interface EnhancedIterable<A>

fmap

default <B> FiniteIterable<B> fmap(com.jnape.palatable.lambda.functions.Fn1<? super A,? extends B> f)

Specified by:

fmap in interface EnhancedIterable<A>

foldLeft

default <B> B foldLeft(com.jnape.palatable.lambda.functions.Fn2<? super B,? super A,? extends B> op,
                       B z)

Applies a binary operator to a start value and all elements of this FiniteIterable, going left to right.

Type Parameters:

B - the result type of the binary operator

Parameters:

z - the start value

op - the binary operator

Returns:

the result of inserting op between consecutive elements of this FiniteIterable, going left to right with the start value z on the left: op(...op(z, x_1), x_2, ..., x_n) where x,,1,,, ..., x,,n,, are the elements of this FiniteIterable Returns z if this FiniteIterable is empty.

inits

default NonEmptyIterable<? extends FiniteIterable<A>> inits()

intersperse

default FiniteIterable<A> intersperse(A a)

Specified by:

intersperse in interface EnhancedIterable<A>

partition

default <B,C> com.jnape.palatable.lambda.adt.hlist.Tuple2<? extends FiniteIterable<B>,? extends FiniteIterable<C>> partition(com.jnape.palatable.lambda.functions.Fn1<? super A,? extends com.jnape.palatable.lambda.adt.coproduct.CoProduct2<B,C,?>> function)

Partitions this FiniteIterable given a disjoint mapping function.

Specified by:

partition in interface EnhancedIterable<A>

Type Parameters:

B - The output left Iterable element type, as well as the CoProduct2 A type

C - The output right Iterable element type, as well as the CoProduct2 B type

Parameters:

function - the mapping function

Returns:

a Tuple2<FiniteIterable<B>, FiniteIterable<C>>

prepend

default NonEmptyFiniteIterable<A> prepend(A element)

Specified by:

prepend in interface EnhancedIterable<A>

prependAll

default FiniteIterable<A> prependAll(A a)

Specified by:

prependAll in interface EnhancedIterable<A>

reverse

default FiniteIterable<A> reverse()

slide

default FiniteIterable<? extends NonEmptyFiniteIterable<A>> slide(int k)

"Slide" a window of k elements across the FiniteIterable by one element at a time.

Example: FiniteIterable.of(1, 2, 3, 4, 5).slide(2); // [[1, 2], [2, 3], [3, 4], [4, 5]]

Specified by:

slide in interface EnhancedIterable<A>

Parameters:

k - the number of elements in the sliding window. Must be >= 1.

Returns:

a FiniteIterable<NonEmptyFiniteIterable<A>>

span

default com.jnape.palatable.lambda.adt.hlist.Tuple2<? extends FiniteIterable<A>,? extends FiniteIterable<A>> span(com.jnape.palatable.lambda.functions.Fn1<? super A,? extends Boolean> predicate)

Specified by:

span in interface EnhancedIterable<A>

tails

default NonEmptyIterable<? extends FiniteIterable<A>> tails()

Specified by:

tails in interface EnhancedIterable<A>

takeWhile

default EnhancedIterable<A> takeWhile(com.jnape.palatable.lambda.functions.Fn1<? super A,? extends Boolean> predicate)

Specified by:

takeWhile in interface EnhancedIterable<A>

zipWith

default <B,C> FiniteIterable<C> zipWith(com.jnape.palatable.lambda.functions.Fn2<A,B,C> fn,
                                        Iterable<B> other)

Specified by:

zipWith in interface EnhancedIterable<A>

finiteIterable

static <A> FiniteIterable<A> finiteIterable(Collection<A> collection)

finiteIterable

static <A> FiniteIterable<A> finiteIterable(int maxCount,
                                            Iterable<A> iterable)

of

@SafeVarargs
static <A> ImmutableNonEmptyFiniteIterable<A> of(A first,
                                                               A... more)

Specified by:

of in interface EnhancedIterable<A>