edu.stanford.math.plex4.streams.storage_structures

Interface StreamStorageStructure<T>

Type Parameters:

T -

All Superinterfaces:

java.lang.Iterable<T>

All Known Implementing Classes:

HashedStorageStructure, SortedStorageStructure

public interface StreamStorageStructure<T>
extends java.lang.Iterable<T>

This interface defines the functionality of a stream storage structure. Such a structure is designed to be the backing of a streamed filtered chain complex. Note that this interface extends the Iterable interface. An implementing class must ensure that the elements are provided in increasing order of filtration index.

Author:

Andrew Tausz

Method Summary

Methods

Modifier and Type	Method and Description
void	addElement(T basisElement, int filtrationIndex) This function adds the given basis element to the storage structure, with the supplied filtration index.
boolean	containsElement(T basisElement) This function returns true if the stream contains the given basis element, and false otherwise.
void	finalizeStructure() This function sets the stream as being finalized.
java.util.Comparator<T>	getBasisComparator() This function returns a Comparator object used to define the ordering on the basis type.
int	getFiltrationIndex(T basisElement) This function returns the filtration index of the given basis element.
int	getMaximumFiltrationIndex() This function gets the maximum filtration index in the complex.
int	getMinimumFiltrationIndex() This function gets the minimum filtration index in the complex.
int	getSize() This function returns the number of elements in the storage structure.
boolean	isFinalized() This function returns true if the stream has been finalized.
void	removeElement(T basisElement) This function removes the specified element form the storage structure.

Methods inherited from interface java.lang.Iterable

iterator

Method Detail

addElement

void addElement(T basisElement,
              int filtrationIndex)

This function adds the given basis element to the storage structure, with the supplied filtration index.

Parameters:

basisElement - the basis element to add

filtrationIndex - the filtration index of the basis element

removeElement

void removeElement(T basisElement)

This function removes the specified element form the storage structure. In the case that the element is not present in the stream, this function throws an IllegalArgumentException.

Parameters:

basisElement - the basisElement to remove

containsElement

boolean containsElement(T basisElement)

This function returns true if the stream contains the given basis element, and false otherwise.

Parameters:

basisElement - the basis element to query

Returns:

true if the stream contains the basis element and false otherwise

getFiltrationIndex

int getFiltrationIndex(T basisElement)

This function returns the filtration index of the given basis element.

Parameters:

basisElement - the element to query

Returns:

the filtration index of the given basis element

finalizeStructure

void finalizeStructure()

This function sets the stream as being finalized. A finalized storage structure cannot accept any more elements, and should be ready for consumption.

isFinalized

boolean isFinalized()

This function returns true if the stream has been finalized.

Returns:

true if the stream is finalized and false otherwise

getBasisComparator

java.util.Comparator<T> getBasisComparator()

This function returns a Comparator object used to define the ordering on the basis type.

Returns:

a Comparator on the basis type

getSize

int getSize()

This function returns the number of elements in the storage structure.

Returns:

the number of elements in the storage structure

getMaximumFiltrationIndex

int getMaximumFiltrationIndex()

This function gets the maximum filtration index in the complex.

Returns:

the maximum filtration index

getMinimumFiltrationIndex

int getMinimumFiltrationIndex()

This function gets the minimum filtration index in the complex.

Returns:

the minimum filtration index