Ix (ixjava 1.0.0-RC5 API)

java.lang.Object
- ix.Ix<T>

Type Parameters:

T - the value type

All Implemented Interfaces:

java.lang.Iterable<T>

Direct Known Subclasses:

GroupedIx
```
public abstract class Ix<T>
extends java.lang.Object
implements java.lang.Iterable<T>
```
Base class and entry point for fluent Iterables.
All operators tolerate null elements.
The Iterables have to be run in a single-threaded manner and none of the participating operators expect or support concurrency.

Since:

1.0

Constructor Summary

Constructors
Constructor and Description

Ix()

Constructors
Constructor and Description
`Ix()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Ix<java.lang.Boolean>`	`all(IxPredicate<? super T> predicate)` Emits true if all elements of this sequence match a given predicate (including empty).
`Ix<java.lang.Boolean>`	`any(IxPredicate<? super T> predicate)` Emits true if any element of this sequence matches the given predicate, false otherwise (or for empty sequences).
`<R> R`	`as(IxFunction<? super Ix<T>,R> transformer)` Calls the given transformers with this and returns its value allowing fluent conversions to non-Ix types.
`Ix<java.lang.Double>`	`averageDouble()` Calculates the double-based average of this sequence of numbers.
`Ix<java.lang.Float>`	`averageFloat()` Calculates the float-based average of this sequence of numbers.
`Ix<java.util.List<T>>`	`buffer(int size)` Buffers the subsequent `size` elements into a sequence of non-overlapping Lists.
`Ix<java.util.List<T>>`	`buffer(int size, int skip)` Buffers the subsequent `size` elements into a sequence of potentially overlapping Lists.
`Ix<java.util.List<T>>`	`bufferSplit(IxPredicate<? super T> predicate)` Buffer until an item is encountered for which the predicate returns true, triggering a new buffer.
`Ix<java.util.List<T>>`	`bufferUntil(IxPredicate<? super T> predicate)` Buffer until an item is encountered after which the predicate returns true to start a new buffer.
`Ix<java.util.List<T>>`	`bufferWhile(IxPredicate<? super T> predicate)` Buffer while an item is encountered before which the predicate returns false to start a new buffer.
`<R> Ix<R>`	`cast(java.lang.Class<R> clazz)` Cast the elements to the specified class.
`static Ix<java.lang.Integer>`	`characters(java.lang.CharSequence cs)` Emits all characters from the given CharSequence as integer values.
`static Ix<java.lang.Integer>`	`characters(java.lang.CharSequence cs, int start, int end)` Emits a range of characters from the given CharSequence as integer values.
`protected static <U> U`	`checkedCall(java.util.concurrent.Callable<U> callable)` Calls the given callable and rethrows its exception (as RuntimeException if necessary).
`<C> Ix<C>`	`collect(IxSupplier<C> initialFactory, IxConsumer2<C,T> collector)` Collect the elements into a collection via collector action and emit that collection as a single item.
`Ix<java.lang.Object[]>`	`collectToArray()` Collects the elements of this sequence into an Object array.
`Ix<java.util.List<T>>`	`collectToList()` Collects the elements of this sequence into a List.
`<K> Ix<java.util.Map<K,T>>`	`collectToMap(IxFunction<? super T,? extends K> keySelector)` Collects the elements of this sequence into a Map where the key is determined from each element via the keySelector function; duplicates are overwritten.
`<K,V> Ix<java.util.Map<K,V>>`	`collectToMap(IxFunction<? super T,? extends K> keySelector, IxFunction<? super T,? extends V> valueSelector)` Collects the elements of this sequence into a Map where the key is determined from each element via the keySelector function and the value is derived from the same element via the valueSelector function; duplicates are overwritten.
`<K> Ix<java.util.Map<K,java.util.Collection<T>>>`	`collectToMultimap(IxFunction<? super T,? extends K> keySelector)` Collects the elements of this sequence into a multi-Map where the key is determined from each element via the keySelector function.
`<K,V> Ix<java.util.Map<K,java.util.Collection<V>>>`	`collectToMultimap(IxFunction<? super T,? extends K> keySelector, IxFunction<? super T,? extends V> valueSelector)` Collects the elements of this sequence into a multi-Map where the key is determined from each element via the keySelector function and the value is derived from the same element via the valueSelector function.
`Ix<java.util.Set<T>>`	`collectToSet()` Collects the elements of this sequence into a Set.
`<R> Ix<R>`	`compose(IxFunction<? super Ix<T>,? extends java.lang.Iterable<? extends R>> transformer)` When the iterator() of the returned Ix is called, it calls the transformer function with this Ix instance and emits the elements of the returned Iterable.
`static <T> Ix<T>`	`concat(java.lang.Iterable<? extends java.lang.Iterable<? extends T>> sources)` Concatenates the elements of Iterable sources, provided as an Iterable itself, sequentially.
`static <T> Ix<T>`	`concat(java.lang.Iterable<? extends T> source1, java.lang.Iterable<? extends T> source2)` Concatenates the elements of two Iterable sources sequentially The result's iterator() forwards the remove() calls to the current iterator.
`static <T> Ix<T>`	`concat(java.lang.Iterable<? extends T> source1, java.lang.Iterable<? extends T> source2, java.lang.Iterable<? extends T> source3)` Concatenates the elements of three Iterable sources sequentially The result's iterator() forwards the remove() calls to the current iterator.
`static <T> Ix<T>`	`concat(java.lang.Iterable<? extends T> source1, java.lang.Iterable<? extends T> source2, java.lang.Iterable<? extends T> source3, java.lang.Iterable<? extends T> source4)` Concatenates the elements of three Iterable sources sequentially The result's iterator() forwards the remove() calls to the current iterator.
`static <T> Ix<T>`	`concatArray(java.lang.Iterable<? extends T>... sources)` Concatenates the elements of Iterable sources, provided as an array, sequentially.
`<R> Ix<R>`	`concatMap(IxFunction<? super T,? extends java.lang.Iterable<? extends R>> mapper)` Maps each element from this sequence into subsequent Iterable sequences whose elements are concatenated in order.
`Ix<T>`	`concatWith(java.lang.Iterable<? extends T> other)` Emits elements of this sequence followed by the elements of the other sequence.
`Ix<java.lang.Boolean>`	`contains(java.lang.Object o)` Emits true if the sequence contains the given Object, compared via null-safe equals.
`Ix<java.lang.Integer>`	`count()` Emits the number of elements in this sequence.
`Ix<java.lang.Long>`	`countLong()` Emits the number of elements, as a long, in this sequence.
`Ix<T>`	`defaultIfEmpty(T value)` Emits the given value if this sequence is empty, streams this sequence otherwise.
`static <T> Ix<T>`	`defer(IxSupplier<? extends java.lang.Iterable<? extends T>> factory)` Defers the generation of the actual Iterable till the iterator() is called on the resulting Ix.
`Ix<T>`	`distinct()` Emits only distinct, never before seen elements (according to null-safe equals()) of this sequence.
`<K> Ix<T>`	`distinct(IxFunction<? super T,K> keySelector)` Emits only distinct, never before seen keys extracted from elements (according to null-safe equals()) of this sequence.
`Ix<T>`	`distinctUntilChanged()` Emits elements from this sequence if each element is different from the previous element (according to a null-safe equals()), dropping elements that evaluate to the same as the previous.
`<K> Ix<T>`	`distinctUntilChanged(IxFunction<? super T,K> keySelector)` Emits elements from this sequence if each element is different from the previous element (according to a null-safe equals() of the extracted key), dropping elements that evaluate to the same as the previous.
`Ix<T>`	`distinctUntilChanged(IxPredicate2<? super T,? super T> comparer)` Emits elements from this sequence if each element is different from the previous element (according to a comparer), dropping elements that evaluate to the same as the previous.
`Ix<T>`	`doOnCompleted(java.lang.Runnable action)` Calls the given action after consumption of this sequence has completed, i.e., when hasNext() of this Ix.iterator() returns false.
`Ix<T>`	`doOnNext(IxConsumer<? super T> action)` Calls the given action just before when the consumer calls next() of this Ix.iterator().
`static <T> Ix<T>`	`empty()` No elements are emitted.
`Ix<T>`	`endWith(T... values)` Emits the elements of this sequence followed by the elements of the given array of values.
`Ix<T>`	`every(int nth)` Emit every Nth item only from upstream.
`Ix<T>`	`except(java.lang.Iterable<? extends T> other)` Emits distinct elements from this and the other Iterable which are not in the other sequence (i.e., (A union B) minus (A intersection B)).
`Ix<T>`	`filter(IxPredicate<T> predicate)` Emits elements of this sequence which match the given predicate only.
`T`	`first()` Returns the first element of this sequence.
`T`	`first(T defaultValue)` Returns the first element of this sequence or the defaultValue if this sequence is empty.
`<R> Ix<R>`	`flatMap(IxFunction<? super T,? extends java.lang.Iterable<? extends R>> mapper)` Maps each element from this sequence into subsequent Iterable sequences whose elements are concatenated in order.
`void`	`foreach(IxConsumer<? super T> action)` Consumes the entire sequence and calls the given action with each value.
`void`	`foreachWhile(IxPredicate<? super T> predicate)` Consumes the entire sequence and calls the given predicate with each value; which can stop the iteration by returning false.
`static <T,R> Ix<R>`	`forloop(T seed, IxPredicate<? super T> condition, IxFunction<? super T,? extends T> next, IxFunction<? super T,? extends R> selector)` Generates a sequence of values via a generic indexed for-loop style construct; the index starts with the given seed, checked via a condition (to terminate), generated from the index via the selector and then a new index is generated via next.
`static <T> Ix<T>`	`from(java.lang.Iterable<T> source)` Wraps the given Iterable source into an Ix instance (if not already an Ix subclass).
`static <T> Ix<T>`	`fromArray(T... values)` Emits all the elements of the given array.
`static <T> Ix<T>`	`fromArrayRange(int start, int end, T... values)` Emits a range of elements from the given array.
`static <T> Ix<T>`	`generate(IxConsumer<IxEmitter<T>> nextSupplier)` Calls the given action to generate a value or terminate whenever the next() is called on the resulting Ix.iterator().
`static <T,S> Ix<T>`	`generate(IxSupplier<S> stateSupplier, IxFunction2<S,IxEmitter<T>,S> nextSupplier)` Calls the given function (with per-iterator state) to generate a value or terminate whenever the next() is called on the resulting Ix.iterator().
`static <T,S> Ix<T>`	`generate(IxSupplier<S> stateSupplier, IxFunction2<S,IxEmitter<T>,S> nextSupplier, IxConsumer<? super S> stateDisposer)` Calls the given function (with per-iterator state) to generate a value or terminate whenever the next() is called on the resulting Ix.iterator().
`<K> Ix<GroupedIx<K,T>>`	`groupBy(IxFunction<? super T,? extends K> keySelector)` Groups elements of this sequence into distinct groups keyed by the keys returned by the keySelector.
`<K,V> Ix<GroupedIx<K,V>>`	`groupBy(IxFunction<? super T,? extends K> keySelector, IxFunction<? super T,? extends V> valueSelector)` Groups mapped elements (by the valueSelector) of this sequence into distinct groups keyed by the keys returned by the keySelector.
`Ix<java.lang.Boolean>`	`hasElements()` Emits true if this sequence has elements, emits false otherwise.
`Ix<T>`	`hide()` Hides the identity of this Ix instance and prevents certain identity-based optimizations.
`Ix<T>`	`ignoreElements()` Runs through this sequence, ignoring all values until this sequence completes.
`Ix<T>`	`intersect(java.lang.Iterable<? extends T> other)` Emits distinct values of this and the other Iterables that are present in both sequences.
`<U extends java.util.Collection<? super T>> U`	`into(U collection)` Consumes the entire sequence and adds each element into the given collection that is also returned.
`Ix<java.lang.String>`	`join()` Converts elements of this sequence to String and concatenates them into a single, comma separated String.
`Ix<java.lang.String>`	`join(java.lang.CharSequence separator)` Converts elements of this sequence to String and concatenates them into a single String separated by the given character sequence.
`static <T> Ix<T>`	`just(T value)` Emits a single constant value.
`T`	`last()` Returns the last element of this sequence.
`T`	`last(T defaultValue)` Returns the last element of this sequence or the defaultValue if this sequence is empty.
`<R> Ix<R>`	`lift(IxFunction<? super java.util.Iterator<T>,? extends java.util.Iterator<R>> lifter)` Calls the given lifter function with the iterator of this sequence and emits elements of the returned Iterator.
`<R> Ix<R>`	`map(IxFunction<? super T,? extends R> mapper)` Maps each element of this sequence to some other value.
`Ix<T>`	`max()` Emits the first maximum element according to their natural order.
`Ix<T>`	`max(java.util.Comparator<? super T> comparator)` Emits the first maximum element according to the given comparator.
`Ix<java.lang.Integer>`	`maxInt()` Returns the first maximum integer value.
`Ix<java.lang.Long>`	`maxLong()` Returns the first maximum long value.
`static <T> Ix<T>`	`merge(java.lang.Iterable<? extends java.lang.Iterable<? extends T>> sources)` Concatenates the elements of Iterable sources, provided as an Iterable itself, sequentially.
`static <T> Ix<T>`	`mergeArray(java.lang.Iterable<? extends T>... sources)` Concatenates the elements of Iterable sources, provided as an array, sequentially.
`Ix<T>`	`mergeWith(java.lang.Iterable<? extends T> other)` Emits elements of this sequence followed by the elements of the other sequence.
`Ix<T>`	`min()` Emits the first minimum element according to their natural order.
`Ix<T>`	`min(java.util.Comparator<? super T> comparator)` Emits the first minimum element according to the given comparator.
`Ix<java.lang.Integer>`	`minInt()` Returns the first minimum integer value.
`Ix<java.lang.Long>`	`minLong()` Returns the first minimum long value.
`protected static int`	`nonNegative(int n, java.lang.String name)` Checks if the given value is non-negative and returns it; throws an IllegalArgumentException otherwise.
`protected static long`	`nonNegative(long n, java.lang.String name)` Checks if the given value is non-negative and returns it; throws an IllegalArgumentException otherwise.
`protected static <U> U`	`nullCheck(U value, java.lang.String message)` Checks if the value is null and if so, throws a NullPointerException with the given message.
`Ix<T>`	`orderBy()` Orders elements according to their natural order.
`Ix<T>`	`orderBy(java.util.Comparator<? super T> comparator)` Orders elements according to the comparator.
`<K extends java.lang.Comparable<? super K>> Ix<T>`	`orderBy(IxFunction<? super T,K> keySelector)` Orders elements according to the natural order of the extracted keys from these elements.
`Ix<T>`	`orderByReverse()` Orders elements according to their reverse natural order.
`Ix<T>`	`orderByReverse(java.util.Comparator<? super T> comparator)` Orders elements according to the reversed comparator.
`<K extends java.lang.Comparable<? super K>> Ix<T>`	`orderByReverse(IxFunction<? super T,K> keySelector)` Orders elements according to the reverse natural order of the extracted keys from these elements.
`static <T extends java.lang.Comparable<? super T>> Ix<T>`	`orderedMerge(java.lang.Iterable<? extends java.lang.Iterable<? extends T>> sources)` Merges self-comparable items from an Iterable sequence of Iterable sequences, picking the smallest item from all those inner Iterables until all sources complete.
`static <T> Ix<T>`	`orderedMerge(java.lang.Iterable<? extends java.lang.Iterable<? extends T>> sources, java.util.Comparator<? super T> comparator)` Merges items from an Iterable sequence of Iterable sequences, picking the smallest item (according to a custom comparator) from all those inner Iterables until all sources complete.
`static <T> Ix<T>`	`orderedMergeArray(java.util.Comparator<? super T> comparator, java.lang.Iterable<? extends T>... sources)` Merges items from an array of Iterable sequences, picking the smallest item (according to a custom comparator) from all those inner Iterables until all sources complete.
`static <T extends java.lang.Comparable<? super T>> Ix<T>`	`orderedMergeArray(java.lang.Iterable<? extends T>... sources)` Merges self-comparable items from an Iterable sequence of Iterable sequences, picking the smallest item from all those inner Iterables until all sources complete.
`protected static int`	`positive(int n, java.lang.String name)` Checks if the given value is positive and returns it; throws an IllegalArgumentException otherwise.
`void`	`print()` Prints the elements of this sequence to the console, separated by a comma+space and with a line break after roughly 80 characters.
`void`	`print(java.lang.CharSequence separator, int charsPerLine)` Prints the elements of this sequence to the console, separated by the given separator and with a line break after roughly the given charsPerLine amount.
`void`	`println()` Prints each element of this sequence into a new line on the console.
`void`	`println(java.lang.CharSequence prefix)` Prints each element of this sequence into a new line on the console, prefixed by the given character sequence.
`Ix<T>`	`publish()` Shares an underlying Iterator that is consumed only once and each created iterator() that calls next() will receive the elements; other iterator() instances may receive different or no elements at all.
`<R> Ix<R>`	`publish(IxFunction<? super Ix<T>,? extends java.lang.Iterable<? extends R>> transform)` Shares an Iterator, exposed as an Ix sequence, for the duration of the transform function called for each iterator() invocation and emits elements of the resulting iterable sequence of the function.
`static Ix<java.lang.Integer>`	`range(int start, int count)` Emits a range of incrementing integer values, starting from `start` and up to `count` times.
`Ix<T>`	`readOnly()` Prevents the downstream from calling remove() and throws an UnsupportedOperationException instead.
`Ix<T>`	`readOnly(boolean silent)` Prevents the downstream from calling remove() by optionally ignoring it or throwing an UnsupportedOperationException.
`Ix<T>`	`reduce(IxFunction2<T,T,T> reducer)` Reduces the elements of this sequence into a single value via a reducer function.
`<C> Ix<C>`	`reduce(IxSupplier<C> initialFactory, IxFunction2<C,T,C> reducer)` Given a per-iterator() initial value, reduces the elements of this sequence into a single value via a reducer function.
`Ix<T>`	`remove(IxPredicate<? super T> predicate)` Removes those elements via Iterator.remove() from this sequence that match the given predicate.
`void`	`removeAll()` Removes all elements by repeatedly calling this sequence's Iterator.remove().
`void`	`removeAll(IxPredicate<? super T> predicate)` Consumes this Iterable and removes all elements for which the predicate returns true; in other words, remove those elements of a mutable source that match the predicate.
`Ix<T>`	`repeat()` Repeats this sequence indefinitely.
`Ix<T>`	`repeat(IxBooleanSupplier stopPredicate)` Repeats this sequence if the given predicate returns true after the sequence completes in a round.
`Ix<T>`	`repeat(long times)` Repeats this sequence at most the given number of times.
`Ix<T>`	`repeat(long times, IxBooleanSupplier stopPredicate)` Repeats this sequence if the given predicate returns true after the sequence completes in a round or at most the given number of times.
`static <T> Ix<T>`	`repeatCallable(java.util.concurrent.Callable<T> callable)` Repeatedly calls the given callable indefinitely and emits the returned value.
`static <T> Ix<T>`	`repeatValue(T value)` Repeats the given value indefinitely.
`static <T> Ix<T>`	`repeatValue(T value, IxBooleanSupplier stopPredicate)` Repeats the given value until the given predicate returns true.
`static <T> Ix<T>`	`repeatValue(T value, long count)` Repeats the given value at most count times.
`static <T> Ix<T>`	`repeatValue(T value, long count, IxBooleanSupplier stopPredicate)` Repeats the given value at most count times or until the given predicate returns true.
`Ix<T>`	`replay()` Caches and replays all elements of this sequence to consumers of this' iterator().
`Ix<T>`	`replay(int size)` Caches and replays the last `size` elements of this sequence to consumers of this' iterator().
`<R> Ix<R>`	`replay(int size, IxFunction<? super Ix<T>,? extends java.lang.Iterable<? extends R>> transform)` Caches and replays the the last `size` elements of this sequence for the duration of the given transform function without consuming this sequence multiple times.
`<R> Ix<R>`	`replay(IxFunction<? super Ix<T>,? extends java.lang.Iterable<? extends R>> transform)` Caches and replays the elements of this sequence for the duration of the given transform function without consuming this sequence multiple times.
`Ix<T>`	`retain(IxPredicate<? super T> predicate)` Removes those elements via Iterator.remove() from this sequence that don't match the given predicate.
`void`	`retainAll(IxPredicate<? super T> predicate)` Consumes this Iterable and removes all elements for which the predicate returns false; in other words, retain those elements of a mutable source that match the predicate.
`Ix<T>`	`reverse()` Plays this sequence in reverse.
`void`	`run()` Iterates over this instance, dropping all values it produces.
`Ix<T>`	`scan(IxFunction2<T,T,T> scanner)` Performs a running accumulation, that is, returns intermediate elements returned by the scanner function.
`<R> Ix<R>`	`scan(IxSupplier<R> initialFactory, IxFunction2<R,T,R> scanner)` Performs a running accumulation, that is, returns intermediate elements returned by the scanner function, starting with a per-iterator initial value.
`Ix<java.lang.Boolean>`	`sequenceEqual(java.lang.Iterable<? extends T> other)` Determines if two sequences have the same elements in the same order and are the same length based on null-safe object equality.
`Ix<java.lang.Boolean>`	`sequenceEqual(java.lang.Iterable<? extends T> other, IxPredicate2<? super T,? super T> comparer)` Determines if two sequences have the same elements in the same order and are the same length based on the given comparer's boolean value.
`T`	`single()` Returns the single element of this sequence or throws a NoSuchElementException if this sequence is empty or IndexOutOfBoundsException if this sequence has more than on element
`T`	`single(T defaultValue)` Returns the single element of this sequence, defaultValue if this sequence is empty or IndexOutOfBoundsException if this sequence has more than one element
`Ix<T>`	`skip(int n)` Skips the first n elements from this sequence.
`Ix<T>`	`skipLast(int n)` Skips the last n elements from this sequence.
`Ix<T>`	`skipWhile(IxPredicate<? super T> predicate)` Skips the first elements while the given predicate returns true; once it returns false all subsequent elements are emitted.
`static Ix<java.lang.String>`	`split(java.lang.String string, java.lang.String by)` Emits a sequence of substring of a string split by the given separator.
`Ix<T>`	`startWith(T... values)` Emits elements of the given array followed by the elements of this sequence.
`void`	`subscribe()` Iterates over this instance, dropping all values it produces.
`void`	`subscribe(IxConsumer<? super T> onNext)` Iterates over this sequence and calls the given onNext action with each element.
`void`	`subscribe(IxConsumer<? super T> onNext, IxConsumer<java.lang.Throwable> onError)` Iterates over this sequence and calls the given onNext action with each element and calls the onError with any exception thrown by the iteration or the onNext action.
`void`	`subscribe(IxConsumer<? super T> onNext, IxConsumer<java.lang.Throwable> onError, java.lang.Runnable onCompleted)` Iterates over this sequence and calls the given onNext action with each element and calls the onError with any exception thrown by the iteration or the onNext action; otherwise calls the onCompleted action when the sequence completes without exception.
`Ix<java.lang.Integer>`	`sumInt()` Sums values of this sequence as integer.
`Ix<java.lang.Long>`	`sumLong()` Sums values of this sequence as long.
`Ix<T>`	`switchIfEmpty(java.lang.Iterable<? extends T> other)` Emits the elements of the other sequence if this sequence is empty.
`Ix<T>`	`take(int n)` Emits the first n elements (or less) of this sequence.
`Ix<T>`	`takeLast(int n)` Emits the last n elements (or fewer) of this sequence.
`Ix<T>`	`takeUntil(IxPredicate<? super T> stopPredicate)` Take elements from this sequence until the given predicate returns true for the current element (checked after emission of that element).
`Ix<T>`	`takeWhile(IxPredicate<? super T> predicate)` Take elements from this sequence while the given predicate returns true for the current element (checked before emission of that element).
`java.lang.Object[]`	`toArray()` Collects the elements of this sequence into an Object array.
`<U> U[]`	`toArray(U[] array)` Collects the elements of this sequence into a generic array provided.
`java.util.List<T>`	`toList()` Collects the elements of this sequence into a List.
`Ix<java.lang.Long>`	`toLong()` Maps this sequence of numbers into a sequence of longs.
`<K> java.util.Map<K,T>`	`toMap(IxFunction<? super T,? extends K> keySelector)` Collects the elements of this sequence into a Map where the key is determined from each element via the keySelector function; duplicates are overwritten.
`<K,V> java.util.Map<K,V>`	`toMap(IxFunction<? super T,? extends K> keySelector, IxFunction<? super T,? extends V> valueSelector)` Collects the elements of this sequence into a Map where the key is determined from each element via the keySelector function and the value is derived from the same element via the valueSelector function; duplicates are overwritten.
`<K> java.util.Map<K,java.util.Collection<T>>`	`toMultimap(IxFunction<? super T,? extends K> keySelector)` Collects the elements of this sequence into a multi-Map where the key is determined from each element via the keySelector function.
`<K,V> java.util.Map<K,java.util.Collection<V>>`	`toMultimap(IxFunction<? super T,? extends K> keySelector, IxFunction<? super T,? extends V> valueSelector)` Collects the elements of this sequence into a multi-Map where the key is determined from each element via the keySelector function and the value is derived from the same element via the valueSelector function.
`java.util.Set<T>`	`toSet()` Collects the elements of this sequence into a Set.
`<R> Ix<R>`	`transform(IxTransform<T,R> transformer)` Allows working with the Iterator of this sequence and emit elements in a more flexible way The result's iterator() doesn't support remove().
`Ix<T>`	`union(java.lang.Iterable<? extends T> other)` Emits a distinct set of values from both this and the other sequence.
`Ix<Ix<T>>`	`window(int size)` Emits inner Ix Iterables of non-overlapping sequences mapped from this sequence with the given maximum size each.
`Ix<Ix<T>>`	`window(int size, int skip)` Emits inner Ix Iterables of potentially overlapping sequences mapped from this sequence with the given maximum size each and started each `skip` source elements.
`static <T,R> Ix<R>`	`zip(java.lang.Iterable<? extends java.lang.Iterable<? extends T>> sources, IxFunction<? super java.lang.Object[],R> zipper)` Combines the next element from each source Iterable, provided as an Iterable itself, via a zipper function.
`static <T,R> Ix<R>`	`zip(java.lang.Iterable<? extends T>[] sources, IxFunction<? super java.lang.Object[],R> zipper)` Combines the next element from each source Iterable via a zipper function.
`static <T1,T2,T3,T4,R> Ix<R>`	`zip(java.lang.Iterable<T1> source1, java.lang.Iterable<T2> source2, java.lang.Iterable<T3> source3, java.lang.Iterable<T4> source4, IxFunction4<? super T1,? super T2,? super T3,? super T4,? extends R> zipper)` Combines the next element from each source Iterable via a zipper function.
`static <T1,T2,T3,R> Ix<R>`	`zip(java.lang.Iterable<T1> source1, java.lang.Iterable<T2> source2, java.lang.Iterable<T3> source3, IxFunction3<? super T1,? super T2,? super T3,? extends R> zipper)` Combines the next element from each source Iterable via a zipper function.
`static <T1,T2,R> Ix<R>`	`zip(java.lang.Iterable<T1> source1, java.lang.Iterable<T2> source2, IxFunction2<? super T1,? super T2,? extends R> zipper)` Combines the next element from each source Iterable via a zipper function.
`<U,R> Ix<R>`	`zipWith(java.lang.Iterable<U> other, IxFunction2<? super T,? super U,? extends R> zipper)` Combines the next element from this and the other source Iterable via a zipper function.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.lang.Iterable
forEach, iterator, spliterator

- Constructor Detail
 - Ix
```
public Ix()
```
- Method Detail
 - characters
```
public static Ix<java.lang.Integer> characters(java.lang.CharSequence cs)
```
 Emits all characters from the given CharSequence as integer values.
 The result's iterator() doesn't support remove().
 
 Parameters:
 
 cs - the source character sequence, not null
 
 Returns:
 
 the new Ix instance
 
 Throws:
 
 java.lang.NullPointerException - if cs is null
 
 Since:
 
 1.0
 - characters
```
public static Ix<java.lang.Integer> characters(java.lang.CharSequence cs,
 int start,
 int end)
```
 Emits a range of characters from the given CharSequence as integer values.
 The result's iterator() doesn't support remove().
 
 Parameters:
 
 cs - the source character sequence, not null
 
 start - the start character index, inclusive, non-negative
 
 end - the end character index, exclusive, non-negative
 
 Returns:
 
 the new Ix instance
 
 Throws:
 
 java.lang.NullPointerException - if cs is null
 
 java.lang.IndexOutOfBoundsException - if start is out of range [0, cs.length]
 
 Since:
 
 1.0
 - concat
```
public static <T> Ix<T> concat(java.lang.Iterable<? extends java.lang.Iterable<? extends T>> sources)
```
 Concatenates the elements of Iterable sources, provided as an Iterable itself, sequentially.
 The result's iterator() forwards the remove() calls to the current iterator.
 Note that merge and concat operations are the same in the Iterable world.
 
 Type Parameters:
 
 T - the common base type
 
 Parameters:
 
 sources - the Iterable sequence of source Iterables
 
 Returns:
 
 the new Ix instance
 
 Throws:
 
 java.lang.NullPointerException - if sources is null
 
 Since:
 
 1.0
 
 See Also:
 
 merge(Iterable)
 - concat
```
public static <T> Ix<T> concat(java.lang.Iterable<? extends T> source1,
 java.lang.Iterable<? extends T> source2)
```
 Concatenates the elements of two Iterable sources sequentially
 The result's iterator() forwards the remove() calls to the current iterator.
 Note that merge and concat operations are the same in the Iterable world.
 
 Type Parameters:
 
 T - the value type
 
 Parameters:
 
 source1 - the first source, not null
 
 source2 - the second source, not null
 
 Returns:
 
 the new Iterable source
 
 Throws:
 
 java.lang.NullPointerException - if any of the sources is null
 
 Since:
 
 1.0
 - concat
```
public static <T> Ix<T> concat(java.lang.Iterable<? extends T> source1,
 java.lang.Iterable<? extends T> source2,
 java.lang.Iterable<? extends T> source3)
```
 Concatenates the elements of three Iterable sources sequentially
 The result's iterator() forwards the remove() calls to the current iterator.
 Note that merge and concat operations are the same in the Iterable world.
 
 Type Parameters:
 
 T - the value type
 
 Parameters:
 
 source1 - the first source, not null
 
 source2 - the second source, not null
 
 source3 - the third source, not null
 
 Returns:
 
 the new Iterable source
 
 Throws:
 
 java.lang.NullPointerException - if any of the sources is null
 
 Since:
 
 1.0
 - concat
```
public static <T> Ix<T> concat(java.lang.Iterable<? extends T> source1,
 java.lang.Iterable<? extends T> source2,
 java.lang.Iterable<? extends T> source3,
 java.lang.Iterable<? extends T> source4)
```
 Concatenates the elements of three Iterable sources sequentially
 The result's iterator() forwards the remove() calls to the current iterator.
 Note that merge and concat operations are the same in the Iterable world.
 
 Type Parameters:
 
 T - the value type
 
 Parameters:
 
 source1 - the first source, not null
 
 source2 - the second source, not null
 
 source3 - the third source, not null
 
 source4 - the fourth source, not null
 
 Returns:
 
 the new Iterable source
 
 Throws:
 
 java.lang.NullPointerException - if any of the sources is null
 
 Since:
 
 1.0
 - concatArray
```
public static <T> Ix<T> concatArray(java.lang.Iterable<? extends T>... sources)
```
 Concatenates the elements of Iterable sources, provided as an array, sequentially.
 The result's iterator() forwards the remove() calls to the current iterator.
 Note that merge and concat operations are the same in the Iterable world.
 
 Type Parameters:
 
 T - the common base type
 
 Parameters:
 
 sources - the array of source Iterables
 
 Returns:
 
 the new Ix instance
 
 Throws:
 
 java.lang.NullPointerException - if sources is null
 
 Since:
 
 1.0
 
 See Also:
 
 mergeArray(Iterable...)
 - defer
```
public static <T> Ix<T> defer(IxSupplier<? extends java.lang.Iterable<? extends T>> factory)
```
 Defers the generation of the actual Iterable till the iterator() is called on the resulting Ix.
 The result's iterator() forwards the remove() calls to the generated Iterable's Iterator.
 
 Type Parameters:
 
 T - the value type
 
 Parameters:
 
 factory - the function that returns an Iterable when the resulting Ix.iterator() is called
 
 Returns:
 
 the new Ix source
 
 Throws:
 
 java.lang.NullPointerException - if factory is null
 
 Since:
 
 1.0
 - empty
```
public static <T> Ix<T> empty()
```
 No elements are emitted.
 The result's iterator() doesn't support remove().
 
 Type Parameters:
 
 T - the value type
 
 Returns:
 
 the new Ix instance
 
 Since:
 
 1.0
 - from
```
public static <T> Ix<T> from(java.lang.Iterable<T> source)
```
 Wraps the given Iterable source into an Ix instance (if not already an Ix subclass).
 The result's iterator() forwards the remove() calls to the source's iterator().
 
 Type Parameters:
 
 T - the value type
 
 Parameters:
 
 source - the Iterable to wrap, not null
 
 Returns:
 
 the new Ix instance
 
 Throws:
 
 java.lang.NullPointerException - if source is null
 
 Since:
 
 1.0
 - fromArray
```
public static <T> Ix<T> fromArray(T... values)
```
 Emits all the elements of the given array.
 The result's iterator() doesn't support remove().
 
 Type Parameters:
 
 T - the value type
 
 Parameters:
 
 values - the array of values, not null
 
 Returns:
 
 the new Ix instance
 
 Throws:
 
 java.lang.NullPointerException - if values is null
 
 Since:
 
 1.0
 - fromArrayRange
```
public static <T> Ix<T> fromArrayRange(int start,
 int end,
 T... values)
```
 Emits a range of elements from the given array.
 The result's iterator() doesn't support remove().
 
 Type Parameters:
 
 T - the value type
 
 Parameters:
 
 start - the staring index, inclusive, non-negative
 
 end - the end index, exclusive, non-negative
 
 values - the array of values
 
 Returns:
 
 the new Ix instance
 
 Throws:
 
 java.lang.NullPointerException - if values is null
 
 java.lang.IndexOutOfBoundsException - if either start or end are not in [0, values.length]
 
 Since:
 
 1.0
 - forloop
```
public static <T,R> Ix<R> forloop(T seed,
 IxPredicate<? super T> condition,
 IxFunction<? super T,? extends T> next,
 IxFunction<? super T,? extends R> selector)
```
 Generates a sequence of values via a generic indexed for-loop style construct; the index starts with the given seed, checked via a condition (to terminate), generated from the index via the selector and then a new index is generated via next.
 The result's iterator() doesn't support remove().
 
 Type Parameters:
 
 T - the index value type
 
 R - the result value type
 
 Parameters:
 
 seed - the initial value of the index
 
 condition - the receives the current index (before selector is called) and if it returns false, the sequence terminates
 
 next - the function that receives the current index and returns the next index
 
 selector - the function that receives the current index and returns the value to be emitted.
 
 Returns:
 
 the new Ix instance
 
 Throws:
 
 java.lang.NullPointerException - if condition, next or selector is null
 
 Since:
 
 1.0
 - generate
```
public static <T> Ix<T> generate(IxConsumer<IxEmitter<T>> nextSupplier)
```
 Calls the given action to generate a value or terminate whenever the next() is called on the resulting Ix.iterator().
 The result's iterator() doesn't support remove().
 The action may call onNext at most once to signal the next value per action invocation. The onCompleted should be called to indicate no further values will be generated (may be called with an onNext in the same action invocation). Calling onError will immediately throw the given exception (as is if it's a RuntimeException or Error; or wrapped into a RuntimeException).
 
 Type Parameters:
 
 T - the value type
 
 Parameters:
 
 nextSupplier - the action called with an IxEmitter API to receive value, not null
 
 Returns:
 
 the new Ix instance
 
 Throws:
 
 java.lang.NullPointerException - if nextSupplier is null
 
 Since:
 
 1.0
 - generate
```
public static <T,S> Ix<T> generate(IxSupplier<S> stateSupplier,
 IxFunction2<S,IxEmitter<T>,S> nextSupplier)
```
 Calls the given function (with per-iterator state) to generate a value or terminate whenever the next() is called on the resulting Ix.iterator().
 The result's iterator() doesn't support remove().
 The action may call onNext at most once to signal the next value per action invocation. The onCompleted should be called to indicate no further values will be generated (may be called with an onNext in the same action invocation). Calling onError will immediately throw the given exception (as is if it's a RuntimeException or Error; or wrapped into a RuntimeException).
 
 Type Parameters:
 
 T - the value type
 
 S - the state type supplied to and returned by the nextSupplier function
 
 Parameters:
 
 stateSupplier - the function that returns a state for each invocation of iterator()
 
 nextSupplier - the action called with an IxEmitter API to receive value, not null
 
 Returns:
 
 the new Ix instance
 
 Throws:
 
 java.lang.NullPointerException - if stateSupplier or nextSupplier is null
 
 Since:
 
 1.0
 - generate
```
public static <T,S> Ix<T> generate(IxSupplier<S> stateSupplier,
 IxFunction2<S,IxEmitter<T>,S> nextSupplier,
 IxConsumer<? super S> stateDisposer)
```
 Calls the given function (with per-iterator state) to generate a value or terminate whenever the next() is called on the resulting Ix.iterator().
 The result's iterator() doesn't support remove().
 The action may call onNext at most once to signal the next value per action invocation. The onCompleted should be called to indicate no further values will be generated (may be called with an onNext in the same action invocation). Calling onError will immediately throw the given exception (as is if it's a RuntimeException or Error; or wrapped into a RuntimeException).
 Note that since there is no direct way to cancel an Iterator, the stateDisposer is only invoked when the nextSupplier calls a terminal method.
 
 Type Parameters:
 
 T - the value type
 
 S - the state type supplied to and returned by the nextSupplier function
 
 Parameters:
 
 stateSupplier - the function that returns a state for each invocation of iterator()
 
 nextSupplier - the action called with an IxEmitter API to receive value, not null
 
 stateDisposer - the action called when the nextSupplier signals an onError or onCompleted.
 
 Returns:
 
 the new Ix instance
 
 Throws:
 
 java.lang.NullPointerException - if stateSupplier, nextSupplier or stateDisposer is null
 
 Since:
 
 1.0
 - just
```
public static <T> Ix<T> just(T value)
```
 Emits a single constant value.
 The result's iterator() doesn't support remove().
 
 Type Parameters:
 
 T - the value type
 
 Parameters:
 
 value - the constant value to emit
 
 Returns:
 
 the new Ix instance
 
 Since:
 
 1.0
 - merge
```
public static <T> Ix<T> merge(java.lang.Iterable<? extends java.lang.Iterable<? extends T>> sources)
```
 Concatenates the elements of Iterable sources, provided as an Iterable itself, sequentially.
 The result's iterator() forwards the remove() calls to the current iterator.
 Note that merge and concat operations are the same in the Iterable world.
 
 Type Parameters:
 
 T - the common base type
 
 Parameters:
 
 sources - the Iterable sequence of source Iterables
 
 Returns:
 
 the new Ix instance
 
 Throws:
 
 java.lang.NullPointerException - if sources is null
 
 Since:
 
 1.0
 
 See Also:
 
 concat(Iterable)
 - mergeArray
```
public static <T> Ix<T> mergeArray(java.lang.Iterable<? extends T>... sources)
```
 Concatenates the elements of Iterable sources, provided as an array, sequentially.
 The result's iterator() forwards the remove() calls to the current iterator.
 Note that merge and concat operations are the same in the Iterable world.
 
 Type Parameters:
 
 T - the common base type
 
 Parameters:
 
 sources - the array of source Iterables
 
 Returns:
 
 the new Ix instance
 
 Throws:
 
 java.lang.NullPointerException - if sources is null
 
 Since:
 
 1.0
 
 See Also:
 
 concatArray(Iterable...)
 - orderedMerge
```
public static <T extends java.lang.Comparable<? super T>> Ix<T> orderedMerge(java.lang.Iterable<? extends java.lang.Iterable<? extends T>> sources)
```
 Merges self-comparable items from an Iterable sequence of Iterable sequences, picking the smallest item from all those inner Iterables until all sources complete.
 
 Type Parameters:
 
 T - the value type
 
 Parameters:
 
 sources - the Iterable sequence of Iterables of self-comparable items
 
 Returns:
 
 the new Ix instance
 
 Since:
 
 1.0
 - orderedMerge
```
public static <T> Ix<T> orderedMerge(java.lang.Iterable<? extends java.lang.Iterable<? extends T>> sources,
 java.util.Comparator<? super T> comparator)
```
 Merges items from an Iterable sequence of Iterable sequences, picking the smallest item (according to a custom comparator) from all those inner Iterables until all sources complete.
 
 Type Parameters:
 
 T - the value type
 
 Parameters:
 
 sources - the Iterable sequence of Iterables
 
 comparator - the comparator to compare items and pick the one that returns negative will be picked
 
 Returns:
 
 the new Ix instance
 
 Since:
 
 1.0
 - orderedMergeArray
```
public static <T extends java.lang.Comparable<? super T>> Ix<T> orderedMergeArray(java.lang.Iterable<? extends T>... sources)
```
 Merges self-comparable items from an Iterable sequence of Iterable sequences, picking the smallest item from all those inner Iterables until all sources complete.
 
 Type Parameters:
 
 T - the value type
 
 Parameters:
 
 sources - the Iterable sequence of Iterables of self-comparable items
 
 Returns:
 
 the new Ix instance
 
 Since:
 
 1.0
 - orderedMergeArray
```
public static <T> Ix<T> orderedMergeArray(java.util.Comparator<? super T> comparator,
 java.lang.Iterable<? extends T>... sources)
```
 Merges items from an array of Iterable sequences, picking the smallest item (according to a custom comparator) from all those inner Iterables until all sources complete.
 
 Type Parameters:
 
 T - the value type
 
 Parameters:
 
 sources - the Iterable sequence of Iterables
 
 comparator - the comparator to compare items and pick the one that returns negative will be picked
 
 Returns:
 
 the new Ix instance
 
 Since:
 
 1.0
 - range
```
public static Ix<java.lang.Integer> range(int start,
 int count)
```
 Emits a range of incrementing integer values, starting from start and up to count times.
 
 Parameters:
 
 start - the starting value
 
 count - the number of integers to emit, non-negative
 
 Returns:
 
 the new Ix instance
 
 Throws:
 
 java.lang.IllegalArgumentException - if count is negative
 
 Since:
 
 1.0
 - readOnly
```
public final Ix<T> readOnly()
```
 Prevents the downstream from calling remove() and throws an UnsupportedOperationException instead.
 
 Returns:
 
 the new Ix instance
 
 Since:
 
 1.0
 
 See Also:
 
 readOnly(boolean)
 - readOnly
```
public final Ix<T> readOnly(boolean silent)
```
 Prevents the downstream from calling remove() by optionally ignoring it or throwing an UnsupportedOperationException.
 
 Parameters:
 
 silent - if true, remove() calls are ignored; if false, remove() calls throw an UnsupportedOperationException
 
 Returns:
 
 the new Ix instance
 
 Since:
 
 1.0
 - repeatCallable
```
public static <T> Ix<T> repeatCallable(java.util.concurrent.Callable<T> callable)
```
 Repeatedly calls the given callable indefinitely and emits the returned value.
 The result's iterator() doesn't support remove().
 
 Type Parameters:
 
 T - the value type
 
 Parameters:
 
 callable - the callable to call
 
 Returns:
 
 the new Ix instance
 
 Since:
 
 1.0
 - repeatValue
```
public static <T> Ix<T> repeatValue(T value)
```
 Repeats the given value indefinitely.
 The result's iterator() doesn't support remove().
 
 Type Parameters:
 
 T - the value type
 
 Parameters:
 
 value - the value to emit whenever next() is called
 
 Returns:
 
 the new Ix instance
 
 Since:
 
 1.0
 - repeatValue
```
public static <T> Ix<T> repeatValue(T value,
 long count)
```
 Repeats the given value at most count times.
 A count of zero will yield an empty sequence, a count of one will yield a sequence with only one element and so forth.
 The result's iterator() doesn't support remove().
 
 Type Parameters:
 
 T - the value type
 
 Parameters:
 
 value - the value to emit
 
 count - the number of times to emit the value, non-negative
 
 Returns:
 
 the new Ix instance
 
 Throws:
 
 java.lang.IllegalArgumentException - if count is negative
 
 Since:
 
 1.0
 - repeatValue
```
public static <T> Ix<T> repeatValue(T value,
 IxBooleanSupplier stopPredicate)
```
 Repeats the given value until the given predicate returns true.
 A count of zero will yield an empty sequence, a count of one will yield a sequence with only one element and so forth.
 The result's iterator() doesn't support remove().
 
 Type Parameters:
 
 T - the value type
 
 Parameters:
 
 value - the value to emit
 
 stopPredicate - the predicate called before any emission; returning false keeps repeating the value, returning true terminates the sequence
 
 Returns:
 
 the new Ix instance
 
 Throws:
 
 java.lang.NullPointerException - if stopPredicate is null
 
 Since:
 
 1.0
 - repeatValue
```
public static <T> Ix<T> repeatValue(T value,
 long count,
 IxBooleanSupplier stopPredicate)
```
 Repeats the given value at most count times or until the given predicate returns true.
 A count of zero will yield an empty sequence, a count of one will yield a sequence with only one element and so forth.
 The result's iterator() doesn't support remove().
 
 Type Parameters:
 
 T - the value type
 
 Parameters:
 
 value - the value to emit
 
 count - the number of times to emit the value, non-negative
 
 stopPredicate - the predicate called before any emission; returning false keeps repeating the value, returning true terminates the sequence
 
 Returns:
 
 the new Ix instance
 
 Throws:
 
 java.lang.IllegalArgumentException - if count is negative
 
 java.lang.NullPointerException - if stopPredicate is null
 
 Since:
 
 1.0
 - split
```
public static Ix<java.lang.String> split(java.lang.String string,
 java.lang.String by)
```
 Emits a sequence of substring of a string split by the given separator.
 The result's iterator() doesn't support remove().
 
 Parameters:
 
 string - the string to split, not null
 
 by - the separator to split along, not null
 
 Returns:
 
 the new Ix instance
 
 Throws:
 
 java.lang.NullPointerException - if string or by is null
 
 Since:
 
 1.0
 - zip
```
public static <T,R> Ix<R> zip(java.lang.Iterable<? extends T>[] sources,
 IxFunction<? super java.lang.Object[],R> zipper)
```
 Combines the next element from each source Iterable via a zipper function.
 If one of the source Iterables is sorter the sequence terminates eagerly.
 The result's iterator() doesn't support remove().
 
 Type Parameters:
 
 T - the common element type of the sources
 
 R - the result value type
 
 Parameters:
 
 sources - the array of Iterable sources, not null
 
 zipper - the function that takes an array of values and returns a value to be emitted, one from each source, not null
 
 Returns:
 
 the new Ix instance
 
 Throws:
 
 java.lang.NullPointerException - if sources or zipper is null
 
 Since:
 
 1.0
 - zip
```
public static <T,R> Ix<R> zip(java.lang.Iterable<? extends java.lang.Iterable<? extends T>> sources,
 IxFunction<? super java.lang.Object[],R> zipper)
```
 Combines the next element from each source Iterable, provided as an Iterable itself, via a zipper function.
 If one of the source Iterables is sorter the sequence terminates eagerly.
 The result's iterator() doesn't support remove().
 
 Type Parameters:
 
 T - the common element type of the sources
 
 R - the result value type
 
 Parameters:
 
 sources - the Iterable of Iterable sources, not null
 
 zipper - the function that takes an array of values and returns a value to be emitted, one from each source, not null
 
 Returns:
 
 the new Ix instance
 
 Throws:
 
 java.lang.NullPointerException - if sources or zipper is null
 
 Since:
 
 1.0
 - zip
```
public static <T1,T2,R> Ix<R> zip(java.lang.Iterable<T1> source1,
 java.lang.Iterable<T2> source2,
 IxFunction2<? super T1,? super T2,? extends R> zipper)
```
 Combines the next element from each source Iterable via a zipper function.
 If one of the source Iterables is sorter the sequence terminates eagerly.
 The result's iterator() doesn't support remove().
 
 Type Parameters:
 
 T1 - the first source's element type
 
 T2 - the second source's element type
 
 R - the result value type
 
 Parameters:
 
 source1 - the first source Iterable
 
 source2 - the second source Iterable
 
 zipper - the function that takes one from each source, not null
 
 Returns:
 
 the new Ix instance
 
 Throws:
 
 java.lang.NullPointerException - if any of the sources or zipper is null
 
 Since:
 
 1.0
 - zip
```
public static <T1,T2,T3,R> Ix<R> zip(java.lang.Iterable<T1> source1,
 java.lang.Iterable<T2> source2,
 java.lang.Iterable<T3> source3,
 IxFunction3<? super T1,? super T2,? super T3,? extends R> zipper)
```
 Combines the next element from each source Iterable via a zipper function.
 If one of the source Iterables is sorter the sequence terminates eagerly.
 The result's iterator() doesn't support remove().
 
 Type Parameters:
 
 T1 - the first source's element type
 
 T2 - the second source's element type
 
 T3 - the third source's element type
 
 R - the result value type
 
 Parameters:
 
 source1 - the first source Iterable
 
 source2 - the second source Iterable
 
 source3 - the third source Iterable
 
 zipper - the function that takes one from each source, not null
 
 Returns:
 
 the new Ix instance
 
 Throws:
 
 java.lang.NullPointerException - if any of the sources or zipper is null
 
 Since:
 
 1.0
 - zip
```
public static <T1,T2,T3,T4,R> Ix<R> zip(java.lang.Iterable<T1> source1,
 java.lang.Iterable<T2> source2,
 java.lang.Iterable<T3> source3,
 java.lang.Iterable<T4> source4,
 IxFunction4<? super T1,? super T2,? super T3,? super T4,? extends R> zipper)
```
 Combines the next element from each source Iterable via a zipper function.
 If one of the source Iterables is sorter the sequence terminates eagerly.
 The result's iterator() doesn't support remove().
 
 Type Parameters:
 
 T1 - the first source's element type
 
 T2 - the second source's element type
 
 T3 - the third source's element type
 
 T4 - the fourth source's element type
 
 R - the result value type
 
 Parameters:
 
 source1 - the first source Iterable
 
 source2 - the second source Iterable
 
 source3 - the third source Iterable
 
 source4 - the fourth source Iterable
 
 zipper - the function that takes one from each source, not null
 
 Returns:
 
 the new Ix instance
 
 Throws:
 
 java.lang.NullPointerException - if any of the sources or zipper is null
 
 Since:
 
 1.0
 - all
```
public final Ix<java.lang.Boolean> all(IxPredicate<? super T> predicate)
```
 Emits true if all elements of this sequence match a given predicate (including empty).
 The result's iterator() doesn't support remove().
 
 Parameters:
 
 predicate - the predicate receiving each element
 
 Returns:
 
 the new Ix instance
 
 Throws:
 
 java.lang.NullPointerException - if predicate is null
 
 Since:
 
 1.0
 - any
```
public final Ix<java.lang.Boolean> any(IxPredicate<? super T> predicate)
```
 Emits true if any element of this sequence matches the given predicate, false otherwise (or for empty sequences).
 The result's iterator() doesn't support remove().
 
 Parameters:
 
 predicate - the predicate receiving each element
 
 Returns:
 
 the new Ix instance
 
 Throws:
 
 java.lang.NullPointerException - if predicate is null
 
 Since:
 
 1.0
 - as
```
public final <R> R as(IxFunction<? super Ix<T>,R> transformer)
```
 Calls the given transformers with this and returns its value allowing fluent conversions to non-Ix types.
 
 Type Parameters:
 
 R - the result type
 
 Parameters:
 
 transformer - the function receiving this Ix instance and returns a value
 
 Returns:
 
 the value returned by the transformer function
 
 Throws:
 
 java.lang.NullPointerException - if transformer is null
 
 Since:
 
 1.0
 - averageFloat
```
public final Ix<java.lang.Float> averageFloat()
```
 Calculates the float-based average of this sequence of numbers.
 The returned sequence is empty if this sequence is empty.
 This operator force-casts this sequence which may lead to ClassCastException if any of this sequence's elements is not a subclass of Number.
 The result's iterator() doesn't support remove().
 
 Returns:
 
 the new Ix instance
 
 Since:
 
 1.0
 - averageDouble
```
public final Ix<java.lang.Double> averageDouble()
```
 Calculates the double-based average of this sequence of numbers.
 The returned sequence is empty if this sequence is empty.
 This operator force-casts this sequence which may lead to ClassCastException if any of this sequence's elements is not a subclass of Number.
 The result's iterator() doesn't support remove().
 
 Returns:
 
 the new Ix instance
 
 Since:
 
 1.0
 - buffer
```
public final Ix<java.util.List<T>> buffer(int size)
```
 Buffers the subsequent size elements into a sequence of non-overlapping Lists.
 The result's iterator() doesn't support remove().
 
 Parameters:
 
 size - the number of elements to group together, positive
 
 Returns:
 
 the new Ix instance
 
 Throws:
 
 java.lang.IllegalArgumentException - if size is non-positive
 
 Since:
 
 1.0
 - buffer
```
public final Ix<java.util.List<T>> buffer(int size,
 int skip)
```
 Buffers the subsequent size elements into a sequence of potentially overlapping Lists.
 The result's iterator() doesn't support remove().
 
 Parameters:
 
 size - the number of elements to group together, positive
 
 skip - specifies how often to start a new list
 
 Returns:
 
 the new Ix instance
 
 Throws:
 
 java.lang.IllegalArgumentException - if size or skip is non-positive
 
 Since:
 
 1.0
 - bufferSplit
```
public final Ix<java.util.List<T>> bufferSplit(IxPredicate<? super T> predicate)
```
 Buffer until an item is encountered for which the predicate returns true, triggering a new buffer.
 Neither the previous nor the next buffer will contain the item that caused the split
 
 Parameters:
 
 predicate - the predicate called with each item and should return false to trigger a new buffer
 
 Returns:
 
 the new Ix instance
 
 Since:
 
 1.0
 
 See Also:
 
 bufferUntil(IxPredicate), bufferWhile(IxPredicate)
 - bufferUntil
```
public final Ix<java.util.List<T>> bufferUntil(IxPredicate<? super T> predicate)
```
 Buffer until an item is encountered after which the predicate returns true to start a new buffer.
 The item will be part of the previous buffer.
 
 Parameters:
 
 predicate - the predicate called with each item after the item has been added to the current buffer and should return true to start a new buffer
 
 Returns:
 
 the new Ix instance
 
 Since:
 
 1.0
 
 See Also:
 
 bufferSplit(IxPredicate), bufferWhile(IxPredicate)
 - bufferWhile
```
public final Ix<java.util.List<T>> bufferWhile(IxPredicate<? super T> predicate)
```
 Buffer while an item is encountered before which the predicate returns false to start a new buffer.
 The item will be part of the next buffer
 
 Parameters:
 
 predicate - the predicate called with each item after the item has been added to the current buffer and should return true to start a new buffer
 
 Returns:
 
 the new Ix instance
 
 Since:
 
 1.0
 
 See Also:
 
 bufferSplit(IxPredicate), bufferUntil(IxPredicate)
 - cast
```
public final <R> Ix<R> cast(java.lang.Class<R> clazz)
```
 Cast the elements to the specified class.
 Note that this is a forced cast on this Ix instance and if not compatible, a ClassCastException might be thrown downstream.
 
 Type Parameters:
 
 R - the target type
 
 Parameters:
 
 clazz - the type token to capture the target type
 
 Returns:
 
 the new Ix instance
 
 Since:
 
 1.0
 - collect
```
public final <C> Ix<C> collect(IxSupplier<C> initialFactory,
 IxConsumer2<C,T> collector)
```
 Collect the elements into a collection via collector action and emit that collection as a single item.
 The result's iterator() doesn't support remove().
 
 Type Parameters:
 
 C - the collection type
 
 Parameters:
 
 initialFactory - the function returning a collection for each iterator() call
 
 collector - the action called with the collection and the current item
 
 Returns:
 
 the new Ix instance
 
 Throws:
 
 java.lang.NullPointerException - if initialFactory or collector is null
 
 Since:
 
 1.0
 - collectToArray
```
public final Ix<java.lang.Object[]> collectToArray()
```
 Collects the elements of this sequence into an Object array.
 The result's iterator() doesn't support remove().
 
 Returns:
 
 the new Ix instance
 
 Since:
 
 1.0
 - collectToList
```
public final Ix<java.util.List<T>> collectToList()
```
 Collects the elements of this sequence into a List.
 The result's iterator() doesn't support remove().
 
 Returns:
 
 the new Ix instance
 
 Since:
 
 1.0
 - collectToMap
```
public final <K> Ix<java.util.Map<K,T>> collectToMap(IxFunction<? super T,? extends K> keySelector)
```
 Collects the elements of this sequence into a Map where the key is determined from each element via the keySelector function; duplicates are overwritten.
 The result's iterator() doesn't support remove().
 
 Type Parameters:
 
 K - the key type
 
 Parameters:
 
 keySelector - the function that receives the current element and returns a key for it to be used as the Map key.
 
 Returns:
 
 the new Ix instance
 
 Throws:
 
 java.lang.NullPointerException - if keySelector is null
 
 Since:
 
 1.0
 - collectToMap
```
public final <K,V> Ix<java.util.Map<K,V>> collectToMap(IxFunction<? super T,? extends K> keySelector,
 IxFunction<? super T,? extends V> valueSelector)
```
 Collects the elements of this sequence into a Map where the key is determined from each element via the keySelector function and the value is derived from the same element via the valueSelector function; duplicates are overwritten.
 The result's iterator() doesn't support remove().
 
 Type Parameters:
 
 K - the key type
 
 V - the value type
 
 Parameters:
 
 keySelector - the function that receives the current element and returns a key for it to be used as the Map key.
 
 valueSelector - the function that receives the current element and returns a value for it to be used as the Map value
 
 Returns:
 
 the new Ix instance
 
 Throws:
 
 java.lang.NullPointerException - if keySelector or valueSelector is null
 
 Since:
 
 1.0
 - collectToMultimap
```
public final <K> Ix<java.util.Map<K,java.util.Collection<T>>> collectToMultimap(IxFunction<? super T,? extends K> keySelector)
```
 Collects the elements of this sequence into a multi-Map where the key is determined from each element via the keySelector function.
 The result's iterator() doesn't support remove().
 
 Type Parameters:
 
 K - the key type
 
 Parameters:
 
 keySelector - the function that receives the current element and returns a key for it to be used as the Map key.
 
 Returns:
 
 the new Ix instance
 
 Throws:
 
 java.lang.NullPointerException - if keySelector is null
 
 Since:
 
 1.0
 - collectToMultimap
```
public final <K,V> Ix<java.util.Map<K,java.util.Collection<V>>> collectToMultimap(IxFunction<? super T,? extends K> keySelector,
 IxFunction<? super T,? extends V> valueSelector)
```
 Collects the elements of this sequence into a multi-Map where the key is determined from each element via the keySelector function and the value is derived from the same element via the valueSelector function.
 The result's iterator() doesn't support remove().
 
 Type Parameters:
 
 K - the key type
 
 V - the value type
 
 Parameters:
 
 keySelector - the function that receives the current element and returns a key for it to be used as the Map key.
 
 valueSelector - the function that receives the current element and returns a value for it to be used as the Map value
 
 Returns:
 
 the new Ix instance
 
 Throws:
 
 java.lang.NullPointerException - if keySelector or valueSelector is null
 
 Since:
 
 1.0
 - collectToSet
```
public final Ix<java.util.Set<T>> collectToSet()
```
 Collects the elements of this sequence into a Set.
 The result's iterator() doesn't support remove().
 
 Returns:
 
 the new Ix instance
 
 Since:
 
 1.0
 - compose
```
public final <R> Ix<R> compose(IxFunction<? super Ix<T>,? extends java.lang.Iterable<? extends R>> transformer)
```
 When the iterator() of the returned Ix is called, it calls the transformer function with this Ix instance and emits the elements of the returned Iterable.
 The result's iterator() forwards the call remove() to the returned Iterable's Iterator.
 
 Type Parameters:
 
 R - the result value type
 
 Parameters:
 
 transformer - the transformer called with this Ix when Ix.iterator() is invoked
 
 Returns:
 
 the new Ix instance
 
 Throws:
 
 java.lang.NullPointerException - if transformer is null
 
 Since:
 
 1.0
 - concatMap
```
public final <R> Ix<R> concatMap(IxFunction<? super T,? extends java.lang.Iterable<? extends R>> mapper)
```
 Maps each element from this sequence into subsequent Iterable sequences whose elements are concatenated in order.
 Note that flatMap and concatMap operations are the same in the Iterable world.
 The result's iterator() forwards the call remove() to the current inner Iterator.
 
 Type Parameters:
 
 R - the result value type
 
 Parameters:
 
 mapper - the function
 
 Returns:
 
 the new Ix instance
 
 Throws:
 
 java.lang.NullPointerException - if mapper is null
 
 Since:
 
 1.0
 
 See Also:
 
 flatMap(IxFunction)
 - concatWith
```
public final Ix<T> concatWith(java.lang.Iterable<? extends T> other)
```
 Emits elements of this sequence followed by the elements of the other sequence.
 Note that mergeWith and concatWith operations are the same in the Iterable world.
 The result's iterator() forwards the call remove() to the current Iterator.
 
 Parameters:
 
 other - the other sequence to emits elements of
 
 Returns:
 
 the new Ix instance
 
 Throws:
 
 java.lang.NullPointerException - if other is null
 
 Since:
 
 1.0
 
 See Also:
 
 mergeWith(Iterable)
 - contains
```
public final Ix<java.lang.Boolean> contains(java.lang.Object o)
```
 Emits true if the sequence contains the given Object, compared via null-safe equals.
 The result's iterator() doesn't support remove().
 
 Parameters:
 
 o - the value to find
 
 Returns:
 
 the new Ix instance
 
 Since:
 
 1.0
 - count
```
public final Ix<java.lang.Integer> count()
```
 Emits the number of elements in this sequence.
 The result's iterator() doesn't support remove().
 
 Returns:
 
 the number of elements in this sequence
 
 Since:
 
 1.0
 - countLong
```
public final Ix<java.lang.Long> countLong()
```
 Emits the number of elements, as a long, in this sequence.
 The result's iterator() doesn't support remove().
 
 Returns:
 
 the number of elements in this sequence
 
 Since:
 
 1.0
 - defaultIfEmpty
```
public final Ix<T> defaultIfEmpty(T value)
```
 Emits the given value if this sequence is empty, streams this sequence otherwise.
 The result's iterator() doesn't support remove().
 
 Parameters:
 
 value - the value to emit if this sequence is empty
 
 Returns:
 
 the new Ix instance
 
 Since:
 
 1.0
 - distinct
```
public final Ix<T> distinct()
```
 Emits only distinct, never before seen elements (according to null-safe equals()) of this sequence.
 Note that this operator uses a memory of seen elements which may grow unbounded with long sequences.
 The result's iterator() doesn't support remove().
 
 Returns:
 
 the new Ix instance
 
 Since:
 
 1.0
 - distinct
```
public final <K> Ix<T> distinct(IxFunction<? super T,K> keySelector)
```
 Emits only distinct, never before seen keys extracted from elements (according to null-safe equals()) of this sequence.
 Note that this operator uses a memory of seen elements which may grow unbounded with long sequences.
 The result's iterator() doesn't support remove().
 
 Type Parameters:
 
 K - the key type
 
 Parameters:
 
 keySelector - the function taking the current element and returning a key object that will be compared with null-safe equals().
 
 Returns:
 
 the new Ix instance
 
 Throws:
 
 java.lang.NullPointerException - if keySelector is null
 
 Since:
 
 1.0
 - distinctUntilChanged
```
public final Ix<T> distinctUntilChanged()
```
 Emits elements from this sequence if each element is different from the previous element (according to a null-safe equals()), dropping elements that evaluate to the same as the previous.
 The result's iterator() doesn't support remove().
 
 Returns:
 
 the new Ix instance
 
 Since:
 
 1.0
 - distinctUntilChanged
```
public final Ix<T> distinctUntilChanged(IxPredicate2<? super T,? super T> comparer)
```
 Emits elements from this sequence if each element is different from the previous element (according to a comparer), dropping elements that evaluate to the same as the previous.
 The result's iterator() doesn't support remove().
 
 Parameters:
 
 comparer - the predicate receiving the previous element and the current element and returns true if they are the same (thus ignoring the latter).
 
 Returns:
 
 the new Ix instance
 
 Throws:
 
 java.lang.NullPointerException - if comparer is null
 
 Since:
 
 1.0
 - distinctUntilChanged
```
public final <K> Ix<T> distinctUntilChanged(IxFunction<? super T,K> keySelector)
```
 Emits elements from this sequence if each element is different from the previous element (according to a null-safe equals() of the extracted key), dropping elements that evaluate to the same as the previous.
 The result's iterator() doesn't support remove().
 
 Type Parameters:
 
 K - the key type
 
 Parameters:
 
 keySelector - the function that receives the current element and returns a key that will be compared via null-safe equals with the previous element's key
 
 Returns:
 
 the new Ix instance
 
 Throws:
 
 java.lang.NullPointerException - if comparer is null
 
 Since:
 
 1.0
 - doOnNext
```
public final Ix<T> doOnNext(IxConsumer<? super T> action)
```
 Calls the given action just before when the consumer calls next() of this Ix.iterator().
 The result's iterator() forwards calls to remove() to this Iterator.
 
 Parameters:
 
 action - the action to call for each item
 
 Returns:
 
 the new Ix instance
 
 Throws:
 
 java.lang.NullPointerException - if action is null
 
 Since:
 
 1.0
 - doOnCompleted
```
public final Ix<T> doOnCompleted(java.lang.Runnable action)
```
 Calls the given action after consumption of this sequence has completed, i.e., when hasNext() of this Ix.iterator() returns false.
 The result's iterator() forwards calls to remove() to this' Iterator.
 
 Parameters:
 
 action - the action to call after the source sequence completes
 
 Returns:
 
 the new Ix instance
 
 Throws:
 
 java.lang.NullPointerException - if action is null
 
 Since:
 
 1.0
 - endWith
```
public final Ix<T> endWith(T... values)
```
 Emits the elements of this sequence followed by the elements of the given array of values.
 The result's iterator() doesn't support remove().
 
 Parameters:
 
 values - the elements to emit after this sequence
 
 Returns:
 
 the new Ix instance
 
 Throws:
 
 java.lang.NullPointerException - if values is null
 
 Since:
 
 1.0
 - every
```
public final Ix<T> every(int nth)
```
 Emit every Nth item only from upstream.
 Example: Ix.range(1, 5).every(2) will yield {2, 4}.
 
 Parameters:
 
 nth - how many items to skip + 1
 
 Returns:
 
 the new Ix instance
 
 Since:
 
 1.0
 - except
```
public final Ix<T> except(java.lang.Iterable<? extends T> other)
```
 Emits distinct elements from this and the other Iterable which are not in the other sequence (i.e., (A union B) minus (A intersection B)).
 The result's iterator() doesn't support remove().
 
 Parameters:
 
 other - the other Iterable sequence, not null
 
 Returns:
 
 the new Ix instance
 
 Throws:
 
 java.lang.NullPointerException - if other is null
 
 Since:
 
 1.0
 
 See Also:
 
 union(Iterable), intersect(Iterable)
 - filter
```
public final Ix<T> filter(IxPredicate<T> predicate)
```
 Emits elements of this sequence which match the given predicate only.
 The result's iterator() forwards the call to remove() to this' Iterator.
 
 Parameters:
 
 predicate - the predicate receiving the current element and if it returns true, the value is emitted, ignored otherwise.
 
 Returns:
 
 the new Ix instance
 
 Throws:
 
 java.lang.NullPointerException - if predicate is null
 
 Since:
 
 1.0
 - flatMap
```
public final <R> Ix<R> flatMap(IxFunction<? super T,? extends java.lang.Iterable<? extends R>> mapper)
```
 Maps each element from this sequence into subsequent Iterable sequences whose elements are concatenated in order.
 Note that flatMap and concatMap operations are the same in the Iterable world.
 The result's iterator() forwards the call remove() to the current inner Iterator.
 
 Type Parameters:
 
 R - the result value type
 
 Parameters:
 
 mapper - the function
 
 Returns:
 
 the new Ix instance
 
 Throws:
 
 java.lang.NullPointerException - if mapper is null
 
 Since:
 
 1.0
 
 See Also:
 
 concatMap(IxFunction)
 - groupBy
```
public final <K> Ix<GroupedIx<K,T>> groupBy(IxFunction<? super T,? extends K> keySelector)
```
 Groups elements of this sequence into distinct groups keyed by the keys returned by the keySelector.
 The operator doesn't lose data and calling hasNext/next on either the returned Ix or on the inner GroupedIx can move the source sequence forward.
 The result's iterator() and the inner groups' Iterators don't support remove().
 
 Type Parameters:
 
 K - the key type
 
 Parameters:
 
 keySelector - the function receiving the current element and returns the key to be used for grouping the values into the same inner GroupedIx.
 
 Returns:
 
 the new Ix instance
 
 Throws:
 
 java.lang.NullPointerException - if keySelector is null
 
 Since:
 
 1.0
 
 See Also:
 
 groupBy(IxFunction, IxFunction)
 - groupBy
```
public final <K,V> Ix<GroupedIx<K,V>> groupBy(IxFunction<? super T,? extends K> keySelector,
 IxFunction<? super T,? extends V> valueSelector)
```
 Groups mapped elements (by the valueSelector) of this sequence into distinct groups keyed by the keys returned by the keySelector.
 The operator doesn't lose data and calling hasNext/next on either the returned Ix or on the inner GroupedIx can move the source sequence forward.
 The result's iterator() and the inner groups' Iterators don't support remove().
 
 Type Parameters:
 
 K - the key type
 
 V - the value type
 
 Parameters:
 
 keySelector - the function receiving the current element and returns the key to be used for grouping the values into the same inner GroupedIx.
 
 valueSelector - the function receiving the current element and returns the value to be emitted by the appropriate group
 
 Returns:
 
 the new Ix instance
 
 Throws:
 
 java.lang.NullPointerException - if keySelector or valueSelector is null
 
 Since:
 
 1.0
 
 See Also:
 
 groupBy(IxFunction, IxFunction)
 - hasElements
```
public final Ix<java.lang.Boolean> hasElements()
```
 Emits true if this sequence has elements, emits false otherwise.
 The result's iterator() doesn't support remove().
 
 Returns:
 
 the new Ix instance
 
 Since:
 
 1.0
 - hide
```
public final Ix<T> hide()
```
 Hides the identity of this Ix instance and prevents certain identity-based optimizations.
 The result's iterator() forwards the remove() calls to this' Iterator.
 
 Returns:
 
 the new Ix instance
 
 Since:
 
 1.0
 - intersect
```
public final Ix<T> intersect(java.lang.Iterable<? extends T> other)
```
 Emits distinct values of this and the other Iterables that are present in both sequences.
 The result's iterator() doesn't support remove().
 
 Parameters:
 
 other - the other Iterable sequence
 
 Returns:
 
 the new Ix instance
 
 Throws:
 
 java.lang.NullPointerException - if other is null
 
 Since:
 
 1.0
 
 See Also:
 
 except(Iterable), union(Iterable)
 - ignoreElements
```
public final Ix<T> ignoreElements()
```
 Runs through this sequence, ignoring all values until this sequence completes.
 The result's iterator() doesn't support remove().
 
 Returns:
 
 the new Ix instance
 
 Since:
 
 1.0
 - join
```
public final Ix<java.lang.String> join()
```
 Converts elements of this sequence to String and concatenates them into a single, comma separated String.
 The result's iterator() doesn't support remove().
 
 Returns:
 
 the new Ix instance
 
 Since:
 
 1.0
 - join
```
public final Ix<java.lang.String> join(java.lang.CharSequence separator)
```
 Converts elements of this sequence to String and concatenates them into a single String separated by the given character sequence.
 The result's iterator() doesn't support remove().
 
 Parameters:
 
 separator - the character sequence separating elements
 
 Returns:
 
 the new Ix instance
 
 Since:
 
 1.0
 - lift
```
public final <R> Ix<R> lift(IxFunction<? super java.util.Iterator<T>,? extends java.util.Iterator<R>> lifter)
```
 Calls the given lifter function with the iterator of this sequence and emits elements of the returned Iterator.
 The result's iterator() forwards the remove() calls to the returned Iterator.
 
 Type Parameters:
 
 R - the result value type
 
 Parameters:
 
 lifter - the function that receives the Iterator of this and returns an Iterator that will be consumed further on
 
 Returns:
 
 the new Ix instance
 
 Throws:
 
 java.lang.NullPointerException - if lifter is null
 
 Since:
 
 1.0
 - map
```
public final <R> Ix<R> map(IxFunction<? super T,? extends R> mapper)
```
 Maps each element of this sequence to some other value.
 The result's iterator() forwards the remove() calls to this' Iterator.
 
 Type Parameters:
 
 R - the result value type
 
 Parameters:
 
 mapper - the function that receives an element from this sequence and returns another value for it to be emitted.
 
 Returns:
 
 the new Ix instance
 
 Throws:
 
 java.lang.NullPointerException - if mapper is null
 
 Since:
 
 1.0
 - max
```
public final Ix<T> max(java.util.Comparator<? super T> comparator)
```
 Emits the first maximum element according to the given comparator.
 The result's iterator() doesn't support remove().
 
 Parameters:
 
 comparator - the comparator called with the latest maximum element and the current element; if it returns a positive value, the current element becomes the maximum element.
 
 Returns:
 
 the new Ix instance
 
 Throws:
 
 java.lang.NullPointerException - if comparator is null
 
 Since:
 
 1.0
 
 See Also:
 
 min(Comparator)
 - max
```
public final Ix<T> max()
```
 Emits the first maximum element according to their natural order.
 The sequence may throw a ClassCastException if any of the elements is not self-comparable (i.e., doesn't implement the Comparable interface).
 The result's iterator() doesn't support remove().
 
 Returns:
 
 the new Ix instance
 
 Since:
 
 1.0
 
 See Also:
 
 min()
 - maxInt
```
public final Ix<java.lang.Integer> maxInt()
```
 Returns the first maximum integer value.
 The sequence may throw a ClassCastException if any of the elements is not an Integer object.
 The result's iterator() doesn't support remove().
 
 Returns:
 
 the new Ix instance
 
 Since:
 
 1.0
 - maxLong
```
public final Ix<java.lang.Long> maxLong()
```
 Returns the first maximum long value.
 The sequence may throw a ClassCastException if any of the elements is not a Long object.
 The result's iterator() doesn't support remove().
 
 Returns:
 
 the new Ix instance
 
 Since:
 
 1.0
 - mergeWith
```
public final Ix<T> mergeWith(java.lang.Iterable<? extends T> other)
```
 Emits elements of this sequence followed by the elements of the other sequence.
 Note that mergeWith and concatWith operations are the same in the Iterable world.
 The result's iterator() forwards the call remove() to the current Iterator.
 
 Parameters:
 
 other - the other sequence to emits elements of
 
 Returns:
 
 the new Ix instance
 
 Throws:
 
 java.lang.NullPointerException - if other is null
 
 Since:
 
 1.0
 
 See Also:
 
 concatWith(Iterable)
 - min
```
public final Ix<T> min(java.util.Comparator<? super T> comparator)
```
 Emits the first minimum element according to the given comparator.
 The result's iterator() doesn't support remove().
 
 Parameters:
 
 comparator - the comparator called with the latest minimum element and the current element; if it returns a negative value, the current element becomes the minimum element.
 
 Returns:
 
 the new Ix instance
 
 Throws:
 
 java.lang.NullPointerException - if comparator is null
 
 Since:
 
 1.0
 
 See Also:
 
 max(Comparator)
 - min
```
public final Ix<T> min()
```
 Emits the first minimum element according to their natural order.
 The sequence may throw a ClassCastException if any of the element is not self-comparable (i.e., doesn't implement the Comparable interface).
 The result's iterator() doesn't support remove().
 
 Returns:
 
 the new Ix instance
 
 Since:
 
 1.0
 
 See Also:
 
 min()
 - minInt
```
public final Ix<java.lang.Integer> minInt()
```
 Returns the first minimum integer value.
 The sequence may throw a ClassCastException if any of the elements is not an Integer object.
 The result's iterator() doesn't support remove().
 
 Returns:
 
 the new Ix instance
 
 Since:
 
 1.0
 - minLong
```
public final Ix<java.lang.Long> minLong()
```
 Returns the first minimum long value.
 The sequence may throw a ClassCastException if any of the elements is not a Long object.
 The result's iterator() doesn't support remove().
 
 Returns:
 
 the new Ix instance
 
 Since:
 
 1.0
 - orderBy
```
public final Ix<T> orderBy()
```
 Orders elements according to their natural order.
 The sequence may throw a ClassCastException if any of the elements is not a self-comparable object (i.e., doesn't implement the Comparable interface).
 The result's iterator() doesn't support remove().
 
 Returns:
 
 the new Ix instance
 
 Since:
 
 1.0
 
 See Also:
 
 orderByReverse(), orderBy(Comparator)
 - orderBy
```
public final Ix<T> orderBy(java.util.Comparator<? super T> comparator)
```
 Orders elements according to the comparator.
 The result's iterator() doesn't support remove().
 
 Parameters:
 
 comparator - the comparator comparing two elements; if it returns a negative value, the first element will be before the second; if it returns a positive value, the first element will be after the second.
 
 Returns:
 
 the new Ix instance
 
 Throws:
 
 java.lang.NullPointerException - if comparator is null
 
 Since:
 
 1.0
 
 See Also:
 
 orderBy(), orderByReverse(Comparator)
 - orderBy
```
public final <K extends java.lang.Comparable<? super K>> Ix<T> orderBy(IxFunction<? super T,K> keySelector)
```
 Orders elements according to the natural order of the extracted keys from these elements.
 The result's iterator() doesn't support remove().
 
 Type Parameters:
 
 K - the key type
 
 Parameters:
 
 keySelector - the function receiving each element and returns a self-comparable key for them.
 
 Returns:
 
 the new Ix instance
 
 Throws:
 
 java.lang.NullPointerException - if keySelector is null
 
 Since:
 
 1.0
 
 See Also:
 
 orderByReverse(IxFunction)
 - orderByReverse
```
public final Ix<T> orderByReverse()
```
 Orders elements according to their reverse natural order.
 The sequence may throw a ClassCastException if any of the elements is not a self-comparable object (i.e., doesn't implement the Comparable interface).
 The result's iterator() doesn't support remove().
 
 Returns:
 
 the new Ix instance
 
 Since:
 
 1.0
 
 See Also:
 
 orderBy(), orderByReverse(Comparator)
 - orderByReverse
```
public final Ix<T> orderByReverse(java.util.Comparator<? super T> comparator)
```
 Orders elements according to the reversed comparator.
 The result's iterator() doesn't support remove().
 
 Parameters:
 
 comparator - the comparator comparing two elements; if it returns a negative value, the first element will be after the second; if it returns a positive value, the first element will be before the second.
 
 Returns:
 
 the new Ix instance
 
 Throws:
 
 java.lang.NullPointerException - if comparator is null
 
 Since:
 
 1.0
 
 See Also:
 
 orderByReverse(), orderBy(Comparator)
 - orderByReverse
```
public final <K extends java.lang.Comparable<? super K>> Ix<T> orderByReverse(IxFunction<? super T,K> keySelector)
```
 Orders elements according to the reverse natural order of the extracted keys from these elements.
 The result's iterator() doesn't support remove().
 
 Type Parameters:
 
 K - the key type
 
 Parameters:
 
 keySelector - the function receiving each element and returns a self-comparable key for them.
 
 Returns:
 
 the new Ix instance
 
 Throws:
 
 java.lang.NullPointerException - if keySelector is null
 
 Since:
 
 1.0
 
 See Also:
 
 orderByReverse(IxFunction)
 - publish
```
public final Ix<T> publish()
```
 Shares an underlying Iterator that is consumed only once and each created iterator() that calls next() will receive the elements; other iterator() instances may receive different or no elements at all.
 The result's iterator() doesn't support remove().
 
 Returns:
 
 the new iterator sequence
 
 Since:
 
 1.0
 - publish
```
public final <R> Ix<R> publish(IxFunction<? super Ix<T>,? extends java.lang.Iterable<? extends R>> transform)
```
 Shares an Iterator, exposed as an Ix sequence, for the duration of the transform function called for each iterator() invocation and emits elements of the resulting iterable sequence of the function.
 The result's iterator() doesn't support remove().
 
 Type Parameters:
 
 R - the result value type
 
 Parameters:
 
 transform - the function that receives an Ix instance sharing a single underlying Iterator to this sequence and returns another Iterable to be the result sequence
 
 Returns:
 
 the new Iterable sequence
 
 Throws:
 
 java.lang.NullPointerException - if transform is null
 
 Since:
 
 1.0
 - reduce
```
public final Ix<T> reduce(IxFunction2<T,T,T> reducer)
```
 Reduces the elements of this sequence into a single value via a reducer function.
 The result's iterator() doesn't support remove().
 
 Parameters:
 
 reducer - the function that receives the previous reduced element (or the first) and the current element and returns a new reduced element
 
 Returns:
 
 the new Ix instance
 
 Throws:
 
 java.lang.NullPointerException - if reducer is null
 
 Since:
 
 1.0
 
 See Also:
 
 reduce(IxSupplier, IxFunction2)
 - reduce
```
public final <C> Ix<C> reduce(IxSupplier<C> initialFactory,
 IxFunction2<C,T,C> reducer)
```
 Given a per-iterator() initial value, reduces the elements of this sequence into a single value via a reducer function.
 The result's iterator() doesn't support remove().
 
 Type Parameters:
 
 C - the reduced value type
 
 Parameters:
 
 initialFactory - a function called for each iterator() invocation and returns the first reduced value
 
 reducer - the function called with the previous (or initial) reduced value and the current element and returns a new reduced value
 
 Returns:
 
 the new Ix instance
 
 Throws:
 
 java.lang.NullPointerException - if initialFactory or reducer is null
 
 Since:
 
 1.0
 
 See Also:
 
 reduce(IxFunction2)
 - remove
```
public final Ix<T> remove(IxPredicate<? super T> predicate)
```
 Removes those elements via Iterator.remove() from this sequence that match the given predicate.
 The result's iterator() forwards the calls to remove() to this' Iterator.
 
 Parameters:
 
 predicate - the function called with the current element and returns true if that particular element should be removed.
 
 Returns:
 
 the new Ix instance
 
 Throws:
 
 java.lang.NullPointerException - if predicate is null
 
 Since:
 
 1.0
 
 See Also:
 
 retain(IxPredicate)
 - repeat
```
public final Ix<T> repeat()
```
 Repeats this sequence indefinitely.
 The result's iterator() doesn't support remove().
 
 Returns:
 
 the new Ix instance
 
 Since:
 
 1.0
 - repeat
```
public final Ix<T> repeat(long times)
```
 Repeats this sequence at most the given number of times.
 A count of zero will yield an empty sequence, a count of one will yield a sequence with only one element and so forth.
 The result's iterator() doesn't support remove().
 
 Parameters:
 
 times - the number of times to emit the value, non-negative
 
 Returns:
 
 the new Ix instance
 
 Throws:
 
 java.lang.IllegalArgumentException - if count is negative
 
 Since:
 
 1.0
 - repeat
```
public final Ix<T> repeat(IxBooleanSupplier stopPredicate)
```
 Repeats this sequence if the given predicate returns true after the sequence completes in a round.
 The result's iterator() doesn't support remove().
 
 Parameters:
 
 stopPredicate - the predicate called before any emission; returning false keeps repeating the value, returning true terminates the sequence
 
 Returns:
 
 the new Ix instance
 
 Throws:
 
 java.lang.NullPointerException - if stopPredicate is null
 
 Since:
 
 1.0
 - repeat
```
public final Ix<T> repeat(long times,
 IxBooleanSupplier stopPredicate)
```
 Repeats this sequence if the given predicate returns true after the sequence completes in a round or at most the given number of times.
 A count of zero will yield an empty sequence, a count of one will yield a sequence with only one element and so forth.
 The result's iterator() doesn't support remove().
 
 Parameters:
 
 times - the number of times to emit the value, non-negative
 
 stopPredicate - the predicate called before any emission; returning false keeps repeating the value, returning true terminates the sequence
 
 Returns:
 
 the new Ix instance
 
 Throws:
 
 java.lang.IllegalArgumentException - if count is negative
 
 java.lang.NullPointerException - if stopPredicate is null
 
 Since:
 
 1.0
 - replay
```
public final Ix<T> replay()
```
 Caches and replays all elements of this sequence to consumers of this' iterator().
 The result's iterator() doesn't support remove().
 
 Returns:
 
 the new Ix instance
 
 Since:
 
 1.0
 - replay
```
public final Ix<T> replay(int size)
```
 Caches and replays the last size elements of this sequence to consumers of this' iterator().
 Consumption by any of the iterator() may move the source sequence forward and subsequent iterator() consumers may get a different set of values
 The result's iterator() doesn't support remove().
 
 Parameters:
 
 size - the maximum number of elements to keep replaying to new iterator() consumers, positive
 
 Returns:
 
 the new Ix instance
 
 Throws:
 
 java.lang.IllegalArgumentException - if size is non-positive
 
 Since:
 
 1.0
 - replay
```
public final <R> Ix<R> replay(IxFunction<? super Ix<T>,? extends java.lang.Iterable<? extends R>> transform)
```
 Caches and replays the elements of this sequence for the duration of the given transform function without consuming this sequence multiple times.
 The result's iterator() doesn't support remove().
 
 Type Parameters:
 
 R - the result value type
 
 Parameters:
 
 transform - the function receiving a view into the cache and returns an Iterable sequence whose elements will be emitted by this Ix.
 
 Returns:
 
 the new Ix instance
 
 Throws:
 
 java.lang.NullPointerException - if transform is null
 
 Since:
 
 1.0
 - replay
```
public final <R> Ix<R> replay(int size,
 IxFunction<? super Ix<T>,? extends java.lang.Iterable<? extends R>> transform)
```
 Caches and replays the the last size elements of this sequence for the duration of the given transform function without consuming this sequence multiple times.
 Consumption by any of the inner Ix' iterator() may move the shared sequence forward and subsequent iterator() consumers may get a different set of values
 The result's iterator() doesn't support remove().
 
 Type Parameters:
 
 R - the result value type
 
 Parameters:
 
 size - the maximum number of elements to keep replaying to new inner Ix iterator() consumers, positive
 
 transform - the function receiving a view into the cache and returns an Iterable sequence whose elements will be emitted by this Ix.
 
 Returns:
 
 the new Ix instance
 
 Throws:
 
 java.lang.NullPointerException - if transform is null
 
 java.lang.IllegalArgumentException - if size is non-positive
 
 Since:
 
 1.0
 - retain
```
public final Ix<T> retain(IxPredicate<? super T> predicate)
```
 Removes those elements via Iterator.remove() from this sequence that don't match the given predicate.
 The result's iterator() forwards the calls to remove() to this' Iterator.
 
 Parameters:
 
 predicate - the function called with the current element and returns false if that particular element should be removed.
 
 Returns:
 
 the new Ix instance
 
 Throws:
 
 java.lang.NullPointerException - if predicate is null
 
 Since:
 
 1.0
 
 See Also:
 
 remove(IxPredicate)
 - reverse
```
public final Ix<T> reverse()
```
 Plays this sequence in reverse.
 The reversal requires consuming the entire sequence and doesn't work with infinite sequences.
 The result's iterator() doesn't support remove().
 
 Returns:
 
 the new Ix instance
 
 Since:
 
 1.0
 - scan
```
public final Ix<T> scan(IxFunction2<T,T,T> scanner)
```
 Performs a running accumulation, that is, returns intermediate elements returned by the scanner function.
 The result's iterator() doesn't support remove().
 
 Parameters:
 
 scanner - the function that receives the previous (or first) accumulated element and the current element and returns a value to be emitted and to become the accumulated element
 
 Returns:
 
 the new Ix instance
 
 Throws:
 
 java.lang.NullPointerException - if scanner is null
 
 Since:
 
 1.0
 - scan
```
public final <R> Ix<R> scan(IxSupplier<R> initialFactory,
 IxFunction2<R,T,R> scanner)
```
 Performs a running accumulation, that is, returns intermediate elements returned by the scanner function, starting with a per-iterator initial value.
 The result's iterator() doesn't support remove().
 
 Type Parameters:
 
 R - the accumulated value type
 
 Parameters:
 
 initialFactory - function called for each iterator() and returns the initial accumulator value
 
 scanner - the function that receives the previous (or first) accumulated element and the current element and returns a value to be emitted and to become the accumulated element
 
 Returns:
 
 the new Ix instance
 
 Throws:
 
 java.lang.NullPointerException - if initialFactory or scanner is null
 
 Since:
 
 1.0
 - sequenceEqual
```
public final Ix<java.lang.Boolean> sequenceEqual(java.lang.Iterable<? extends T> other)
```
 Determines if two sequences have the same elements in the same order and are the same length based on null-safe object equality.
 The result's iterator() doesn't support remove().
 
 Parameters:
 
 other - the other sequence to compare with
 
 Returns:
 
 the new Ix instance
 
 Throws:
 
 java.lang.NullPointerException - if other is null
 
 Since:
 
 1.0
 - sequenceEqual
```
public final Ix<java.lang.Boolean> sequenceEqual(java.lang.Iterable<? extends T> other,
 IxPredicate2<? super T,? super T> comparer)
```
 Determines if two sequences have the same elements in the same order and are the same length based on the given comparer's boolean value.
 The result's iterator() doesn't support remove().
 
 Parameters:
 
 other - the other sequence to compare with
 
 comparer - the predicate receiving elements from this and the other sequence and returns true if those elements are equal
 
 Returns:
 
 the new Ix instance
 
 Throws:
 
 java.lang.NullPointerException - if other is null
 
 Since:
 
 1.0
 - skip
```
public final Ix<T> skip(int n)
```
 Skips the first n elements from this sequence.
 The result's iterator() forwards the calls to remove() to this' Iterator.
 
 Parameters:
 
 n - the elements to skip, non-positive values won't skip any elements
 
 Returns:
 
 the new Ix instance
 
 Since:
 
 1.0
 
 See Also:
 
 take(int)
 - skipLast
```
public final Ix<T> skipLast(int n)
```
 Skips the last n elements from this sequence.
 The result's iterator() doesn't support remove().
 
 Parameters:
 
 n - the elements to skip, non-positive values won't skip any elements
 
 Returns:
 
 the new Ix instance
 
 Since:
 
 1.0
 
 See Also:
 
 takeLast(int)
 - skipWhile
```
public final Ix<T> skipWhile(IxPredicate<? super T> predicate)
```
 Skips the first elements while the given predicate returns true; once it returns false all subsequent elements are emitted.
 The result's iterator() forwards the calls to remove() to this' Iterator.
 
 Parameters:
 
 predicate - the predicate called with the current element and returns true to skip that element
 
 Returns:
 
 the new Ix instance
 
 Throws:
 
 java.lang.NullPointerException - if predicate is null
 
 Since:
 
 1.0
 
 See Also:
 
 takeWhile(IxPredicate)
 - startWith
```
public final Ix<T> startWith(T... values)
```
 Emits elements of the given array followed by the elements of this sequence.
 The result's iterator() doesn't support remove().
 
 Parameters:
 
 values - the array of values to emit first
 
 Returns:
 
 the new Ix instance
 
 Throws:
 
 java.lang.NullPointerException - if values is null
 
 Since:
 
 1.0
 - sumInt
```
public final Ix<java.lang.Integer> sumInt()
```
 Sums values of this sequence as integer.
 The operation may throw a ClassCastException if any of the elements is not an Integer.
 An empty sequence yields an empty sum.
 The result's iterator() doesn't support remove().
 
 Returns:
 
 the new Ix instance
 
 Since:
 
 1.0
 - sumLong
```
public final Ix<java.lang.Long> sumLong()
```
 Sums values of this sequence as long.
 The operation may throw a ClassCastException if any of the elements is not an Long.
 An empty sequence yields an empty sum.
 The result's iterator() doesn't support remove().
 
 Returns:
 
 the new Ix instance
 
 Since:
 
 1.0
 - switchIfEmpty
```
public final Ix<T> switchIfEmpty(java.lang.Iterable<? extends T> other)
```
 Emits the elements of the other sequence if this sequence is empty.
 The result's Iterator forwards calls of remove() to this' or the other's Iterator.
 
 Parameters:
 
 other - the other Iterable instance, not null
 
 Returns:
 
 the new Ix instance
 
 Throws:
 
 java.lang.NullPointerException - if other is null
 
 Since:
 
 1.0
 - take
```
public final Ix<T> take(int n)
```
 Emits the first n elements (or less) of this sequence.
 The result's Iterator forwards calls of remove() to this' Iterator.
 
 Parameters:
 
 n - the number of items to emit at most, non-negative
 
 Returns:
 
 the new Ix instance
 
 Throws:
 
 java.lang.IllegalArgumentException - if n is negative
 
 Since:
 
 1.0
 
 See Also:
 
 skip(int)
 - takeLast
```
public final Ix<T> takeLast(int n)
```
 Emits the last n elements (or fewer) of this sequence.
 The result's iterator() doesn't support remove().
 
 Parameters:
 
 n - the number of last elements to emit
 
 Returns:
 
 the new Ix instance
 
 Throws:
 
 java.lang.IllegalArgumentException - if n is negative
 
 Since:
 
 1.0
 
 See Also:
 
 skipLast(int)
 - takeUntil
```
public final Ix<T> takeUntil(IxPredicate<? super T> stopPredicate)
```
 Take elements from this sequence until the given predicate returns true for the current element (checked after emission of that element).
 The result's Iterator forwards calls of remove() to this' Iterator.
 
 Parameters:
 
 stopPredicate - the function receiving the current element and returns true if no further elements should be emitted after this element.
 
 Returns:
 
 the new Ix instance
 
 Throws:
 
 java.lang.NullPointerException - if stopPredicate is null
 
 Since:
 
 1.0
 - takeWhile
```
public final Ix<T> takeWhile(IxPredicate<? super T> predicate)
```
 Take elements from this sequence while the given predicate returns true for the current element (checked before emission of that element).
 The result's Iterator forwards calls of remove() to this' Iterator.
 
 Parameters:
 
 predicate - the function receiving the current element and returns false if no further elements should be emitted (not even the current).
 
 Returns:
 
 the new Ix instance
 
 Throws:
 
 java.lang.NullPointerException - if predicate is null
 
 Since:
 
 1.0
 - toLong
```
public final Ix<java.lang.Long> toLong()
```
 Maps this sequence of numbers into a sequence of longs.
 The sequence may throw a ClassCastException if any of the elements is not a subclass of Number.
 The result's Iterator forwards calls of remove() to this' Iterator.
 
 Returns:
 
 the new Ix instance
 
 Since:
 
 1.0
 - transform
```
public final <R> Ix<R> transform(IxTransform<T,R> transformer)
```
 Allows working with the Iterator of this sequence and emit elements in a more flexible way
 The result's iterator() doesn't support remove().
 
 Type Parameters:
 
 R - the result value type
 
 Parameters:
 
 transformer - the functional interface whose moveNext is called with the current Iterator and should signal a value to be emitted for it.
 
 Returns:
 
 the new Ix instance
 
 Throws:
 
 java.lang.NullPointerException - if transformer is null
 - union
```
public final Ix<T> union(java.lang.Iterable<? extends T> other)
```
 Emits a distinct set of values from both this and the other sequence.
 The result's iterator() doesn't support remove().
 
 Parameters:
 
 other - the other Iterable sequence, not null
 
 Returns:
 
 the new Ix instance
 
 Throws:
 
 java.lang.NullPointerException - if other is null
 
 Since:
 
 1.0
 
 See Also:
 
 except(Iterable), intersect(Iterable)
 - window
```
public final Ix<Ix<T>> window(int size)
```
 Emits inner Ix Iterables of non-overlapping sequences mapped from this sequence with the given maximum size each.
 The result's and the inner Ix' iterator() don't support remove().
 
 Parameters:
 
 size - the maximum size of the inner windows, positive
 
 Returns:
 
 the new Ix instance
 
 Throws:
 
 java.lang.IllegalArgumentException - if size is non-positive
 
 Since:
 
 1.0
 
 See Also:
 
 window(int, int)
 - window
```
public final Ix<Ix<T>> window(int size,
 int skip)
```
 Emits inner Ix Iterables of potentially overlapping sequences mapped from this sequence with the given maximum size each and started each skip source elements.
 
 Parameters:
 
 size - the maximum size of the inner windows, positive
 
 skip - after how many elements to start a new window (repeatedly), positive
 
 Returns:
 
 the new Ix instance
 
 Throws:
 
 java.lang.IllegalArgumentException - if size or skip is non-positive
 
 Since:
 
 1.0
 
 See Also:
 
 window(int)
 - zipWith
```
public final <U,R> Ix<R> zipWith(java.lang.Iterable other,
 IxFunction2<? super T,? super U,? extends R> zipper)
```
 Combines the next element from this and the other source Iterable via a zipper function.
 If one of the source Iterables is sorter the sequence terminates eagerly.
 The result's iterator() doesn't support remove().
 
 Type Parameters:
 
 U - the other source's element type
 
 R - the result value type
 
 Parameters:
 
 other - the the other source Iterable
 
 zipper - the function that takes one from each source, not null
 
 Returns:
 
 the new Ix instance
 
 Throws:
 
 java.lang.NullPointerException - if other or zipper is null
 
 Since:
 
 1.0
 - first
```
public final T first()
```
 Returns the first element of this sequence.
 
 Returns:
 
 the first element
 
 Throws:
 
 java.util.NoSuchElementException - if this sequence is empty
 
 Since:
 
 1.0
 
 See Also:
 
 first(Object), last(Object)
 - first
```
public final T first(T defaultValue)
```
 Returns the first element of this sequence or the defaultValue if this sequence is empty.
 
 Parameters:
 
 defaultValue - the value to return if this sequence is empty
 
 Returns:
 
 the first element or the default value
 
 Since:
 
 1.0
 
 See Also:
 
 first(), last()
 - foreach
```
public final void foreach(IxConsumer<? super T> action)
```
 Consumes the entire sequence and calls the given action with each value.
 
 Parameters:
 
 action - the action to call
 
 Throws:
 
 java.lang.NullPointerException - if action is null
 
 Since:
 
 1.0
 
 See Also:
 
 foreachWhile(IxPredicate)
 - foreachWhile
```
public final void foreachWhile(IxPredicate<? super T> predicate)
```
 Consumes the entire sequence and calls the given predicate with each value; which can stop the iteration by returning false.
 
 Parameters:
 
 predicate - the predicate to call with the current element and should return true to continue the loop or false to quit the loop.
 
 Throws:
 
 java.lang.NullPointerException - if action is null
 
 Since:
 
 1.0
 
 See Also:
 
 foreach(IxConsumer)
 - into
```
public final > U into(U collection)
```
 Consumes the entire sequence and adds each element into the given collection that is also returned.
 
 Type Parameters:
 
 U - the collection of type accepting a (super)type of this element type
 
 Parameters:
 
 collection - the collection to collect into
 
 Returns:
 
 the collection itself
 
 Throws:
 
 java.lang.NullPointerException - if collection is null
 
 Since:
 
 1.0
 - last
```
public final T last()
```
 Returns the last element of this sequence.
 
 Returns:
 
 the last element of this sequence
 
 Throws:
 
 java.util.NoSuchElementException - if the sequence is empty
 
 Since:
 
 1.0
 
 See Also:
 
 last(Object)
 - last
```
public final T last(T defaultValue)
```
 Returns the last element of this sequence or the defaultValue if this sequence is empty.
 
 Parameters:
 
 defaultValue - the value to return if this sequence is empty
 
 Returns:
 
 the last element or the default value
 
 Since:
 
 1.0
 
 See Also:
 
 last(), first()
 - print
```
public final void print()
```
 Prints the elements of this sequence to the console, separated by a comma+space and with a line break after roughly 80 characters.
 
 Since:
 
 1.0
 - print
```
public final void print(java.lang.CharSequence separator,
 int charsPerLine)
```
 Prints the elements of this sequence to the console, separated by the given separator and with a line break after roughly the given charsPerLine amount.
 
 Parameters:
 
 separator - the characters to separate the elements
 
 charsPerLine - indicates how long a line should be
 - println
```
public final void println()
```
 Prints each element of this sequence into a new line on the console.
 
 Since:
 
 1.0
 - println
```
public final void println(java.lang.CharSequence prefix)
```
 Prints each element of this sequence into a new line on the console, prefixed by the given character sequence.
 
 Parameters:
 
 prefix - the prefix before each line
 - removeAll
```
public final void removeAll()
```
 Removes all elements by repeatedly calling this sequence's Iterator.remove().
 - removeAll
```
public final void removeAll(IxPredicate<? super T> predicate)
```
 Consumes this Iterable and removes all elements for which the predicate returns true; in other words, remove those elements of a mutable source that match the predicate.
 
 Parameters:
 
 predicate - the predicate called with the current element and should return true for elements to remove, false for elements to keep.
 
 Throws:
 
 java.lang.UnsupportedOperationException - if the this Iterable doesn't allow removing elements.
 
 Since:
 
 1.0
 
 See Also:
 
 retainAll(IxPredicate), removeAll()
 - retainAll
```
public final void retainAll(IxPredicate<? super T> predicate)
```
 Consumes this Iterable and removes all elements for which the predicate returns false; in other words, retain those elements of a mutable source that match the predicate.
 
 Parameters:
 
 predicate - the predicate called with the current element and should return true for elements to keep, false for elements to remove.
 
 Throws:
 
 java.lang.UnsupportedOperationException - if the this Iterable doesn't allow removing elements.
 
 Since:
 
 1.0
 
 See Also:
 
 removeAll(IxPredicate)
 - run
```
public final void run()
```
 Iterates over this instance, dropping all values it produces.
 
 See Also:
 
 subscribe()
 - single
```
public final T single()
```
 Returns the single element of this sequence or throws a NoSuchElementException if this sequence is empty or IndexOutOfBoundsException if this sequence has more than on element
 
 Returns:
 
 the single element of the sequence
 
 Throws:
 
 java.lang.IndexOutOfBoundsException - if the sequence has more than one element
 
 java.util.NoSuchElementException - if the sequence is empty
 
 Since:
 
 1.0
 
 See Also:
 
 single(Object)
 - single
```
public final T single(T defaultValue)
```
 Returns the single element of this sequence, defaultValue if this sequence is empty or IndexOutOfBoundsException if this sequence has more than one element
 
 Parameters:
 
 defaultValue - the value to return if this sequence is empty
 
 Returns:
 
 the single element of the sequence
 
 Throws:
 
 java.lang.IndexOutOfBoundsException - if the sequence has more than one element
 
 Since:
 
 1.0
 
 See Also:
 
 single(Object)
 - subscribe
```
public final void subscribe()
```
 Iterates over this instance, dropping all values it produces.
 
 See Also:
 
 run()
 - subscribe
```
public final void subscribe(IxConsumer<? super T> onNext)
```
 Iterates over this sequence and calls the given onNext action with each element.
 
 Parameters:
 
 onNext - the consumer to call with each element
 
 Throws:
 
 java.lang.NullPointerException - if consumer is null
 
 Since:
 
 1.0
 - subscribe
```
public final void subscribe(IxConsumer<? super T> onNext,
 IxConsumer<java.lang.Throwable> onError)
```
 Iterates over this sequence and calls the given onNext action with each element and calls the onError with any exception thrown by the iteration or the onNext action.
 
 Parameters:
 
 onNext - the consumer to call with each element
 
 onError - the consumer to call with the exception thrown
 
 Throws:
 
 java.lang.NullPointerException - if onError is null
 
 Since:
 
 1.0
 - subscribe
```
public final void subscribe(IxConsumer<? super T> onNext,
 IxConsumer<java.lang.Throwable> onError,
 java.lang.Runnable onCompleted)
```
 Iterates over this sequence and calls the given onNext action with each element and calls the onError with any exception thrown by the iteration or the onNext action; otherwise calls the onCompleted action when the sequence completes without exception.
 
 Parameters:
 
 onNext - the consumer to call with each element
 
 onError - the consumer to call with the exception thrown
 
 onCompleted - the action called after the sequence has been consumed
 
 Throws:
 
 java.lang.NullPointerException - if onError or onCompleted is null
 
 Since:
 
 1.0
 - toArray
```
public final java.lang.Object[] toArray()
```
 Collects the elements of this sequence into an Object array.
 
 Returns:
 
 the new Object array instance
 
 Since:
 
 1.0
 - toArray
```
public final  U[] toArray(U[] array)
```
 Collects the elements of this sequence into a generic array provided.
 
 Type Parameters:
 
 U - the output array type
 
 Parameters:
 
 array - the target array to fill in or use as a template if not long enough
 
 Returns:
 
 the new generic array instance
 
 Since:
 
 1.0
 - toList
```
public final java.util.List<T> toList()
```
 Collects the elements of this sequence into a List.
 
 Returns:
 
 the List instance
 
 Since:
 
 1.0
 - toMap
```
public final <K> java.util.Map<K,T> toMap(IxFunction<? super T,? extends K> keySelector)
```
 Collects the elements of this sequence into a Map where the key is determined from each element via the keySelector function; duplicates are overwritten.
 
 Type Parameters:
 
 K - the key type
 
 Parameters:
 
 keySelector - the function that receives the current element and returns a key for it to be used as the Map key.
 
 Returns:
 
 the new Map instance
 
 Throws:
 
 java.lang.NullPointerException - if keySelector is null
 
 Since:
 
 1.0
 - toMap
```
public final <K,V> java.util.Map<K,V> toMap(IxFunction<? super T,? extends K> keySelector,
 IxFunction<? super T,? extends V> valueSelector)
```
 Collects the elements of this sequence into a Map where the key is determined from each element via the keySelector function and the value is derived from the same element via the valueSelector function; duplicates are overwritten.
 
 Type Parameters:
 
 K - the key type
 
 V - the value type
 
 Parameters:
 
 keySelector - the function that receives the current element and returns a key for it to be used as the Map key.
 
 valueSelector - the function that receives the current element and returns a value for it to be used as the Map value
 
 Returns:
 
 the new Map instance
 
 Throws:
 
 java.lang.NullPointerException - if keySelector or valueSelector is null
 
 Since:
 
 1.0
 - toMultimap
```
public final <K> java.util.Map<K,java.util.Collection<T>> toMultimap(IxFunction<? super T,? extends K> keySelector)
```
 Collects the elements of this sequence into a multi-Map where the key is determined from each element via the keySelector function.
 
 Type Parameters:
 
 K - the key type
 
 Parameters:
 
 keySelector - the function that receives the current element and returns a key for it to be used as the Map key.
 
 Returns:
 
 the new Map instance
 
 Throws:
 
 java.lang.NullPointerException - if keySelector is null
 
 Since:
 
 1.0
 - toMultimap
```
public final <K,V> java.util.Map<K,java.util.Collection<V>> toMultimap(IxFunction<? super T,? extends K> keySelector,
 IxFunction<? super T,? extends V> valueSelector)
```
 Collects the elements of this sequence into a multi-Map where the key is determined from each element via the keySelector function and the value is derived from the same element via the valueSelector function.
 
 Type Parameters:
 
 K - the key type
 
 V - the value type
 
 Parameters:
 
 keySelector - the function that receives the current element and returns a key for it to be used as the Map key.
 
 valueSelector - the function that receives the current element and returns a value for it to be used as the Map value
 
 Returns:
 
 the new Map instance
 
 Throws:
 
 java.lang.NullPointerException - if keySelector or valueSelector is null
 
 Since:
 
 1.0
 - toSet
```
public final java.util.Set<T> toSet()
```
 Collects the elements of this sequence into a Set.
 
 Returns:
 
 the new Ix instance
 
 Since:
 
 1.0
 - nullCheck
```
protected static  U nullCheck(U value,
 java.lang.String message)
```
 Checks if the value is null and if so, throws a NullPointerException with the given message.
 
 Type Parameters:
 
 U - the value type
 
 Parameters:
 
 value - the value to check for null
 
 message - the message to report in the exception
 
 Returns:
 
 the value
 - checkedCall
```
protected static  U checkedCall(java.util.concurrent.Callable callable)
```
 Calls the given callable and rethrows its exception (as RuntimeException if necessary).
 
 Type Parameters:
 
 U - the value type
 
 Parameters:
 
 callable - the callable to call
 
 Returns:
 
 the value returned by the callable
 - nonNegative
```
protected static long nonNegative(long n,
 java.lang.String name)
```
 Checks if the given value is non-negative and returns it; throws an IllegalArgumentException otherwise.
 
 Parameters:
 
 n - the number to check
 
 name - the name of the parameter
 
 Returns:
 
 n
 - nonNegative
```
protected static int nonNegative(int n,
 java.lang.String name)
```
 Checks if the given value is non-negative and returns it; throws an IllegalArgumentException otherwise.
 
 Parameters:
 
 n - the number to check
 
 name - the name of the parameter
 
 Returns:
 
 n
 - positive
```
protected static int positive(int n,
 java.lang.String name)
```
 Checks if the given value is positive and returns it; throws an IllegalArgumentException otherwise.
 
 Parameters:
 
 n - the number to check
 
 name - the name of the parameter
 
 Returns:
 
 n

Class Ix<T>

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface java.lang.Iterable

Constructor Detail

Ix

Method Detail

characters

characters

concat

concat

concat

concat

concatArray

defer

empty

from

fromArray

fromArrayRange

forloop

generate

generate

generate

just

merge

mergeArray

orderedMerge

orderedMerge

orderedMergeArray

orderedMergeArray

range

readOnly

readOnly

repeatCallable

repeatValue

repeatValue

repeatValue

repeatValue

split

zip

zip

zip

zip

zip

all

any

as

averageFloat

averageDouble

buffer

buffer

bufferSplit

bufferUntil

bufferWhile

cast

collect

collectToArray

collectToList

collectToMap

collectToMap

collectToMultimap

collectToMultimap

collectToSet

compose

concatMap

concatWith

contains

count

countLong

defaultIfEmpty

distinct

distinct

distinctUntilChanged

distinctUntilChanged

distinctUntilChanged

doOnNext

doOnCompleted

endWith

every