Diana  0.8.3
Public Member Functions | Protected Member Functions | Protected Attributes
DianaOEDTask Class Reference

#include <DianaOEDTask.hpp>

Inheritance diagram for DianaOEDTask:
DianaNLPTask ICapeNLPTask ICapeUtilities ICapeIdentification

List of all members.

Public Member Functions

 DianaOEDTask (Numeric::Solvers::NLPTasks::DianaParameterFittingTask *pParFitTask, Numeric::Solvers::Solver::ICapeNumericNLPSolver *pOptimizer, const Common::Parameter::CapeArrayParameterSpec &colDesignVars) throw (Common::Error::ECapeUnknown)
 ~DianaOEDTask ()
virtual Common::Types::CapeDouble CalcObjFunction () throw (Common::Error::ECapeUnknown, Common::Error::ECapeSolvingError)
virtual void Initialize () throw (Common::Error::ECapeUnknown, Common::Error::ECapeFailedInitialisation, Common::Error::ECapeOutOfResources, Common::Error::ECapeLicenceError, Common::Error::ECapeBadInvOrder)
void SetOptimalityCriterion (Numeric::Solvers::NLPTasks::ICapeNLPFunction *func) throw (Common::Error::ECapeUnknown)
const
Common::Types::CapeArrayDouble
GetParametersBiasEstimate () const throw (Common::Error::ECapeUnknown)
const Diana::DianaArrayGetCovarianceMatrixEstimate () const throw (Common::Error::ECapeUnknown)
Numeric::Solvers::NLPTasks::DianaParameterFittingTaskGetParameterFttingTask () throw (Common::Error::ECapeUnknown)
Numeric::Solvers::Solver::ICapeNumericSolverGetPFOptimizer () throw (Common::Error::ECapeUnknown)
Numeric::Solvers::NLPTasks::ICapeNLPFunctionGetOptimalityCriterion () throw (Common::Error::ECapeUnknown)
Common::Collection::ICapeCollectionGetDesignVariables () throw (Common::Error::ECapeUnknown, Common::Error::ECapeFailedInitialisation, Common::Error::ECapeNoImpl)
Common::Collection::ICapeCollectionGetEstimatedParameters () throw (Common::Error::ECapeUnknown, Common::Error::ECapeFailedInitialisation, Common::Error::ECapeNoImpl)

Protected Member Functions

virtual Common::Types::CapeDouble EvaluateObjFunction ()=0 throw (Common::Error::ECapeUnknown, Common::Error::ECapeSolvingError)

Protected Attributes

Numeric::Solvers::NLPTasks::DianaParameterFittingTaskpParFitTask
 Parameter fitting task for currently explored experiment.
Numeric::Solvers::Solver::ICapeNumericNLPSolverpParFitOptimizer
 Optimizer for parameter fitting task.
OEDOptimalityCriterionpOptCriterion
 Optimality criterion function (e.g. D-optimality, E-optimality, user defined etc)
OEDOptimalityCriterionType eOptimalityCriterionType
 Type of optimality criterion.
Diana::DianaCollection collDesignVars
 Collection of design variables.
Diana::DianaCollection collEstimatedPars
 Collection of estimated parameters for optimal design.
Common::Types::CapeBoolean bInitialized
 Flag, indicates that optimizer is initialised.
Diana::DianaArray daCovMatrix
 Estimate of covariance matrix.
Common::Types::CapeArrayDouble arrBias
 Estimate of of parameters' bias.

Detailed Description

Base class for optimal experimental design tasks.

Parameters:
pParFitTask- parameter fitting task for currently explored experiment
pOptimizer- optimizer for solving parameter fitting task
colDesignVars- estimated design variables collection with names, bounds and precision.

Constructor & Destructor Documentation

Constructor.

Destructor.


Member Function Documentation

Calculates and returns objective function value for optimization task.

Implements ICapeNLPTask.

Calculates and returns objective function value for optimization task.

Returns covariance matrix estimate.

Returns an ICapeCollection interface. This method allows any client to access all the Cape Open Parameters that represents design variables.

References DianaOEDTask::collDesignVars.

Returns an ICapeCollection interface. This method allows any client to access all the Cape Open Parameters that represents estimated parameters for optimal design.

References DianaOEDTask::collEstimatedPars.

Returns function that represents optimality criterion.

Returns parameter fitting task for currently explored experiment.

Returns estimate of parameters' bias.

Returns optimizer for solving parameter fitting task.

The environment will order the component to get initialized through this method. Any initialisation that could fail must be placed here. Initialize is guaranteed to be the first method called by the client (except low level methods such as class constructors or initialization persistence methods). Initialize has to be called once when the component is instantiated in a particular flowsheet. When the initialization fails, before signalling an error, the component must free all the resources that were allocated before the failure occurred. When the environment receives this error, it may not use the component anymore. The method terminate of the current interface must not either be called. Hence, the environment may only release the component through the middleware native mechanisms.

Reimplemented from DianaNLPTask.

Sets optimality criterion. By default A-optimality criterion is used.

Parameters:
funcpointer on optimality criterion

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