org.broadinstitute.hellbender.utils.collections

Interface Permutation<E>

All Known Subinterfaces:

AlleleListPermutation<A>

All Known Implementing Classes:

AlleleList.ActualPermutation, AlleleList.NonPermutation

public interface Permutation<E>

Represent a permutation of a ordered set or list of elements.

Method Summary

Modifier and Type	Method and Description
int	fromIndex(int toIndex) Given an index on the resulting list, it gives you the index of that element on the original list.
java.util.List<E>	fromList() Returns an unmodifiable view to the original element list.
int	fromSize() Length of the original element list.
boolean	isKept(int fromIndex) Given an index of the original list, return whether this index is found at any position of the permuted list.
boolean	isNonPermuted() Checks whether this is a trivial permutation where the resulting element list is the same as original.
boolean	isPartial() Checks whether this permutation is a partial one of the original list.
int	toIndex(int fromIndex) Given an index on the original list, returns the position of tha element in the resulting list.
java.util.List<E>	toList() Returns an unmodifiable view to the original element list.
int	toSize() Length of the resulting element list.

Method Detail

isPartial

boolean isPartial()

Checks whether this permutation is a partial one of the original list.

A partial permutation is one in that not all original elements take part in.

Returns:

true iff this is a partial permutation.

isNonPermuted

boolean isNonPermuted()

Checks whether this is a trivial permutation where the resulting element list is the same as original.

Returns:

true iff the resulting element list is the same as the original.

toIndex

int toIndex(int fromIndex)

Given an index on the original list, returns the position of tha element in the resulting list.

Parameters:

fromIndex - the query original element index.

Returns:

-1 if that element is not part of the result (partial) permutation, otherwise some number between 0 and toSize() - 1.

Throws:

java.lang.IllegalArgumentException - if fromIndex is not a valid index within the original list.

fromIndex

int fromIndex(int toIndex)

Given an index on the resulting list, it gives you the index of that element on the original list.

Parameters:

toIndex - the query resulting list index.

Returns:

a value between 0 and fromSize() - 1.

Throws:

java.lang.IllegalArgumentException - if toIndex is not a valid index, i.e. in [0,toSize()-1).

isKept

boolean isKept(int fromIndex)

Given an index of the original list, return whether this index is found at any position of the permuted list. This is trivial if the permutation is not partial.

Parameters:

fromIndex -

Returns:

fromSize

int fromSize()

Length of the original element list.

Returns:

0 or greater.

toSize

int toSize()

Length of the resulting element list.

Returns:

0 or greater.

fromList

java.util.List<E> fromList()

Returns an unmodifiable view to the original element list.

Returns:

never null.

toList

java.util.List<E> toList()

Returns an unmodifiable view to the original element list.

Returns:

never null.