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

Implementation of a linear constraint. More...

Inheritance diagram for LinearConstraint:
Inheritance graph
[legend]

Public Member Functions

function LinearConstraint (var config)
 Class constructor. More...
 
function evaluateInModelSpace (var x)
 Process the constraint for some points. More...
 
function getInternal ()
 Gets internal representation of the constraint. More...
 
function initNewSamples (var state)
 Called when the number of samples changes. More...
 
function setTransformationFunctions (var inFunc, var outFunc)
 Sets transformation functions. More...
 
function satisfy (var x)
 Checks if the constraint is satisfied. More...
 
function preEvaluation (var samples)
 runs samples through the SampleManager constraint. More...
 
function evaluate (var x)
 Evaluates a constraint. More...
 

Detailed Description

Implementation of a linear constraint.

Constructor & Destructor Documentation

function LinearConstraint ( var  config)
inline

Class constructor.

Parameters
configNodeConfig object
Returns
Instance of the LinearConstraint class

Member Function Documentation

function evaluate ( var  x)
inlineinherited

Evaluates a constraint.

Calls preEvaluation and then process of the derived constraint

Parameters
xinput point
Return values
yconstraint value
Todo:
remove preEvaluation if transformation func's work properly
Todo:
transformation functions don't handle input selection, dummy, default values, etc...
function evaluateInModelSpace ( var  x)
inline

Process the constraint for some points.

n dimension, m observations m*n, 1*n (x1 ... xn) * (a1 ... an)' (. ... .) (x1 ... xn)

Parameters
xinput point
Return values
yconstraint value
function getInternal ( )
inline

Gets internal representation of the constraint.

Return values
AineqLeft side of the inequality equation(s)
Bineqright side of the inequality equation(s)
function initNewSamples ( var  state)
inlineinherited

Called when the number of samples changes.

Todo:
copied from CandidateRanker, should be more general (just init(state))
function preEvaluation ( var  samples)
inlineinherited

runs samples through the SampleManager constraint.

  • model space -> simulator space
  • input select
  • dummy values
  • ...
Parameters
samplessample matrix
Return values
newSamplesprocessed sample matrix
newIdsprocessed sample id's
function satisfy ( var  x)
inlineinherited

Checks if the constraint is satisfied.

Overrided by subclasses

Parameters
xinput point
Return values
yesboolean
function setTransformationFunctions ( var  inFunc,
var  outFunc 
)
inlineinherited

Sets transformation functions.

These are transformation functions are executed before evaluating the constraints. It's main (only) use at the moment is for simulator constraints in simulator.xml


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