jsat.math

Interface FunctionVec

All Known Implementing Classes:

LinearBatch.GradFunction

public interface FunctionVec

Interface for representing a function that takes a vector as input should return a vector as the output.

Method Summary

Modifier and Type	Method and Description
default Vec	f(double... x) Computes the function value given the input x
default Vec	f(Vec x) Computes the function value given the input x
default Vec	f(Vec x, Vec s) Computes the function value given the input x
Vec	f(Vec x, Vec s, boolean parallel) Computes the function value given the input x

Method Detail

f

default Vec f(double... x)

Computes the function value given the input x

Parameters:

x - the input to compute the output from

Returns:

the vector containing the results

f

default Vec f(Vec x)

Computes the function value given the input x

Parameters:

x - the input to compute the output from

Returns:

the vector containing the results

f

default Vec f(Vec x,
              Vec s)

Computes the function value given the input x

Parameters:

x - the input to compute the output from

s - the vector to store the result in, or null if a new vector should be allocated

Returns:

the vector containing the results. This is the same object as s if s is not null

f

Vec f(Vec x,
      Vec s,
      boolean parallel)

Computes the function value given the input x

Parameters:

x - the input to compute the output from

s - the vector to store the result in, or null if a new vector should be allocated

parallel - true if multiple threads should be used for evaluation, false if only a single thread should.

Returns:

the vector containing the results. This is the same object as s of s is not null