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

Wrapper allowing usage of several optimizer together. More...

Inheritance diagram for CombiOptimizer:
Inheritance graph
[legend]

Public Member Functions

function CombiOptimizer (var varargin)
 Class constructor. More...
 
function optimize (var arg)
 This function optimizes the given function handle. More...
 
function getPopulationSize ()
 Returns the popSize (maximal population size of all children) More...
 
function setBounds (var LB, var UB)
 Sets bounds for optimizers that need it. More...
 
function setHint (var key, var value)
 Sets a hint that may or not be honored by the child-optimizers (depends on the type...). More...
 
function setInputConstraints (var con)
 The combioptimizer pushes constraints to its child-optimizers. More...
 
function setInitialPopulation (var pop)
 Sets the initial population. More...
 
function setDimensions (var inDim, var outDim)
 Pushes new dimensions to sub-optimizers. More...
 
function getBounds ()
 Returns bounds for optimizers that need it. More...
 
function getInitialPopulation ()
 Gets 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 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

Wrapper allowing usage of several optimizer together.

Constructor & Destructor Documentation

function CombiOptimizer ( 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 ( )

Returns the popSize (maximal population size of all children)

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 
)
inline

Sets bounds for optimizers that need it.

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

Pushes new dimensions to sub-optimizers.

function setHint ( var  key,
var  value 
)
inline

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

Only supports 'maxTime', time atm.

function setInitialPopulation ( var  pop)
inline

Sets the initial population.

Does subsample the population in case of conflict with optimizers with smaller populations.

function setInputConstraints ( var  con)
inline

The combioptimizer pushes constraints to its child-optimizers.

If any of them does not support constraints, this will fail.

function setState ( var  state)
inlineinherited

Sets some extra information.

Parameters
statestructure

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