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

The model interface provides the set of abstract functions that must be supported by any model, be it real or wrapper. More...

Inheritance diagram for ModelInterface:
Inheritance graph
[legend]

Public Member Functions

function plotModel ()
 Generates a plot of the model. More...
 
function complexity ()
 Returns the complexity of the model. More...
 
function getDimensions ()
 Returns the input and output dimension. More...
 
function getExpression (var outputIndex)
 Returns a symbolic expression of the model in simulator space. More...
 
function getExpressionInModelSpace (var outputIndex)
 Returns a symbolic expression of the model in sumo space. More...
 
function getId ()
 An internal id of the model. More...
 
function getGrid ()
 Return a sample grid with their associated values. More...
 
function equals (var m, var threshold)
 A grid based equality method. More...
 
function evaluate (var points)
 Evaluates the model in simulator space. More...
 
function evaluateInModelSpace (var points)
 Evaluates the model in simulator space. More...
 
function evaluateDerivative (var points, var outputIndex)
 Evaluates the derivatives of the model in simulator space. More...
 
function evaluateDerivativeInModelSpace (var points, var outputIndex)
 Evaluates the derivatives of the model in sumo space. More...
 
function getTransformationFunctions ()
 Returns function handles to the transformation functions. More...
 
function getMeasureScores ()
 Returns measure information. More...
 
function getSamples ()
 Returns the sample matrix in simulator space. More...
 
function getSamplesInModelSpace ()
 Returns the sample matrix in sumo space. More...
 
function getValues ()
 Returns the values matrix (always in simulator space). More...
 
function getBounds ()
 Returns the input bounds. More...
 
function getScore ()
 Returns the measure score. More...
 
function getInputNames ()
 Returns the names of the input variables. More...
 
function getOutputNames ()
 Returns the names of the output variables. More...
 
function constructInModelSpace (var samples, var values)
 Fits the model using data in sumo space. More...
 
function getDescription ()
 Returns a description of this model. More...
 

Detailed Description

The model interface provides the set of abstract functions that must be supported by any model, be it real or wrapper.

Member Function Documentation

function complexity ( )

Returns the complexity of the model.

function constructInModelSpace ( var  samples,
var  values 
)

Fits the model using data in sumo space.

function equals ( var  m,
var  threshold 
)

A grid based equality method.

Returns true if the mean relative error is <= threshold

Parameters
msumo Model
thresholdthreshold to determine when models are equal
function evaluate ( var  points)

Evaluates the model in simulator space.

Parameters
pointsinput sample matrix
function evaluateDerivative ( var  points,
var  outputIndex 
)

Evaluates the derivatives of the model in simulator space.

Parameters
pointsinput sample matrix
outputIndexfor which output to generate the expression (1,2,etc.)
function evaluateDerivativeInModelSpace ( var  points,
var  outputIndex 
)

Evaluates the derivatives of the model in sumo space.

Parameters
pointsinput sample matrix
outputIndexfor which output to generate the expression (1,2,etc.)
function evaluateInModelSpace ( var  points)

Evaluates the model in simulator space.

Parameters
pointsinput sample matrix
function getBounds ( )

Returns the input bounds.

function getDescription ( )

Returns a description of this model.

function getDimensions ( )

Returns the input and output dimension.

function getExpression ( var  outputIndex)

Returns a symbolic expression of the model in simulator space.

Parameters
outputIndexfor which output to generate the expression (1,2,etc.)
function getExpressionInModelSpace ( var  outputIndex)

Returns a symbolic expression of the model in sumo space.

Parameters
outputIndexfor which output to generate the expression (1,2,etc.)
function getGrid ( )

Return a sample grid with their associated values.

function getId ( )

An internal id of the model.

function getInputNames ( )

Returns the names of the input variables.

function getMeasureScores ( )

Returns measure information.

function getOutputNames ( )

Returns the names of the output variables.

function getSamples ( )

Returns the sample matrix in simulator space.

function getSamplesInModelSpace ( )

Returns the sample matrix in sumo space.

function getScore ( )

Returns the measure score.

function getTransformationFunctions ( )

Returns function handles to the transformation functions.

function getValues ( )

Returns the values matrix (always in simulator space).

function plotModel ( )

Generates a plot of the model.


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