The SUMO toolbox  2018a
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Pages
Public Member Functions | List of all members
WrappedModel Class Reference

This model is a wrapper around another model. More...

Inheritance diagram for WrappedModel:
Inheritance graph
[legend]

Public Member Functions

function WrappedModel (var varargin)
 
function getNestedModel ()
 Return the model that is wrapped. More...
 
function plotModel ()
 Forwarded to nested model. More...
 
function complexity ()
 Returns the number of free variables in the model. More...
 
function getDimensions ()
 Return the input and output dimensions of the model. More...
 
function getExpression (var outputIndex)
 Wrapper method. More...
 
function getExpressionInModelSpace (var outputIndex)
 Wrapper method. More...
 
function getId ()
 Returns the id of this model. More...
 
function getGrid ()
 Returns a set of samples evaluated on a dense grid to be used for evaluation of the model. More...
 
function equals (var m, var threshold)
 Simply call the base class method. More...
 
function evaluate (var points)
 Evaluation at a set of points. More...
 
function evaluateInModelSpace (var points)
 Evaluation at a set of points. More...
 
function evaluateDerivative (var points, var outputIndex)
 Approximate the derivative at the given points in simulator space. More...
 
function evaluateDerivativeInModelSpace (var points, var outputIndex)
 Approximate the derivative at the given points in model space. More...
 
function getTransformationFunctions ()
 Get the simulator to model and model to simulator transformation functions for this model. More...
 
function getMeasureScores ()
 Gets score of this model. More...
 
function getTransformationValues ()
 
function getSamples ()
 Returns the set of samples on which this model was built. More...
 
function getSamplesInModelSpace ()
 Returns the set of samples on which this model was built (in model space! so in [-1 1]) More...
 
function getValues ()
 Returns the set of values in the samples on which this model was built. More...
 
function getBounds ()
 
function getScore ()
 Return the global score of the model. More...
 
function getInputNames ()
 Returns the input names. More...
 
function getOutputNames ()
 Returns the output names. More...
 
function constructInModelSpace (var samples, var values)
 Call construct on the nested model. More...
 
function getType ()
 Return the type of the nested model. More...
 
function saveobj ()
 Called whenever a wrapped model is saved to disk, make sure we remove the wrapper. More...
 
function getDescription ()
 Returns the description of the nested model. More...
 
function updateInModelSpace (var samples, var values)
 
function update (var samples, var values)
 

Detailed Description

This model is a wrapper around another model.

It does not offer any additional functionality, but it allows the user to combine models of different types in the same matrix/array.

Constructor & Destructor Documentation

function WrappedModel ( var  varargin)
inline

Member Function Documentation

function complexity ( )

Returns the number of free variables in the model.

function constructInModelSpace ( var  samples,
var  values 
)

Call construct on the nested model.

function equals ( var  m,
var  threshold 
)

Simply call the base class method.

function evaluate ( var  points)

Evaluation at a set of points.

function evaluateDerivative ( var  points,
var  outputIndex 
)

Approximate the derivative at the given points in simulator space.

function evaluateDerivativeInModelSpace ( var  points,
var  outputIndex 
)

Approximate the derivative at the given points in model space.

function evaluateInModelSpace ( var  points)

Evaluation at a set of points.

function getBounds ( )
inline
function getDescription ( )

Returns the description of the nested model.

function getDimensions ( )

Return the input and output dimensions of the model.

function getExpression ( var  outputIndex)

Wrapper method.

function getExpressionInModelSpace ( var  outputIndex)

Wrapper method.

function getGrid ( )

Returns a set of samples evaluated on a dense grid to be used for evaluation of the model.

Recycles previously evaluated grids.

function getId ( )

Returns the id of this model.

Id's are defined in the construct function, so that a model that is reconstructed gets a new unique id.

function getInputNames ( )

Returns the input names.

function getMeasureScores ( )

Gets score of this model.

function getNestedModel ( )
inline

Return the model that is wrapped.

function getOutputNames ( )

Returns the output names.

function getSamples ( )

Returns the set of samples on which this model was built.

function getSamplesInModelSpace ( )

Returns the set of samples on which this model was built (in model space! so in [-1 1])

function getScore ( )

Return the global score of the model.

function getTransformationFunctions ( )

Get the simulator to model and model to simulator transformation functions for this model.

function getTransformationValues ( )
inline
function getType ( )

Return the type of the nested model.

function getValues ( )

Returns the set of values in the samples on which this model was built.

function plotModel ( )

Forwarded to nested model.

function saveobj ( )

Called whenever a wrapped model is saved to disk, make sure we remove the wrapper.

function update ( var  samples,
var  values 
)
inline
function updateInModelSpace ( var  samples,
var  values 
)
inline

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