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

Optimizes the points generated by the ProjectedDistanceGridCandidateGenerator towards a particular criterion. More...

Inheritance diagram for ProjectedDistanceGridOptimizer:
Inheritance graph
[legend]

Public Member Functions

function ProjectedDistanceGridOptimizer (var varargin)
 Class constructor. More...
 
function optimize (var arg)
 This function optimizes the given function handle. More...
 
function getPopulationSize ()
 Get the number of individuals in the population. More...
 
function setInputConstraints (var con)
 Does nothing at all. More...
 
function getBounds ()
 Returns bounds for optimizers that need it. More...
 
function setBounds (var LB, var UB)
 Sets bounds for optimizers that need it. More...
 
function getInitialPopulation ()
 Gets the starting positions for the search. More...
 
function setInitialPopulation (var pop)
 Sets the starting positions for the search. More...
 
function getInputDimension ()
 Returns the number of input variables. More...
 
function getOutputDimension ()
 Returns the number of cost functions. More...
 
function setDimensions (var inDim, var outDim)
 Sets the number of input and output dimensions. More...
 
function setHint (var key, var value)
 Gives a hint to the optimizer. More...
 
function getHint (var key)
 Gets a hint to the optimizer. More...
 
function setState (var state)
 Sets some extra information. More...
 
function getState ()
 Gets some extra information. More...
 

Detailed Description

Optimizes the points generated by the ProjectedDistanceGridCandidateGenerator towards a particular criterion.

Respects all constraints and uses pattern search to locally optimize towards the criterion, without violating the projected distance grid restrictions.

Constructor & Destructor Documentation

function ProjectedDistanceGridOptimizer ( var  varargin)
inline

Class constructor.

Returns
instance of the class

Member Function Documentation

function getBounds ( )
inherited

Returns bounds for optimizers that need it.

Only needed for optimization methods that support it.

Return values
LBlower bound
UBupper bound
function getHint ( var  key)
inherited

Gets a hint to the optimizer.

Returns a particular hint setting.

Parameters
keyproperty name
Return values
valueproperty value
function getInitialPopulation ( )
inherited

Gets the starting positions for the search.

pop may be a matrix for population-based, multi-start, etc. methods

Return values
startxmatrix of initial values
function getInputDimension ( )
inherited

Returns the number of input variables.

Return values
nvarsNumber of input variables
function getOutputDimension ( )
inherited

Returns the number of cost functions.

Returns the number of output variables.

Return values
nobjectivesNumber of cost functions
function getPopulationSize ( )

Get the number of individuals in the population.

function getState ( )
inlineinherited

Gets some extra information.

Return values
statestructure
function optimize ( var  arg)

This function optimizes the given function handle.

function setBounds ( var  LB,
var  UB 
)
inherited

Sets bounds for optimizers that need it.

Only needed for optimization methods that support it.

Parameters
LBlower bound
UBupper bound
function setDimensions ( var  inDim,
var  outDim 
)
inherited

Sets the number of input and output dimensions.

Includes some input checking to ensure that the bounds and the initial population are still correct.

Parameters
inDimNumber of input variables
outDimNumber of cost functions

If not, these variables are reset to their default values without warning!

function setHint ( var  key,
var  value 
)
inherited

Gives a hint to the optimizer.

Sets a hint that may or not be honored by the optimizer (depends on the type...).

Parameters
keyproperty name
valueproperty value

Only supports 'maxTime', time atm.

function setInitialPopulation ( var  pop)
inherited

Sets the starting positions for the search.

Sets the initial population.

Parameters
popmatrix of initial values
function setInputConstraints ( var  con)

Does nothing at all.

function setState ( var  state)
inlineinherited

Sets some extra information.

Parameters
statestructure

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