Uses of Interface
function.ScalarFunction

Packages that use ScalarFunction

caffeinterface	Provides classes to interface with CAFFE classes, and convert them to ScalarFunctions and VectorFunctions.
diviner	Provides functionality for measuring the level of promise of a design candidates.
function	Provides classes for scalar and vector-valued functions that operate on multi- dimensional double-valued data.
model	Provides classes that handle various kinds of approximation models, data fits, and so on.
problem	Provides classes to create, modify and use various kinds of optimization problems using objective functions and inequality constraints.

Uses of ScalarFunction in caffeinterface

Classes in caffeinterface that implement ScalarFunction

class

CaffeToScalarFunction Simplifies the use of CaffeClass for computation.

Uses of ScalarFunction in diviner

Subinterfaces of ScalarFunction in diviner

interface	BoundConstrainedDiviner Computes a figure of merit for sampling at some point, based on information obtained from an ApproxModel.
interface	InequalityConstrainedDiviner Diviner for inequality-constrained problems.

Classes in diviner that implement ScalarFunction

class	BasicBoundConstrainedDiviner Implements basic functionality for BoundConstrainedDiviner.
class	BasicInequalityConstrainedDiviner Basic diviner for inequality-constrained problems.
class	ConstrainedEIDiviner Constrained version of the EIDiviner.
class	ConstrainedImprovementDiviner ImprovementDiviner for constrained problems.
class	ConstrainedMultiMetricDiviner Multi-metric diviner for constrained problems.
class	EIDiviner Implements an expected improvement BoundConstrainedDiviner.
class	ImprovementDiviner Focuses on various ways of divining merit using the posterior distribution at a point and some computation of improvement.
class	MultiMetricDiviner Uses multiple figures of merit to compute 'goodness' of a point for sampling.
class	PIDiviner Implements a diviner based on probability of improvement.
class	RiskDiviner Another way of trading performance and risk: quantify the risk as the probability of not achieving a given performance.
class	RiskPerfTradeDiviner BoundConstrainedDiviner that returns mean - k*stdDev.

Uses of ScalarFunction in function

Subinterfaces of ScalarFunction in function

interface

ScalarDifferentiableFunction Provides methods for functions that have a derivative.

Classes in function that implement ScalarFunction

class	BasicDifferentiableScalarFunction A BasicScalarFunction that contains another function, the gradient of the original function.
class	BasicScalarFunction Abstract class to implement most of the functionality of the ScalarFunction interface.
class	Hartman3
class	Hartman3LoFi
class	Hartman6 Hartman6 function, as defined by Dixon and Szego.
class	Hartman6LoFi A fake "lo-fi" version of Hartman6 with a radially symmetric sinusoidal "error".
class	Rosenbrock Extended Rosenbrock function, defined for an even number of input dimensions.
class	RosenbrockLoFi Implements the Rosenbrock function minus one quadratic term.
class	Shekel10 Shekel10 function.
class	Shekel5 Shekel functions, as defined by Dixon and Szego.
class	Shekel7 Shekel7 function.
class	TestFunction1D A simple 1-D test function for making plots etc.
class	VariableDomainScalarFunction Abstract class for scalar functions with variable input dimensionality.
static class	WaveDragAxisymmetric.AreaRule Function for computing the wave-drag coefficient C_D_w of an axisymmetric body.
static class	WaveDragAxisymmetric.CART3D
static class	WaveDragAxisymmetric.MaxRadiusConstraint Computes the constraint violation for the max-radius case.
static class	WaveDragAxisymmetric.MaxRadiusLoFi Uses a simplistic way to compute the radius constraint violations.
static class	WaveDragAxisymmetric.MaxVolumeConstraint Computes the volume constraint violation of a given body.
static class	WaveDragAxisymmetric.MaxVolumeLoFi
static class	WaveDragAxisymmetric.Panair Runs PANAIR to compute the wave drag of these axisymmetric bodies.
static class	WaveDragAxisymmetric.PanairShevell Extension of WaveDragAxisymmetric.Panair to run on shevell.
class	Woods Woods function, as defined by Dixon and Szego.
class	WoodsLoFi Lo-fi version of Woods problem, with a sinusoidal offset function added.

Methods in function that return ScalarFunction

static ScalarFunction	FunctionFactory.getInstance(java.lang.String name) Creates an instance of the requested function.
static ScalarFunction	FunctionFactory.getInstance(java.lang.String name, java.lang.Integer inputDimension) Returns an instance of the requested function in the given number of dimensions.
static ScalarFunction	WaveDragAxisymmetric.makeMaxRadiusConstraint(double mach, double length, double nominalRadius, WaveDragAxisymmetric.FIDELITY fidelity) Constructs a max-radius constraint.
static ScalarFunction	WaveDragAxisymmetric.makeObjective(double mach, double length, double nominalRadius, WaveDragAxisymmetric.FIDELITY fidelity, boolean shevellFlag) Returns a ScalarFunction that is the low-fidelity computation of the wave drag for axisymmetric bodies of the given length flying at the given Mach number.
static ScalarFunction	WaveDragAxisymmetric.makeVolumeConstraint(double mach, double length, double maxVolume, WaveDragAxisymmetric.FIDELITY fidelity) Constructs a volume constraint function.

Methods in function that return types with arguments of type ScalarFunction

java.util.ArrayList<ScalarFunction>

VectorFunctionBuilder.getScalarFunctions() Returns the scalarFunctions.

Method parameters in function with type arguments of type ScalarFunction

void	VectorFunctionBuilder.setScalarFunctions(java.util.ArrayList<ScalarFunction> scalarFunctions) Sets the scalarFunctions.

Uses of ScalarFunction in model

Subinterfaces of ScalarFunction in model

interface	ApproxModel Extends the DataFit interface by supporting methods that compute the uncertainty at a point in addition to a value.
interface	DataFit A DataFit is a ScalarFunction that also provides the VariableInputDimension and VariableBounds interfaces, thereby allowing its DEFAULT_BOUNDS and dimensionality to be modified.
interface	TwoFidelityApproxModel Fits an approximate model to the difference between given data and a low-order approximation of the oracle that generated that data.

Classes in model that implement ScalarFunction

class	BasicApproxModel Basic implementation of the methods in ApproxModel.
class	BasicTwoFidelityModel Basic two-fidelity approximation model, using an additive surrogate correction.
class	GPRegression Creation process: Set tau (compulsory), set prior mean and covariance, set bounds, init().
class	PenaltyFunctionModel Computes mean and variance for an external penalty function augmented Lagrangian.

Methods in model that return ScalarFunction

ScalarFunction	TwoFidelityApproxModel.getLoFiFunction() Returns the low-fidelity approximation used by this ApproxModel.
ScalarFunction	BasicTwoFidelityModel.getLoFiFunction()
ScalarFunction	BasicTwoFidelityModel.getUncertaintyEstimator()
ScalarFunction	ApproxModel.getUncertaintyEstimator()
ScalarFunction	BasicApproxModel.getUncertaintyEstimator() Returns the uncertaintyEstimator.
protected ScalarFunction	PenaltyFunctionModel.makeUncertaintyEstimator()
protected abstract ScalarFunction	BasicApproxModel.makeUncertaintyEstimator()
protected ScalarFunction	GPRegression.makeUncertaintyEstimator()

Methods in model with parameters of type ScalarFunction

void	TwoFidelityApproxModel.setLoFiFunction(ScalarFunction function) Sets the low-fidelity approximation to be used.
void	BasicTwoFidelityModel.setLoFiFunction(ScalarFunction function)
void	BasicApproxModel.setUncertaintyEstimator(ScalarFunction uncertaintyEstimator) Sets the uncertaintyEstimator.

Uses of ScalarFunction in problem

Methods in problem that return ScalarFunction

ScalarFunction	BasicOptimizationProblem.getObjective()
ScalarFunction	BasicMultiObjectiveProblem.getObjective() NOTE! Returns null! In contrast, @see problem.BasicOptimizationProblem#getObjective()
ScalarFunction	VectorFunctionToProblem.getObjective()
ScalarFunction	OptimizationProblem.getObjective() Returns the objective for this problem, which is a ScalarFunction.

Methods in problem that return types with arguments of type ScalarFunction

java.util.ArrayList<ScalarFunction>	InequalityConstrainedProblem.getConstraints() Returns the list of constraints as an ArrayList.
java.util.ArrayList<ScalarFunction>	BasicInequalityConstrainedProblem.getConstraints()

Methods in problem with parameters of type ScalarFunction

boolean	InequalityConstrainedProblem.addInequalityConstraint(ScalarFunction con) Adds the given ScalarFunction as an inequality constraint.
boolean	VectorFunctionToProblem.addInequalityConstraint(ScalarFunction con)
boolean	BasicInequalityConstrainedProblem.addInequalityConstraint(ScalarFunction con)
boolean	InequalityConstrainedProblem.removeInequalityConstraint(ScalarFunction con) Removes the given ScalarFunction from the list of constraints.
boolean	VectorFunctionToProblem.removeInequalityConstraint(ScalarFunction con)
boolean	BasicInequalityConstrainedProblem.removeInequalityConstraint(ScalarFunction con)
void	BasicOptimizationProblem.setObjective(ScalarFunction obj)
void	BasicMultiObjectiveProblem.setObjective(ScalarFunction obj)
void	VectorFunctionToProblem.setObjective(ScalarFunction obj) NOTE: Does nothing! In contrast, @see problem.BasicOptimizationProblem#setObjective(function.ScalarFunction)
void	OptimizationProblem.setObjective(ScalarFunction obj) Sets the objective for this problem..

Constructors in problem with parameters of type ScalarFunction

BasicBoundConstrainedProblem(ScalarFunction objective)
Constructs a BasicBoundConstrainedProblem using the given objective.

BasicBoundConstrainedProblem(ScalarFunction objective, Hypercube bounds)
Constructs a BasicBoundConstrainedProblem using the given objective function and the given bounds.