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

Base class for all model factories. More...

Inheritance diagram for ModelFactory:
Inheritance graph
[legend]

Public Member Functions

function ModelFactory (var ip, var varargin)
 Class constructor. More...
 
function setSamples (var samples, var values)
 TODO. More...
 
function getSamples ()
 TODO. More...
 
function getDimensions ()
 TODO. More...
 
function createRandomModel ()
 TODO. More...
 
function getObservables ()
 TODO. More...
 
function getParallelMode ()
 TODO. More...
 
function getMode ()
 TODO. More...
 
function createInitialModels (var number, var wantModels)
 Generate 'number' models. More...
 
function getBounds ()
 Return the lower bounds and upper bounds (each a row vector) for each model parameter. More...
 
function createModel (var parameters)
 Create a model object represented by the given parameters. More...
 
function supportsComplexData ()
 Return true if this factory can generate models that can work on complex data directly. More...
 
function supportsMultipleOutputs ()
 Return true if this factory can generate models with multiple outputs. More...
 

Detailed Description

Base class for all model factories.

Constructor & Destructor Documentation

function ModelFactory ( var  ip,
var  varargin 
)
inline

Class constructor.

Returns
instance of the class

Member Function Documentation

function createInitialModels ( var  number,
var  wantModels 
)
inline

Generate 'number' models.

if wantModels=true they should be model objects, else a matrix should be returned with each row containing the parameters of one model This method should internally use createModel(..) where possible.

function createModel ( var  parameters)

Create a model object represented by the given parameters.

The following calling signatures should be supported:

  • no parameters are passed: return a default model as defined by the config
  • parameters is a double vector: return a model with the hyperparameters set to the passed values
  • parameters is a model object: do nothing, simply return the passed object
function createRandomModel ( )
inline

TODO.

function getBounds ( )
inline

Return the lower bounds and upper bounds (each a row vector) for each model parameter.

function getDimensions ( )
inline

TODO.

function getMode ( )
inline

TODO.

function getObservables ( )
inline

TODO.

function getParallelMode ( )
inline

TODO.

function getSamples ( )
inline

TODO.

function setSamples ( var  samples,
var  values 
)
inline

TODO.

function supportsComplexData ( )

Return true if this factory can generate models that can work on complex data directly.

function supportsMultipleOutputs ( )

Return true if this factory can generate models with multiple outputs.


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