edu.stanford.math.plex4.streams.multi

Class PrimitiveMultifilteredStream<T extends PrimitiveBasisElement>

java.lang.Object

edu.stanford.math.plex4.streams.multi.PrimitiveMultifilteredStream<T>

All Implemented Interfaces:

AbstractMultifilteredStream<T>, java.lang.Iterable<T>

Direct Known Subclasses:

BifilteredMetricStream

public abstract class PrimitiveMultifilteredStream<T extends PrimitiveBasisElement>
extends java.lang.Object
implements AbstractMultifilteredStream<T>

Constructor Summary

Constructors

Constructor and Description
PrimitiveMultifilteredStream()

Method Summary

Methods

Modifier and Type	Method and Description
void	addElement(T basisElement, double[] filtrationValue)
void	finalizeStream() This function prepares the stream for use by a consumer, such as the PersistentHomology class.
T[]	getBoundary(T basisElement) This function returns the elements in the boundary of the supplied basisElement, without the coefficients.
int[]	getBoundaryCoefficients(T basisElement) This function returns the coefficients of the boundary of the supplied basis element.
int	getDimension(T basisElement) This function returns the dimension of a basis element within the chain complex.
double[]	getFiltrationValue(T basisElement) This function returns the filtration multi-index of the requested basis element.
int	getSize() This function returns the total number of elements in the stream.
boolean	isFinalized() This function checks whether the finalize() function has been called.
java.util.Iterator<T>	iterator()
<G> PersistenceInvariantDescriptor<Interval<java.lang.Double>,G>	transform(PersistenceInvariantDescriptor<Interval<java.lang.Integer>,G> barcodeCollection) This function transforms the given collection of filtration index barcodes into filtration value barcodes.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface edu.stanford.math.plex4.streams.multi.AbstractMultifilteredStream

getBasisComparator

Constructor Detail

PrimitiveMultifilteredStream

public PrimitiveMultifilteredStream()

Method Detail

addElement

public void addElement(T basisElement,
              double[] filtrationValue)

iterator

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

Specified by:

iterator in interface java.lang.Iterable<T extends PrimitiveBasisElement>

getFiltrationValue

public double[] getFiltrationValue(T basisElement)

Description copied from interface: AbstractMultifilteredStream

This function returns the filtration multi-index of the requested basis element.

Specified by:

getFiltrationValue in interface AbstractMultifilteredStream<T extends PrimitiveBasisElement>

Parameters:

basisElement - the basis element to get the filtration multi-index for

Returns:

the filtration multi-index of the specified basis element

getBoundary

public final T[] getBoundary(T basisElement)

Description copied from interface: AbstractMultifilteredStream

This function returns the elements in the boundary of the supplied basisElement, without the coefficients. We do not integrate the elements of the boundary array with their respective coefficients since this interface is designed to be independent of the algebraic environment.

Specified by:

getBoundary in interface AbstractMultifilteredStream<T extends PrimitiveBasisElement>

Parameters:

basisElement - the element to get the boundary of

Returns:

an array containing the boundary elements of the queried element

getBoundaryCoefficients

public int[] getBoundaryCoefficients(T basisElement)

Description copied from interface: AbstractMultifilteredStream

This function returns the coefficients of the boundary of the supplied basis element. Note that in many cases, this will be the standard array consisting of alternating signs: [1, -1, 1, -1, ...]. However, this will not always be the case. Thus this must be left abstract. Also note that the coefficients will always be integers.

Specified by:

getBoundaryCoefficients in interface AbstractMultifilteredStream<T extends PrimitiveBasisElement>

Parameters:

basisElement - the element to get the boundary coefficients of

Returns:

an array containing the boundary coefficients of the queried element

getDimension

public int getDimension(T basisElement)

Description copied from interface: AbstractMultifilteredStream

This function returns the dimension of a basis element within the chain complex.

Specified by:

getDimension in interface AbstractMultifilteredStream<T extends PrimitiveBasisElement>

Parameters:

basisElement - the element to get the dimension of

Returns:

the dimension of the basis element within the chain complex

finalizeStream

public void finalizeStream()

Description copied from interface: AbstractMultifilteredStream

This function prepares the stream for use by a consumer, such as the PersistentHomology class. After finalization, the stream cannot not be modified by adding or removing elements. In practice, the finalize procedure will probably do some sorting and construction of data structures necessary for iterating through the stream.

Specified by:

finalizeStream in interface AbstractMultifilteredStream<T extends PrimitiveBasisElement>

isFinalized

public boolean isFinalized()

Description copied from interface: AbstractMultifilteredStream

This function checks whether the finalize() function has been called.

Specified by:

isFinalized in interface AbstractMultifilteredStream<T extends PrimitiveBasisElement>

Returns:

true if the stream has been finalized, and false otherwise

getSize

public int getSize()

Description copied from interface: AbstractMultifilteredStream

This function returns the total number of elements in the stream.

Specified by:

getSize in interface AbstractMultifilteredStream<T extends PrimitiveBasisElement>

Returns:

the size of the stream

transform

public <G> PersistenceInvariantDescriptor<Interval<java.lang.Double>,G> transform(PersistenceInvariantDescriptor<Interval<java.lang.Integer>,G> barcodeCollection)

Description copied from interface: AbstractMultifilteredStream

This function transforms the given collection of filtration index barcodes into filtration value barcodes.

Specified by:

transform in interface AbstractMultifilteredStream<T extends PrimitiveBasisElement>

Parameters:

barcodeCollection - the set of filtration index barcodes

Returns:

the barcodes transformed into filtration value form