ball.util.stream

Interface Combinations<T>

Type Parameters:

T - The List element type.

All Superinterfaces:

AutoCloseable, BaseStream<List<T>,Stream<List<T>>>, Stream<List<T>>

All Known Subinterfaces:

Permutations<T>

public interface Combinations<T>
extends Stream<List<T>>

Stream implementaion that provides all combinations of a List.

Version:

$Revision: 6133 $

Author:

Allen D. Ball

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	Combinations.SpliteratorSupplier<T> Combinations Spliterator Supplier.

Nested classes/interfaces inherited from interface java.util.stream.Stream

Stream.Builder<T>

Method Summary

Modifier and Type	Method and Description
static <T> Stream<List<T>>	of(int size, Collection<T> collection) Method to get the Stream of combinations.
static <T> Stream<List<T>>	of(int size0, int sizeN, Predicate<List<T>> predicate, Collection<T> collection) Method to get the Stream of combinations.

Methods inherited from interface java.util.stream.Stream

allMatch, anyMatch, builder, collect, collect, concat, count, distinct, empty, filter, findAny, findFirst, flatMap, flatMapToDouble, flatMapToInt, flatMapToLong, forEach, forEachOrdered, generate, iterate, limit, map, mapToDouble, mapToInt, mapToLong, max, min, noneMatch, of, of, peek, reduce, reduce, reduce, skip, sorted, sorted, toArray, toArray

Methods inherited from interface java.util.stream.BaseStream

close, isParallel, iterator, onClose, parallel, sequential, spliterator, unordered

Method Detail

of

static <T> Stream<List<T>> of(int size,
                              Collection<T> collection)

Method to get the Stream of combinations.

Type Parameters:

T - The Collection element type.

Parameters:

size - The combination size.

collection - The Collection of elements to permute.

Returns:

The Stream of combinations.

of

static <T> Stream<List<T>> of(int size0,
                              int sizeN,
                              Predicate<List<T>> predicate,
                              Collection<T> collection)

Method to get the Stream of combinations. Combinations will be streamed largest to smallest or smallest to largest depending on the relative magnitude of size0 and sizeN. E.g., to stream largest to smallest specify sizeN that is greater than size0.

Type Parameters:

T - The Collection element type.

Parameters:

size0 - The combination size range start (inclusive).

sizeN - The combination size range end (inclusive).

predicate - The optional Predicate (may be null) specifying prerequisite requirement(s) for the combinations. Any path that does not match will be pruned.

collection - The Collection of elements to permute.

Returns:

The Stream of combinations.