rbmatlab  1.16.09
 All Classes Namespaces Files Functions Variables Modules Pages
List of all members | Public Member Functions | Public Attributes | Protected Attributes
ParameterSampling.Interface Class Referenceabstract

Detailed Description

Interface for parameter sampling classes producing discrete parameter sample in the parameter space \({\cal M}\).

Attention: An object must be initialized by init_sample() before it is fully functional. This can be checked by the init_required() method.

Definition at line 18 of file Interface.m.

Inheritance diagram for ParameterSampling.Interface:
Inheritance graph
[legend]
Collaboration diagram for ParameterSampling.Interface:
Collaboration graph
[legend]

Public Member Functions

virtual function  init_sample (IDetailedModel dmodel)
 initializes the parameter sampling object More...
 
virtual function size = size ()
 returns the number of parameter vectors in this sampling More...
 
function
please_init = 
init_required ()
 returns a boolean indicating whether the object is fully functional, or must be initialized by a call to init_sample(). More...
 

Public Attributes

 sample
 matrix storing the parameter vectors in the parameter samples as row vectors. More...
 

Protected Attributes

 init_done = false
 boolean indicating whether the object has already been initialized by a call of init_sample(). More...
 

Member Function Documentation

function please_init = ParameterSampling.Interface.init_required ( )

returns a boolean indicating whether the object is fully functional, or must be initialized by a call to init_sample().

Return values
please_initboolean indicating whether init_sample() needs to be executed.

Definition at line 83 of file Interface.m.

Here is the caller graph for this function:

function ParameterSampling.Interface.init_sample ( IDetailedModel  dmodel)
pure virtual

initializes the parameter sampling object

Parameters
dmodelobject specifying how the high dimensional data can be computed.

Implemented in ParameterSampling.Random, ParameterSampling.Uniform, and ParameterSampling.Single.

function size = ParameterSampling.Interface.size ( )
pure virtual

returns the number of parameter vectors in this sampling

Return values
sizesample size

Implemented in ParameterSampling.Uniform, ParameterSampling.Random, ParameterSampling.Prescribed, and ParameterSampling.Single.

Member Data Documentation

ParameterSampling.Interface.init_done = false
protected

boolean indicating whether the object has already been initialized by a call of init_sample().


Default: false

Definition at line 49 of file Interface.m.

ParameterSampling.Interface.sample

matrix storing the parameter vectors in the parameter samples as row vectors.

Note
This property has the MATLAB attribute Dependent set to true.
This property is an abstract property without implementation.
This property has non-standard access specifiers: SetAccess = Private, GetAccess = Public
Matlab documentation of property attributes.

Definition at line 33 of file Interface.m.


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