function
Interface Computable

All Known Subinterfaces:
ApproxModel, BoundConstrainedDiviner, DataFit, InequalityConstrainedDiviner, MultiObjectiveDiviner, ScalarDifferentiableFunction, ScalarFunction, TwoFidelityApproxModel, VectorFunction
All Known Implementing Classes:
ApproxModelToVectorFunction, BasicApproxModel, BasicBoundConstrainedDiviner, BasicDifferentiableScalarFunction, BasicInequalityConstrainedDiviner, BasicMultiObjectiveDiviner, BasicScalarFunction, BasicTwoFidelityModel, BasicVectorFunction, CaffeToScalarFunction, CaffeToVectorFunction, ConstrainedEIDiviner, ConstrainedImprovementDiviner, ConstrainedMultiMetricDiviner, EC6, EIDiviner, GPRegression, Hartman3, Hartman3LoFi, Hartman6, Hartman6LoFi, ImprovementDiviner, MultiMetricDiviner, PenaltyFunctionModel, PIDiviner, RiskDiviner, RiskPerfTradeDiviner, RiskPerfTypeIDiviner, RiskPerfTypeIIDiviner, RiskPerfTypeIIIDiviner, RiskPerfTypeIVDiviner, RiskPerfTypeVDiviner, Rosenbrock, RosenbrockLoFi, Shekel10, Shekel5, Shekel7, SupersonicWB, TestFunction1D, VariableDomainScalarFunction, VectorFunctionBuilder, WaveDragAxisymmetric.AreaRule, WaveDragAxisymmetric.CART3D, WaveDragAxisymmetric.MaxRadiusConstraint, WaveDragAxisymmetric.MaxRadiusLoFi, WaveDragAxisymmetric.MaxVolumeConstraint, WaveDragAxisymmetric.MaxVolumeLoFi, WaveDragAxisymmetric.Panair, WaveDragAxisymmetric.PanairShevell, Woods, WoodsLoFi, ZDT1, ZDT2, ZDT3, ZDTFunction

public interface Computable

The core interface of this package. Provides the compute(double[], double[]) method that takes in a double array and returns a double array.

Author:
dgorur

Method Summary
 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.
 void compute(double[] x, double[] y)
          Computes the outputs corresponding to the given input, and stores the result in the supplied array.
 Hypercube getBounds()
          Returns a Hypercube specifying the domain of this Computable.
 int getInputDimension()
          Returns the number of dimensions accepted by this Computable.
 int getOutputDimension()
          Returns the output dimension for this Computable.
 boolean isWithinBounds(double[] x)
          Returns true if the given point is within bounds.
 

Method Detail

compute

void compute(double[] x,
             double[] y)
Computes the outputs corresponding to the given input, and stores the result in the supplied array.

Parameters:
x - the given input.
y - array to hold the result.

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.

Parameters:
x - the given inputs.
y - array to hold the result.

getBounds

Hypercube getBounds()
Returns a Hypercube specifying the domain of this Computable.

Returns:
the domain of this ScalarFunction.

getInputDimension

int getInputDimension()
Returns the number of dimensions accepted by this Computable.

Returns:
the number of dimensions.

getOutputDimension

int getOutputDimension()
Returns the output dimension for this Computable.

Returns:
the number of output dimensions.

isWithinBounds

boolean isWithinBounds(double[] x)
Returns true if the given point is within bounds.

Parameters:
x - the given point.
Returns:
true if within bounds.