gov.sandia.cognition.math

Class Combinations

java.lang.Object

java.util.AbstractCollection<E>

java.util.AbstractSet<Vector>

gov.sandia.cognition.math.Combinations

All Implemented Interfaces:

CloneableSerializable, java.io.Serializable, java.lang.Cloneable, java.lang.Iterable<Vector>, java.util.Collection<Vector>, java.util.Set<Vector>

public class Combinations
extends java.util.AbstractSet<Vector>
implements CloneableSerializable

Enumerates all the combinations on a given number of items sampled from a larger set without considering order, that is, (1,2) is the same as (2,1). For example, there are 3 ways to choose 2 objects from a set of 3: (1,2), (1,3), (2,3).

Since:

3.4.2

Author:

Kevin R. Dixon

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	Combinations.AbstractCombinationsIterator<IteratorType extends Combinations.AbstractCombinationsIterator<IteratorType,ClassType>,ClassType> Partial implementation of a CombinationsIterator.
class	Combinations.IndexIterator Iterator that returns the index into a set: 0, 1, 2, ...
static class	Combinations.SubsetIterator<ClassType> Creates a new instance of SubsetIterator, one that returns the elements from a given set

Constructor Summary

Constructors

Constructor and Description
Combinations(int N, int k) Creates a new instance of Combinations

Method Summary

Modifier and Type	Method and Description
Combinations	clone() Creates a new clone (shallow copy) of this object.
int	getK() Getter for k
int	getN() Getter for N
java.util.Iterator<Vector>	iterator()
int	size()

Methods inherited from class java.util.AbstractSet

equals, hashCode, removeAll

Methods inherited from class java.util.AbstractCollection

add, addAll, clear, contains, containsAll, isEmpty, remove, retainAll, toArray, toArray, toString

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Set

add, addAll, clear, contains, containsAll, isEmpty, remove, retainAll, spliterator, toArray, toArray

Methods inherited from interface java.util.Collection

parallelStream, removeIf, stream

Methods inherited from interface java.lang.Iterable

forEach

Constructor Detail

Combinations

public Combinations(int N,
                    int k)

Creates a new instance of Combinations

Parameters:

N - Universe set size

k - Number of objects to choose from the universe set.

Method Detail

clone

public Combinations clone()

Description copied from interface: CloneableSerializable

Creates a new clone (shallow copy) of this object.

Specified by:

clone in interface CloneableSerializable

Overrides:

clone in class java.lang.Object

Returns:

A new clone (shallow copy) of this object.

iterator

public java.util.Iterator<Vector> iterator()

Specified by:

iterator in interface java.lang.Iterable<Vector>

Specified by:

iterator in interface java.util.Collection<Vector>

Specified by:

iterator in interface java.util.Set<Vector>

Specified by:

iterator in class java.util.AbstractCollection<Vector>

size

public int size()

Specified by:

size in interface java.util.Collection<Vector>

Specified by:

size in interface java.util.Set<Vector>

Specified by:

size in class java.util.AbstractCollection<Vector>

getN

public int getN()

Getter for N

Returns:

Universe set size

getK

public int getK()

Getter for k

Returns:

the k Number of objects to choose from the universe set.