edu.stanford.math.plex4.homology.filtration

Class FiltrationConverter

java.lang.Object

edu.stanford.math.plex4.homology.filtration.FiltrationConverter

All Implemented Interfaces:

edu.stanford.math.primitivelib.autogen.functional.ObjectObjectFunction<Interval<java.lang.Integer>,Interval<java.lang.Double>>

Direct Known Subclasses:

ExternalConverter, IdentityConverter, IncreasingLinearConverter, StaticConverter

public abstract class FiltrationConverter
extends java.lang.Object
implements edu.stanford.math.primitivelib.autogen.functional.ObjectObjectFunction<Interval<java.lang.Integer>,Interval<java.lang.Double>>

This interface defines a mapping between filtration values and filtration indices.

Author:

Andrew Tausz

Constructor Summary

Constructors

Constructor and Description
FiltrationConverter()

Method Summary

Methods

Modifier and Type	Method and Description
abstract double	computeInducedFiltrationValue(double filtrationValue1, double filtrationValue2) This function computes the filtration value that is consistent with the ordering of filtration indices.
Interval<java.lang.Double>	evaluate(Interval<java.lang.Integer> interval)
abstract int	getFiltrationIndex(double filtrationValue) This function computes the index based on a filtration value.
abstract double	getFiltrationValue(int filtrationIndex) This function computes the filtration value from a filtration index.
abstract double	getInitialFiltrationValue() This function returns the filtration at index 0.
<G> PersistenceInvariantDescriptor<Interval<java.lang.Double>,G>	transform(PersistenceInvariantDescriptor<Interval<java.lang.Integer>,G> invariantDescriptor)

Methods inherited from class java.lang.Object

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

Constructor Detail

FiltrationConverter

public FiltrationConverter()

Method Detail

getFiltrationIndex

public abstract int getFiltrationIndex(double filtrationValue)

This function computes the index based on a filtration value.

Parameters:

filtrationValue - the value to convert

Returns:

the filtration index of the given value

getFiltrationValue

public abstract double getFiltrationValue(int filtrationIndex)

This function computes the filtration value from a filtration index.

Parameters:

filtrationIndex - the index to convert

Returns:

the filtration value for the particular index

computeInducedFiltrationValue

public abstract double computeInducedFiltrationValue(double filtrationValue1,
                                   double filtrationValue2)

This function computes the filtration value that is consistent with the ordering of filtration indices. For example, for filtration values that are increasing with filtration indices, this should be the max function.

Parameters:

filtrationValue1 -

filtrationValue2 -

Returns:

the filtration value that is induced by two filtration values

getInitialFiltrationValue

public abstract double getInitialFiltrationValue()

This function returns the filtration at index 0.

Returns:

the filtration at index 0

transform

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

evaluate

public Interval<java.lang.Double> evaluate(Interval<java.lang.Integer> interval)

Specified by:

evaluate in interface edu.stanford.math.primitivelib.autogen.functional.ObjectObjectFunction<Interval<java.lang.Integer>,Interval<java.lang.Double>>