edu.stanford.math.plex4.homology.barcodes

Class PersistenceInvariantDescriptor<I,G>

java.lang.Object

edu.stanford.math.plex4.homology.barcodes.PersistenceInvariantDescriptor<I,G>

Type Parameters:

I - the persistence invariant type - ie. the interval type

G - the generator type

All Implemented Interfaces:

java.lang.Iterable<java.util.Map.Entry<java.lang.Integer,java.util.List<edu.stanford.math.primitivelib.autogen.pair.ObjectObjectPair<I,G>>>>

Direct Known Subclasses:

AnnotatedBarcodeCollection

public class PersistenceInvariantDescriptor<I,G>
extends java.lang.Object
implements java.lang.Iterable<java.util.Map.Entry<java.lang.Integer,java.util.List<edu.stanford.math.primitivelib.autogen.pair.ObjectObjectPair<I,G>>>>

This class is designed to store persistence algorithm invariants for each dimension, with additional information about the generators. It is primarily designed to be used in the case where the persistence invariant type (I) is an interval type, and the generator type (G) is the type of cycles.

Author:

Andrew Tausz

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.Map<java.lang.Integer,java.util.List<G>>	generators
protected java.util.Map<java.lang.Integer,java.util.List<edu.stanford.math.primitivelib.autogen.pair.ObjectObjectPair<I,G>>>	intervalGeneratorPairs
protected java.util.Map<java.lang.Integer,java.util.List<I>>	intervals

Constructor Summary

Constructors

Constructor and Description
PersistenceInvariantDescriptor()

Method Summary

Methods

Modifier and Type	Method and Description
void	addInterval(int dimension, I interval, G generator) This function adds an interval and generator at the specified dimension to the collection.
boolean	equals(java.lang.Object obj)
java.lang.String	getBettiNumbers() This function returns a string representation of the set of betti numbers.
int[]	getBettiSequence() This function returns an array of integers indicating the cardinality of the barcodes at each dimension.
java.util.Set<java.lang.Integer>	getDimensions() This function returns the set of dimensions at which there are intervals.
java.util.Iterator<java.util.Map.Entry<java.lang.Integer,java.util.List<G>>>	getGeneratorIterator() This function returns an iterator for traversing the generators.
java.util.List<G>	getGeneratorsAtDimension(int dimension) This function returns the set of generators at a specified dimension.
java.util.Iterator<java.util.Map.Entry<java.lang.Integer,java.util.List<edu.stanford.math.primitivelib.autogen.pair.ObjectObjectPair<I,G>>>>	getIntervalGeneratorPairIterator() This function returns an iterator for traversing the interval-generator pairs.
java.util.List<edu.stanford.math.primitivelib.autogen.pair.ObjectObjectPair<I,G>>	getIntervalGeneratorPairsAtDimension(int dimension) This function returns the set of interval-generator pairs at a specified dimension.
java.util.Iterator<java.util.Map.Entry<java.lang.Integer,java.util.List<I>>>	getIntervalIterator() This function returns an iterator for traversing the intervals.
java.util.List<I>	getIntervalsAtDimension(int dimension) This function returns the set of intervals at a specified dimension.
int	hashCode()
java.util.Iterator<java.util.Map.Entry<java.lang.Integer,java.util.List<edu.stanford.math.primitivelib.autogen.pair.ObjectObjectPair<I,G>>>>	iterator()
java.lang.String	toString()
static <I,G> PersistenceInvariantDescriptor<I,G>	union(PersistenceInvariantDescriptor<I,G> a, PersistenceInvariantDescriptor<I,G> b) This function computes the union of two collections of persistence invariants.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

intervals

protected final java.util.Map<java.lang.Integer,java.util.List<I>> intervals

generators

protected final java.util.Map<java.lang.Integer,java.util.List<G>> generators

intervalGeneratorPairs

protected final java.util.Map<java.lang.Integer,java.util.List<edu.stanford.math.primitivelib.autogen.pair.ObjectObjectPair<I,G>>> intervalGeneratorPairs

Constructor Detail

PersistenceInvariantDescriptor

public PersistenceInvariantDescriptor()

Method Detail

addInterval

public void addInterval(int dimension,
               I interval,
               G generator)

This function adds an interval and generator at the specified dimension to the collection.

Parameters:

dimension - the dimension at which to add

interval - the interval

generator - the generator

getBettiSequence

public int[] getBettiSequence()

This function returns an array of integers indicating the cardinality of the barcodes at each dimension.

Returns:

an array indicating the cardinality of each barcode at each dimension

getBettiNumbers

public java.lang.String getBettiNumbers()

This function returns a string representation of the set of betti numbers.

Returns:

a string showing a pretty version of the betti numbers

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getIntervalIterator

public java.util.Iterator<java.util.Map.Entry<java.lang.Integer,java.util.List<I>>> getIntervalIterator()

This function returns an iterator for traversing the intervals. Each element returned by the iterator is a pair consisting of the dimension, and the list of intervals at that dimension.

Returns:

an iterator for the intervals

getGeneratorIterator

public java.util.Iterator<java.util.Map.Entry<java.lang.Integer,java.util.List<G>>> getGeneratorIterator()

This function returns an iterator for traversing the generators. Each element returned by the iterator is a pair consisting of the dimension, and the list of generators at that dimension.

Returns:

an iterator for the generators

getIntervalGeneratorPairIterator

public java.util.Iterator<java.util.Map.Entry<java.lang.Integer,java.util.List<edu.stanford.math.primitivelib.autogen.pair.ObjectObjectPair<I,G>>>> getIntervalGeneratorPairIterator()

This function returns an iterator for traversing the interval-generator pairs. Each element returned by the iterator is a pair consisting of the dimension, and the list of interval-generator pairs at that dimension.

Returns:

an iterator for the generators

getDimensions

public java.util.Set<java.lang.Integer> getDimensions()

This function returns the set of dimensions at which there are intervals.

Returns:

the set of dimensions.

getIntervalsAtDimension

public java.util.List<I> getIntervalsAtDimension(int dimension)

This function returns the set of intervals at a specified dimension.

Parameters:

dimension - the dimension to get the intervals at

Returns:

the intervals at the given dimension

getGeneratorsAtDimension

public java.util.List<G> getGeneratorsAtDimension(int dimension)

This function returns the set of generators at a specified dimension.

Parameters:

dimension - the dimension to get the generators at

Returns:

the generators at the given dimension

getIntervalGeneratorPairsAtDimension

public java.util.List<edu.stanford.math.primitivelib.autogen.pair.ObjectObjectPair<I,G>> getIntervalGeneratorPairsAtDimension(int dimension)

This function returns the set of interval-generator pairs at a specified dimension.

Parameters:

dimension - the dimension to get the interval-generator pairs at

Returns:

the interval-generator pairs at the given dimension

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

iterator

public java.util.Iterator<java.util.Map.Entry<java.lang.Integer,java.util.List<edu.stanford.math.primitivelib.autogen.pair.ObjectObjectPair<I,G>>>> iterator()

Specified by:

iterator in interface java.lang.Iterable<java.util.Map.Entry<java.lang.Integer,java.util.List<edu.stanford.math.primitivelib.autogen.pair.ObjectObjectPair<I,G>>>>

union

public static <I,G> PersistenceInvariantDescriptor<I,G> union(PersistenceInvariantDescriptor<I,G> a,
                                              PersistenceInvariantDescriptor<I,G> b)

This function computes the union of two collections of persistence invariants.

Type Parameters:

I - the persistence invariant type - ie. the interval type

G - the generator type

Parameters:

a - the first collection

b - the second collection

Returns:

the union of the two collections