edu.stanford.math.plex4.streams.impl

Class ExplicitCellStream

java.lang.Object

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

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

edu.stanford.math.plex4.streams.impl.ExplicitCellStream

All Implemented Interfaces:

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

public class ExplicitCellStream
extends ExplicitStream<Cell>

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

Author:

Andrew Tausz

Field Summary

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

storageStructure

Constructor Summary

Constructors

Constructor and Description
ExplicitCellStream() Default constructor.
ExplicitCellStream(double maxFiltrationValue)

Method Summary

Methods

Modifier and Type	Method and Description
void	addElement(Cell basisElement, double filtrationValue) This function adds a basis element the stream with specified filtration index.
int	addNewVertex() This adds a new vertex to the cell complex.
int	attachNewCell(int dimension, int[] boundaryIndices) This adds a new cell to the complex with boundary specified by the supplied array of cell ids.
int	attachNewCell(int dimension, int[] boundaryIndices, int[] boundaryCoefficients) This adds a new cell to the complex with boundary and boundary coefficients given.
int	attachNewCellToPoint(int dimension, int pointIndex) This attaches a n-cell to an existing point in the complex.

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

addAllElements, 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

ExplicitCellStream

public ExplicitCellStream()

Default constructor.

ExplicitCellStream

public ExplicitCellStream(double maxFiltrationValue)

Method Detail

addNewVertex

public int addNewVertex()

This adds a new vertex to the cell complex.

Returns:

the cell id of the newly added vertex

attachNewCellToPoint

public int attachNewCellToPoint(int dimension,
                       int pointIndex)

This attaches a n-cell to an existing point in the complex.

Parameters:

dimension - the dimension of the cell to add

pointIndex - the point to attach the boundary to

Returns:

the cell id of the newly added cell

attachNewCell

public int attachNewCell(int dimension,
                int[] boundaryIndices)

This adds a new cell to the complex with boundary specified by the supplied array of cell ids. It uses the standard attaching coefficients.

Parameters:

dimension - the dimension of the cell to add

boundaryIndices - an array of cell ids to attach to

Returns:

the cell id of the newly added cell

attachNewCell

public int attachNewCell(int dimension,
                int[] boundaryIndices,
                int[] boundaryCoefficients)

This adds a new cell to the complex with boundary and boundary coefficients given.

Parameters:

dimension - the dimension fo the cell to add

boundaryIndices - an array of cell ids to attach to

boundaryCoefficients - the array of attaching map degrees

Returns:

the cell id of the newly added cell

addElement

public void addElement(Cell basisElement,
              double filtrationValue)

Description copied from class: ExplicitStream

This function adds a basis element the stream with specified filtration index.

Overrides:

addElement in class ExplicitStream<Cell>

Parameters:

basisElement - the basis element to add