English Français

Documentation / Developer's manual

Available modules

Calibration,  DataServer,  Launcher,  MetaModelOptim,  Modeler,  Optimizer,  ReLauncher,  Reliability,  ReOptimizer,  Sampler,  Sensitivity,  UncertModeler,  XmlProblem,   Uranie / Optimizer: URANIE::Optimizer::TObjective Class Reference
Uranie / Optimizer v4.9.0
/* @license-end */
URANIE::Optimizer::TObjective Class Reference

Description of the class TObjective. This class computes the ojective (from L2 point of view). More...

#include <TObjective.h>

Inheritance diagram for URANIE::Optimizer::TObjective:
Collaboration diagram for URANIE::Optimizer::TObjective:

Public Types

enum  EOptimType { kFunction , kSumOfSquare }
 

Public Member Functions

Constructor and Destructor
 TObjective (TString name)
 Constructor by name only.
 
virtual ~TObjective ()
 Default destructor.
 
Value of the Objective
Double_t getObjective () const
 
Double_t getObjectiveWithoutWeight () const
 
virtual Double_t getObjective (Double_t *dvalues, Int_t nrow)
 
Bool_t isActive ()
 
void unActive ()
 
void active ()
 
void delShare ()
 
void addShare ()
 
int getShare ()
 
void setWeight (Double_t val)
 
Double_t getWeight ()
 
void setYStar (URANIE::DataServer::TDataServer *tds, TString ystar)
 
void setYHat (URANIE::Launcher::TOutputFile *outfile, TString yhat)
 
Printing Log
void setLog ()
 
void unsetLog ()
 
void changeLog ()
 
Bool_t getLog ()
 
virtual void printLog (Option_t *option="")
 

Public Attributes

Double_t _dweight
 Weight of the Objective function.
 
Double_t _dweightold
 The old Weight of the Objective function to save.
 
Double_t _dvalue
 Value of the Objective function.
 
Bool_t _blog
 Boolean to edit the log.
 
TString _syhat
 Name of yhat.
 
TString _systar
 Name of ystar.
 
int _nshare
 number of object accessing it
 
URANIE::DataServer::TDataServer * _tds
 Pointer of a TDS into YHat.
 
URANIE::Launcher::TOutputFile * _outfile
 Pointer of Output file of TCode into YHAT.
 

Detailed Description

Description of the class TObjective. This class computes the ojective (from L2 point of view).

To be written by the developper.

Member Enumeration Documentation

◆ EOptimType

Enumerator
kFunction 
kSumOfSquare 

Constructor & Destructor Documentation

◆ TObjective()

URANIE::Optimizer::TObjective::TObjective ( TString  name)

Constructor by name only.

Parameters
nameName of the objective

Referenced by ClassImp().

◆ ~TObjective()

virtual URANIE::Optimizer::TObjective::~TObjective ( )
virtual

Default destructor.

Referenced by ClassImp().

Member Function Documentation

◆ active()

void URANIE::Optimizer::TObjective::active ( )
inline

References _dweight, and _dweightold.

◆ addShare()

void URANIE::Optimizer::TObjective::addShare ( )
inline

References _nshare.

◆ changeLog()

void URANIE::Optimizer::TObjective::changeLog ( )
inline

References _blog.

◆ delShare()

void URANIE::Optimizer::TObjective::delShare ( )
inline

References _nshare.

◆ getLog()

Bool_t URANIE::Optimizer::TObjective::getLog ( )
inline

References _blog.

◆ getObjective() [1/2]

Double_t URANIE::Optimizer::TObjective::getObjective ( ) const
inline

References _dvalue, and _dweight.

Referenced by ClassImp(), ClassImp(), and ClassImp().

◆ getObjective() [2/2]

virtual Double_t URANIE::Optimizer::TObjective::getObjective ( Double_t *  dvalues,
Int_t  nrow 
)
virtual

◆ getObjectiveWithoutWeight()

Double_t URANIE::Optimizer::TObjective::getObjectiveWithoutWeight ( ) const
inline

References _dvalue.

◆ getShare()

int URANIE::Optimizer::TObjective::getShare ( )
inline

References _nshare.

◆ getWeight()

Double_t URANIE::Optimizer::TObjective::getWeight ( )
inline

References _dweight.

◆ isActive()

Bool_t URANIE::Optimizer::TObjective::isActive ( )
inline

References _dweight.

◆ printLog()

virtual void URANIE::Optimizer::TObjective::printLog ( Option_t *  option = "")
virtual

◆ setLog()

void URANIE::Optimizer::TObjective::setLog ( )
inline

References _blog.

◆ setWeight()

void URANIE::Optimizer::TObjective::setWeight ( Double_t  val)
inline

References _dweight, and _dweightold.

◆ setYHat()

void URANIE::Optimizer::TObjective::setYHat ( URANIE::Launcher::TOutputFile *  outfile,
TString  yhat 
)
inline

References _outfile, and _syhat.

◆ setYStar()

void URANIE::Optimizer::TObjective::setYStar ( URANIE::DataServer::TDataServer *  tds,
TString  ystar 
)
inline

◆ unActive()

void URANIE::Optimizer::TObjective::unActive ( )
inline

References _dweight.

◆ unsetLog()

void URANIE::Optimizer::TObjective::unsetLog ( )
inline

References _blog.

Member Data Documentation

◆ _blog

Bool_t URANIE::Optimizer::TObjective::_blog

Boolean to edit the log.

Referenced by changeLog(), ClassImp(), ClassImp(), ClassImp(), getLog(), setLog(), and unsetLog().

◆ _dvalue

Double_t URANIE::Optimizer::TObjective::_dvalue

Value of the Objective function.

Referenced by ClassImp(), ClassImp(), ClassImp(), getObjective(), and getObjectiveWithoutWeight().

◆ _dweight

Double_t URANIE::Optimizer::TObjective::_dweight

Weight of the Objective function.

Referenced by active(), ClassImp(), ClassImp(), ClassImp(), getObjective(), getWeight(), isActive(), setWeight(), and unActive().

◆ _dweightold

Double_t URANIE::Optimizer::TObjective::_dweightold

The old Weight of the Objective function to save.

Referenced by active(), ClassImp(), and setWeight().

◆ _nshare

int URANIE::Optimizer::TObjective::_nshare

number of object accessing it

Referenced by addShare(), delShare(), and getShare().

◆ _outfile

URANIE::Launcher::TOutputFile* URANIE::Optimizer::TObjective::_outfile

Pointer of Output file of TCode into YHAT.

Referenced by ClassImp(), and setYHat().

◆ _syhat

TString URANIE::Optimizer::TObjective::_syhat

Name of yhat.

Referenced by ClassImp(), and setYHat().

◆ _systar

TString URANIE::Optimizer::TObjective::_systar

Name of ystar.

Referenced by ClassImp(), ClassImp(), ClassImp(), and setYStar().

◆ _tds

URANIE::DataServer::TDataServer* URANIE::Optimizer::TObjective::_tds

Pointer of a TDS into YHat.

Referenced by ClassImp(), ClassImp(), ClassImp(), and setYStar().