edu.stanford.math.plex4.streams.impl

Class ExplicitSimplexStream

java.lang.Object

edu.stanford.math.plex4.streams.interfaces.PrimitiveStream<T>

edu.stanford.math.plex4.streams.impl.ExplicitStream<Simplex>

edu.stanford.math.plex4.streams.impl.ExplicitSimplexStream

All Implemented Interfaces:

AbstractFilteredStream<Simplex>, java.lang.Iterable<Simplex>

public class ExplicitSimplexStream
extends ExplicitStream<Simplex>

This class is a wrapper for the ExplicitStream class and provides convenience functions when the base elements are simplices.

Author:

Andrew Tausz

Field Summary

Fields inherited from class edu.stanford.math.plex4.streams.interfaces.PrimitiveStream

storageStructure

Constructor Summary

Constructors

Constructor and Description
ExplicitSimplexStream() This constructor initializes the class with the default simplex comparator.
ExplicitSimplexStream(java.util.Comparator<Simplex> comparator) This constructor initializes the class with the given simplex comparator.
ExplicitSimplexStream(java.util.Comparator<Simplex> comparator, double maxFiltrationValue)
ExplicitSimplexStream(double maxFiltrationValue)

Method Summary

Methods

Modifier and Type	Method and Description
void	addElement(int[] vertices) This function adds a simplex with the provided vertices.
void	addElement(int[] vertices, double filtrationValue) This function adds a simplex with the provided vertices and given filtration index.
void	addVertex(int index) This function adds a new vertex to the complex with a filtration index of 0.
void	addVertex(int index, double filtrationValue) This function adds a new vertex to the complex with specified filtration index.
boolean	removeElementIfPresent(int[] vertices)

Methods inherited from class edu.stanford.math.plex4.streams.impl.ExplicitStream

addAllElements, addElement, constructComplex, containsElement, ensureAllFaces, getFiltrationValue, removeElementIfPresent, transform

Methods inherited from class edu.stanford.math.plex4.streams.interfaces.PrimitiveStream

finalizeStream, getBasisComparator, getBoundary, getBoundaryCoefficients, getDimension, getFiltrationIndex, getMaximumFiltrationIndex, getMinimumFiltrationIndex, getSize, isFinalized, iterator, validate, validateVerbose

Methods inherited from class java.lang.Object

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

Constructor Detail

ExplicitSimplexStream

public ExplicitSimplexStream(java.util.Comparator<Simplex> comparator)

This constructor initializes the class with the given simplex comparator.

Parameters:

comparator - the Comparator to initialize with

ExplicitSimplexStream

public ExplicitSimplexStream(java.util.Comparator<Simplex> comparator,
                     double maxFiltrationValue)

ExplicitSimplexStream

public ExplicitSimplexStream()

This constructor initializes the class with the default simplex comparator.

ExplicitSimplexStream

public ExplicitSimplexStream(double maxFiltrationValue)

Method Detail

addVertex

public void addVertex(int index)

This function adds a new vertex to the complex with a filtration index of 0.

Parameters:

index - the index of the vertex

addVertex

public void addVertex(int index,
             double filtrationValue)

This function adds a new vertex to the complex with specified filtration index.

Parameters:

index - the index of the vertex to add

filtrationIndex - the filtration index

addElement

public void addElement(int[] vertices)

This function adds a simplex with the provided vertices.

Parameters:

vertices - the vertices of the simplex to add

addElement

public void addElement(int[] vertices,
              double filtrationValue)

This function adds a simplex with the provided vertices and given filtration index.

Parameters:

vertices - the vertices of the simplex to add

filtrationIndex - the filtration index

removeElementIfPresent

public boolean removeElementIfPresent(int[] vertices)