edu.stanford.math.plex4.homology.filtration

Class IdentityConverter

java.lang.Object

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

edu.stanford.math.plex4.homology.filtration.IdentityConverter

All Implemented Interfaces:

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

public class IdentityConverter
extends FiltrationConverter

This class defines a filtration value conversion which simply defines the filtration value to be equal to the filtration index. (i.e. f_i = i)

Author:

Andrew Tausz

Method Summary

Methods

Modifier and Type	Method and Description
double	computeInducedFiltrationValue(double filtrationValue1, double filtrationValue2) This function computes the filtration value that is consistent with the ordering of filtration indices.
int	getFiltrationIndex(double filtrationValue) This function computes the index based on a filtration value.
double	getFiltrationValue(int filtrationIndex) This function computes the filtration value from a filtration index.
double	getInitialFiltrationValue() This function returns the filtration at index 0.
static IdentityConverter	getInstance() This returns the single instance of the class.

Methods inherited from class edu.stanford.math.plex4.homology.filtration.FiltrationConverter

evaluate, transform

Methods inherited from class java.lang.Object

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

Method Detail

getInstance

public static IdentityConverter getInstance()

This returns the single instance of the class.

Returns:

the single instance of the class

getFiltrationIndex

public int getFiltrationIndex(double filtrationValue)

Description copied from class: FiltrationConverter

This function computes the index based on a filtration value.

Specified by:

getFiltrationIndex in class FiltrationConverter

Parameters:

filtrationValue - the value to convert

Returns:

the filtration index of the given value

getFiltrationValue

public double getFiltrationValue(int filtrationIndex)

Description copied from class: FiltrationConverter

This function computes the filtration value from a filtration index.

Specified by:

getFiltrationValue in class FiltrationConverter

Parameters:

filtrationIndex - the index to convert

Returns:

the filtration value for the particular index

computeInducedFiltrationValue

public double computeInducedFiltrationValue(double filtrationValue1,
                                   double filtrationValue2)

Description copied from class: FiltrationConverter

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.

Specified by:

computeInducedFiltrationValue in class FiltrationConverter

Returns:

the filtration value that is induced by two filtration values

getInitialFiltrationValue

public double getInitialFiltrationValue()

Description copied from class: FiltrationConverter

This function returns the filtration at index 0.

Specified by:

getInitialFiltrationValue in class FiltrationConverter

Returns:

the filtration at index 0