jsat.math

Class IndexFunction

java.lang.Object

jsat.math.IndexFunction

All Implemented Interfaces:

Serializable, Function

Direct Known Subclasses:

WordWeighting

public abstract class IndexFunction
extends Object
implements Function

Author:

Edward Raff

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
IndexFunction()

Method Summary

Modifier and Type	Method and Description
double	f(double... x)
double	f(Vec x)
abstract double	indexFunc(double value, int index) An index function, meant to be applied to vectors where the value to be computed may vary based on the position in the vector of the value.

Methods inherited from class java.lang.Object

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

Constructor Detail

IndexFunction

public IndexFunction()

Method Detail

indexFunc

public abstract double indexFunc(double value,
                                 int index)

An index function, meant to be applied to vectors where the value to be computed may vary based on the position in the vector of the value.

Parameters:

value - the value at the specified index

index - the index the value is from

Returns:

the computed result. If a negative index was given, the function should return 0.0 if indexFunc(0,indx) would return zero for all valid indices. If this is not the case, any non zero value should be returned.

f

public double f(double... x)

Specified by:

f in interface Function

f

public double f(Vec x)

Specified by:

f in interface Function