Sensitivity Class Reference

#include <Sensitivity.h>

Inheritance diagram for Sensitivity:

Public Member Functions
	Sensitivity (SensitivityInput sensitivityInput, const char *xmlOutputFileName="SensitivityResults.xml")
	initialize from external SensitivityInput object More...
	~Sensitivity (void)
void	setModel (Model *model)
	set the internally-held pointer to the Model object More...
Model *	model (void)
	get the internally-held pointer to the Model object More...
int	maxRound (void) const
	return the total number of rounds More...
void	execute (void)
Public Member Functions inherited from SensitivityInput
	SensitivityInput (std::string name, std::string type, int id, std::string order, double timeout, int startingRound)
	SensitivityInput (void)
std::ostream &	printInputs_ (std::ostream &os) const
	helper function for printing inputs to streams More...
bool	check (void)
const std::string &	type (void) const
	get the type of the model to analyze More...
int	id (void) const
	get the id of the model to analyze More...
int	startingRound (void) const
	get the starting round for the sensitivity More...
void	addControlledVariable (const ControlledVariable &cv)
	add the controlled variable More...
void	addMonitoredVariable (const MonitoredVariable &mv)
	add the monitored variable More...
std::ostream &	print_ (std::ostream &os) const
	informative print More...
std::string	json (void) const
bool	operator== (const SensitivityInput &rhs) const
Public Member Functions inherited from SensitivityResult
std::ostream &	printResults_ (std::ostream &os) const
	informative print More...
std::ostream &	printXmlResults (std::ostream &os) const
	serialize to XML More...
std::string	json (void) const
Public Member Functions inherited from Diagnostic
	Diagnostic (void)
void	setVerbosity (int verbosity)
	sets the verbosity level for this instance More...
int	verbosity (void) const

Friends
std::ostream &	operator<< (std::ostream &os, const Sensitivity &sensitivity)

Additional Inherited Members
Public Attributes inherited from SensitivityResult
std::vector< Result >	results_
Protected Member Functions inherited from Diagnostic
virtual	~Diagnostic ()=default
Protected Attributes inherited from SensitivityInput
std::string	name_
	optional UTF-encoded string with a descriptive name More...
std::string	type_
	mandatory UTF-encoded string with the type of the model to analyze More...
int	id_
	mandatory non-negative integer, id of the model to analyze More...
std::string	order_
	mandatory order of execution, can be: lexicographic, boustrophedon or quasi-spiral More...
double	timeout_
	optional maximum running time in seconds (to be enforced by the client) More...
int	startingRound_
	mandatory non-negative integer, valud of the sequential counter based on the chosen ordering More...
std::vector< ControlledVariable >	controlled_
	Controlled variables: at least one. More...
std::vector< MonitoredVariable >	monitored_
	Monitored variables. More...
Protected Attributes inherited from Diagnostic
int	verbosityInstance

Detailed Description

for multi-dimensional kernel-side sensitivities constructed from XML file

#include <libpf/core/Sensitivity.h>

Remarks

Warning

Thread safe:

Extendable:

Platform dependencies:

Constructor & Destructor Documentation

Sensitivity()

Sensitivity::Sensitivity	(	SensitivityInput	sensitivityInput,
		const char *	xmlOutputFileName = "SensitivityResults.xml"
	)

initialize from external SensitivityInput object

~Sensitivity()

Sensitivity::~Sensitivity

(

void

)

Member Function Documentation

execute()

void Sensitivity::execute

(

void

)

execute the multi-variable sensitivity with the specified order save XML results file after each round

maxRound()

int Sensitivity::maxRound

(

void

)

const

return the total number of rounds

model()

Model * Sensitivity::model

(

void

)

get the internally-held pointer to the Model object

setModel()

void Sensitivity::setModel

(

Model *

model

)

set the internally-held pointer to the Model object

Friends And Related Function Documentation

operator<<

std::ostream & operator<< ( std::ostream &  os, const Sensitivity &  sensitivity  )

friend

---

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

• Sensitivity.h