jsat.math

Interface IndexFunction

All Superinterfaces:

Function, java.io.Serializable

All Known Subinterfaces:

WordWeighting

All Known Implementing Classes:

BinaryWordPresent, OkapiBM25, TfIdf, WordCount

public interface IndexFunction
extends Function

Method Summary

Modifier and Type	Method and Description
default double	f(Vec x, boolean parallel) Evaluates the given function for the specified input vector.
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 interface jsat.math.Function

f, f, forwardDifference

Method Detail

indexFunc

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

default double f(Vec x,
                 boolean parallel)

Description copied from interface: Function

Evaluates the given function for the specified input vector.

Specified by:

f in interface Function

Parameters:

x - the input to the function

parallel - true if the function should be evaluated with multiple threads, or false to use a single thread.

Returns:

the scalar output of this function