function
Interface VectorFunction

All Superinterfaces:
Computable
All Known Subinterfaces:
MultiObjectiveDiviner
All Known Implementing Classes:
ApproxModelToVectorFunction, BasicMultiObjectiveDiviner, BasicVectorFunction, CaffeToVectorFunction, EC6, RiskPerfTypeIDiviner, RiskPerfTypeIIDiviner, RiskPerfTypeIIIDiviner, RiskPerfTypeIVDiviner, RiskPerfTypeVDiviner, SupersonicWB, VectorFunctionBuilder, ZDT1, ZDT2, ZDT3, ZDTFunction

public interface VectorFunction
extends Computable

Provides methods for vector functions.

Author:
dgorur

Method Summary
 double[] compute(double[] x)
          Computes the outputs corresponding to the given input.
 void compute(double[][] x, double[][] y)
          Computes the outputs corresponding to the given set of inputs and stores the results in the given array, which cannot be null.
 cern.colt.matrix.DoubleMatrix1D compute(cern.colt.matrix.DoubleMatrix1D x, cern.colt.matrix.DoubleMatrix1D y)
          Computes the outputs corresponding to the given input, and stores the result in the supplied vector, which cannot be null.
 cern.colt.matrix.DoubleMatrix2D compute(cern.colt.matrix.DoubleMatrix2D X, cern.colt.matrix.DoubleMatrix2D Y)
          Computes the outputs corresponding to the given set of inputs and stores the result in the given array, which cannot be null.
 void init()
          Init method.
 void quickCompute(double[] x, double[] y)
          Abstract method that all subclasses must implement.
 void quickCompute(cern.colt.matrix.DoubleMatrix2D X, cern.colt.matrix.DoubleMatrix2D Y)
          Applies compute(double[]) on a set of inputs, supplied row-wise in a matrix.
 
Methods inherited from interface function.Computable
compute, getBounds, getInputDimension, getOutputDimension, isWithinBounds
 

Method Detail

compute

double[] compute(double[] x)
Computes the outputs corresponding to the given input.

Parameters:
x - the given input.
Returns:
an array of outputs.

compute

void compute(double[][] x,
             double[][] y)
Computes the outputs corresponding to the given set of inputs and stores the results in the given array, which cannot be null.

Specified by:
compute in interface Computable
Parameters:
x - the given inputs.
y - array to hold the result.

compute

cern.colt.matrix.DoubleMatrix1D compute(cern.colt.matrix.DoubleMatrix1D x,
                                        cern.colt.matrix.DoubleMatrix1D y)
Computes the outputs corresponding to the given input, and stores the result in the supplied vector, which cannot be null.

Parameters:
x - the given input.
y - matrix

compute

cern.colt.matrix.DoubleMatrix2D compute(cern.colt.matrix.DoubleMatrix2D X,
                                        cern.colt.matrix.DoubleMatrix2D Y)
Computes the outputs corresponding to the given set of inputs and stores the result in the given array, which cannot be null.

Parameters:
X - given matrix of inputs.
Y - matrix to hold results.

quickCompute

void quickCompute(double[] x,
                  double[] y)
Abstract method that all subclasses must implement. This is the core compute method that takes an input double array and returns an output double array.

Parameters:
x - input array.
y - output array.

quickCompute

void quickCompute(cern.colt.matrix.DoubleMatrix2D X,
                  cern.colt.matrix.DoubleMatrix2D Y)
Applies compute(double[]) on a set of inputs, supplied row-wise in a matrix. Stores the result in the supplied output array. No size-checking is performed.

Parameters:
X - input matrix.
Y - output matrix.

init

void init()
Init method.