edu.stanford.math.plex4.streams.utility

Class SkeletalMetric

java.lang.Object

edu.stanford.math.plex4.streams.utility.SkeletalMetric

All Implemented Interfaces:

AbstractIntMetricSpace, AbstractObjectMetric<Simplex>, AbstractObjectMetricSpace<Simplex>

public class SkeletalMetric
extends java.lang.Object
implements AbstractObjectMetricSpace<Simplex>

This class implements a metric on a simplicial complex. The distance between two simplices is defined to be the maximum of the distances between the any two pairs of vertices where one vertex is in the first simplex and the other is in the second simplex.

Author:

Andrew Tausz

Constructor Summary

Constructors

Constructor and Description
SkeletalMetric(AbstractFilteredStream<Simplex> stream)

Method Summary

Methods

Modifier and Type	Method and Description
double	distance(int i, int j) This function returns the distance between the object at index i and the object at index j.
double	distance(Simplex simplex_i, Simplex simplex_j) This function returns the distance between two points.
double	getDiameter(edu.stanford.math.primitivelib.autogen.formal_sum.DoubleSparseFormalSum<Simplex> chain)
Simplex	getPoint(int index) This function returns the point at the specified index.
Simplex[]	getPoints() This function returns the set of points in the metric space as an array.
int	size() This function returns the number of points in the metric space.

Methods inherited from class java.lang.Object

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

Constructor Detail

SkeletalMetric

public SkeletalMetric(AbstractFilteredStream<Simplex> stream)

Method Detail

getDiameter

public double getDiameter(edu.stanford.math.primitivelib.autogen.formal_sum.DoubleSparseFormalSum<Simplex> chain)

getPoint

public Simplex getPoint(int index)

Description copied from interface: AbstractObjectMetricSpace

This function returns the point at the specified index.

Specified by:

getPoint in interface AbstractObjectMetricSpace<Simplex>

Parameters:

index - the index of the point to retrieve

Returns:

the point at the given index

size

public int size()

Description copied from interface: AbstractIntMetricSpace

This function returns the number of points in the metric space.

Specified by:

size in interface AbstractIntMetricSpace

Returns:

the number of points in the metric space.

distance

public double distance(int i,
              int j)

Description copied from interface: AbstractIntMetricSpace

This function returns the distance between the object at index i and the object at index j.

Specified by:

distance in interface AbstractIntMetricSpace

Parameters:

i - the index of the first object

j - the index of the second object

Returns:

the distance between the objects at the two given indices

distance

public double distance(Simplex simplex_i,
              Simplex simplex_j)

Description copied from interface: AbstractObjectMetric

This function returns the distance between two points.

Specified by:

distance in interface AbstractObjectMetric<Simplex>

Parameters:

simplex_i - the first point

simplex_j - the second point

Returns:

the distance between the two points

getPoints

public Simplex[] getPoints()

Description copied from interface: AbstractObjectMetricSpace

This function returns the set of points in the metric space as an array. The returned array satisfies the requirement that the indices of the points in the array are equal to the indices of the points within the metric space.

Specified by:

getPoints in interface AbstractObjectMetricSpace<Simplex>

Returns:

an array containing the points of the metric space