gstlrn::AModelOptim Class Reference

#include <AModelOptim.hpp>

Inheritance diagram for gstlrn::AModelOptim:

Public Member Functions
	AModelOptim (ModelGeneric *model=nullptr, bool verbose=false)
void	setEnvironment (const MatrixSymmetric &vars, double href)
AModelOptim &	operator= (const AModelOptim &r)
void	setAuthorizedAnalyticalGradients (bool authorized)
bool	getAuthorizedAnalyticalGradients () const
virtual	~AModelOptim ()
void	setGradients (std::vector< std::function< double(const std::vector< double > &)> > &gradients)
void	setVerbose (bool verbose=false, bool trace=false)
double	eval (const std::vector< double > &x)
virtual void	evalGrad (vect res)
void	run ()
void	resetIter ()
virtual double	computeCost (bool verbose=false)=0

Constructor & Destructor Documentation

AModelOptim()

gstlrn::AModelOptim::AModelOptim	(	ModelGeneric *	model = nullptr,
		bool	verbose = false
	)

~AModelOptim()

gstlrn::AModelOptim::~AModelOptim ( )

virtual

Member Function Documentation

computeCost()

virtual double gstlrn::AModelOptim::computeCost ( bool  verbose = false )

pure virtual

Implemented in gstlrn::ALikelihood, gstlrn::ModelOptimVario, and gstlrn::ModelOptimVMap.

eval()

double gstlrn::AModelOptim::eval

(

const std::vector< double > &

x

)

evalGrad()

void gstlrn::AModelOptim::evalGrad ( vect  res )

virtual

Reimplemented in gstlrn::Likelihood, gstlrn::ModelOptimVario, and gstlrn::ModelOptimVMap.

getAuthorizedAnalyticalGradients()

bool gstlrn::AModelOptim::getAuthorizedAnalyticalGradients

(

)

const

operator=()

AModelOptim & gstlrn::AModelOptim::operator=

(

const AModelOptim &

r

)

resetIter()

void gstlrn::AModelOptim::resetIter

(

)

run()

void gstlrn::AModelOptim::run

(

)

setAuthorizedAnalyticalGradients()

void gstlrn::AModelOptim::setAuthorizedAnalyticalGradients

(

bool

authorized

)

setEnvironment()

void gstlrn::AModelOptim::setEnvironment	(	const MatrixSymmetric &	vars,
		double	href
	)

setGradients()

void gstlrn::AModelOptim::setGradients	(	std::vector< std::function< double(const std::vector< double > &)>	,
		&	gradients
	)

setVerbose()

void gstlrn::AModelOptim::setVerbose	(	bool	verbose = false,
		bool	trace = false
	)

---

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

• include/Estimation/AModelOptim.hpp
• src/Estimation/AModelOptim.cpp