SOT: sot::Surrogate Class Reference

SOT

Abstract class for a SOT surrogate model. More...

#include <surrogate.h>

Inheritance diagram for sot::Surrogate:

Public Member Functions
virtual int	numPoints () const =0
	Method for getting the current number of points. More...

virtual int	dim () const =0
	Method for getting the number of dimensions. More...

virtual void	reset ()=0
	Method for resetting the surrogate model.

virtual mat	X () const =0
	Method for getting the current points. More...

virtual vec	X (int i) const =0
	Method for getting current point number i (0 is the first) More...

virtual vec	fX () const =0
	Method for getting the values of the current points. More...

virtual double	fX (int i) const =0
	Method for getting the value of current point number i (0 is the first) More...

virtual void	addPoint (const vec &point, double funVal)=0
	Method for adding a point with a known value. More...

virtual void	addPoints (const mat &points, const vec &funVals)=0
	Method for adding multiple points with known values. More...

virtual double	eval (const vec &point) const =0
	Method for evaluating the surrogate model at a point. More...

virtual double	eval (const vec &point, const vec &dists) const =0
	Method for evaluating the surrogate at multiple points. More...

virtual vec	evals (const mat &points) const =0
	Method for evaluating the surrogate at multiple points. More...

virtual vec	evals (const mat &points, const mat &dists) const =0
	Method for evaluating the surrogate at multiple points. More...

virtual vec	deriv (const vec &point) const =0
	Method for evaluating the derivative of the surrogate model at a point. More...

virtual void	fit ()=0
	Method for fitting the surrogate model.

Detailed Description

Abstract class for a SOT surrogate model.

This is the abstract class that should be used as a Base class for all surrogate models in SOT.

Author: David Eriksson, dme65.nosp@m.@cor.nosp@m.nell..nosp@m.edu

Member Function Documentation

virtual void sot::Surrogate::addPoint	(	const vec &	point,
		double	funVal
	)

pure virtual

Method for adding a point with a known value.

Parameters

point	Point to be added
funVal	Function value at point

Implemented in sot::RBFInterpolant< RBFKernel, PolyTail >, sot::Shepard, and sot::kNN.

virtual void sot::Surrogate::addPoints	(	const mat &	points,
		const vec &	funVals
	)

pure virtual

Method for adding multiple points with known values.

Parameters

points	Points to be added
funVals	Function values at the points

Implemented in sot::RBFInterpolant< RBFKernel, PolyTail >, sot::Shepard, and sot::kNN.

virtual vec sot::Surrogate::deriv ( const vec & point ) const

pure virtual

Method for evaluating the derivative of the surrogate model at a point.

Parameters

point Point for which to evaluate the surrogate model

Returns: Value of the derivative of the surrogate model at the points

Implemented in sot::RBFInterpolant< RBFKernel, PolyTail >, sot::Shepard, and sot::kNN.

virtual int sot::Surrogate::dim ( ) const

pure virtual

Method for getting the number of dimensions.

Returns: Number of dimensions

Implemented in sot::RBFInterpolant< RBFKernel, PolyTail >, sot::Shepard, and sot::kNN.

virtual double sot::Surrogate::eval ( const vec & point ) const

pure virtual

Method for evaluating the surrogate model at a point.

Parameters

point Point for which to evaluate the surrogate

Returns: Value of the surrogate model at the point

Implemented in sot::RBFInterpolant< RBFKernel, PolyTail >, sot::Shepard, and sot::kNN.

virtual double sot::Surrogate::eval	(	const vec &	point,
		const vec &	dists
	)		const

pure virtual

Method for evaluating the surrogate at multiple points.

Parameters

point	Points for which to evaluate the surrogate model
dists	Distances between the interpolation nodes and point

Returns: Values of the surrogate model at the points

Implemented in sot::RBFInterpolant< RBFKernel, PolyTail >, sot::Shepard, and sot::kNN.

virtual vec sot::Surrogate::evals ( const mat & points ) const

pure virtual

Method for evaluating the surrogate at multiple points.

Parameters

points Points for which to evaluate the surrogate model

Returns: Values of the surrogate model at the points

Implemented in sot::RBFInterpolant< RBFKernel, PolyTail >, sot::Shepard, and sot::kNN.

virtual vec sot::Surrogate::evals	(	const mat &	points,
		const mat &	dists
	)		const

pure virtual

Method for evaluating the surrogate at multiple points.

Parameters

points	Points for which to evaluate the surrogate model
dists	Distances between the interpolation nodes and the points

Returns: Values of the surrogate model at the points

Implemented in sot::RBFInterpolant< RBFKernel, PolyTail >, sot::Shepard, and sot::kNN.

virtual vec sot::Surrogate::fX ( ) const

pure virtual

Method for getting the values of the current points.

Returns: Values of current points

Implemented in sot::RBFInterpolant< RBFKernel, PolyTail >, sot::Shepard, and sot::kNN.

virtual double sot::Surrogate::fX ( int i ) const

pure virtual

Method for getting the value of current point number i (0 is the first)

Returns: Value of point number i

Implemented in sot::RBFInterpolant< RBFKernel, PolyTail >, sot::kNN, and sot::Shepard.

virtual int sot::Surrogate::numPoints ( ) const

pure virtual

Method for getting the current number of points.

Returns: Current number of points

Implemented in sot::RBFInterpolant< RBFKernel, PolyTail >, sot::Shepard, and sot::kNN.

virtual mat sot::Surrogate::X ( ) const

pure virtual

Method for getting the current points.

Returns: Current points

Implemented in sot::RBFInterpolant< RBFKernel, PolyTail >, sot::Shepard, and sot::kNN.

virtual vec sot::Surrogate::X ( int i ) const

pure virtual

Method for getting current point number i (0 is the first)

Returns: Point number i

Implemented in sot::RBFInterpolant< RBFKernel, PolyTail >, sot::kNN, and sot::Shepard.

The documentation for this class was generated from the following file:

include/sot_bits/surrogate.h