ExportCholeskyDecomposition Class Reference

A class for exporting a function for calculation of the Cholesky decomposition. More...

#include <export_cholesky_decomposition.hpp>

Inheritance diagram for ExportCholeskyDecomposition:

Public Member Functions
	ExportCholeskyDecomposition (UserInteraction *_userInteraction=0, const std::string &_commonHeaderName="")
virtual returnValue	getCode (ExportStatementBlock &code)
virtual returnValue	getDataDeclarations (ExportStatementBlock &declarations, ExportStruct dataStruct=ACADO_ANY) const
virtual returnValue	getFunctionDeclarations (ExportStatementBlock &declarations) const
const std::string	getName ()
returnValue	init (const std::string &_name, unsigned _dim, bool _unrolling=false)
virtual returnValue	setup ()
virtual	~ExportCholeskyDecomposition ()
Public Member Functions inherited from ExportAlgorithm
	ExportAlgorithm (UserInteraction *_userInteraction=0, const std::string &_commonHeaderName=std::string())
uint	getN () const
uint	getNDX () const
uint	getNOD () const
uint	getNP () const
uint	getNU () const
uint	getNX () const
uint	getNXA () const
uint	getNY () const
uint	getNYN () const
returnValue	setDimensions (uint _NX=0, uint _NU=0, uint _NP=0, uint _NI=0, uint _NOD=0)
returnValue	setDimensions (uint _NX, uint _NDX, uint _NXA, uint _NU, uint _NP, uint _NI, uint _NOD)
void	setNY (uint NY_)
void	setNYN (uint NYN_)
virtual	~ExportAlgorithm ()
Public Member Functions inherited from AlgorithmicBase
int	addLogRecord (LogRecord &_record)
returnValue	addOption (OptionsName name, int value)
returnValue	addOption (OptionsName name, double value)
returnValue	addOption (uint idx, OptionsName name, int value)
returnValue	addOption (uint idx, OptionsName name, double value)
returnValue	addOptionsList ()
	AlgorithmicBase ()
	AlgorithmicBase (UserInteraction *_userInteraction)
	AlgorithmicBase (const AlgorithmicBase &rhs)
returnValue	get (OptionsName name, int &value) const
returnValue	get (OptionsName name, double &value) const
returnValue	get (OptionsName name, std::string &value) const
returnValue	get (uint idx, OptionsName name, int &value) const
returnValue	get (uint idx, OptionsName name, double &value) const
returnValue	getAll (LogName _name, MatrixVariablesGrid &values) const
returnValue	getFirst (LogName _name, DMatrix &firstValue) const
returnValue	getFirst (LogName _name, VariablesGrid &firstValue) const
returnValue	getLast (LogName _name, DMatrix &lastValue) const
returnValue	getLast (LogName _name, VariablesGrid &lastValue) const
Options	getOptions (uint idx) const
BooleanType	haveOptionsChanged () const
BooleanType	haveOptionsChanged (uint idx) const
AlgorithmicBase &	operator= (const AlgorithmicBase &rhs)
returnValue	plot (PlotFrequency _frequency=PLOT_IN_ANY_CASE)
returnValue	printLogRecord (std::ostream &_stream, int idx, LogPrintMode _mode=PRINT_ITEM_BY_ITEM) const
returnValue	replot (PlotFrequency _frequency=PLOT_IN_ANY_CASE)
returnValue	set (OptionsName name, int value)
returnValue	set (OptionsName name, double value)
returnValue	set (OptionsName name, const std::string &value)
returnValue	set (uint idx, OptionsName name, int value)
returnValue	set (uint idx, OptionsName name, double value)
returnValue	setAll (LogName _name, const MatrixVariablesGrid &values)
returnValue	setLast (LogName _name, int lastValue, double time=-INFTY)
returnValue	setLast (LogName _name, double lastValue, double time=-INFTY)
returnValue	setLast (LogName _name, const DVector &lastValue, double time=-INFTY)
returnValue	setLast (LogName _name, const DMatrix &lastValue, double time=-INFTY)
returnValue	setLast (LogName _name, const VariablesGrid &lastValue, double time=-INFTY)
returnValue	setOptions (const Options &arg)
returnValue	setOptions (uint idx, const Options &arg)
virtual	~AlgorithmicBase ()

Private Attributes
ExportVariable	A
ExportFunction	fcn
bool	unrolling

Additional Inherited Members
Protected Attributes inherited from ExportAlgorithm
std::string	commonHeaderName
uint	N
uint	NDX
uint	NOD
uint	NP
uint	NU
uint	NX
uint	NXA
uint	NY
uint	NYN
Protected Attributes inherited from AlgorithmicBase
int	outputLoggingIdx
BooleanType	useModuleStandalone
UserInteraction *	userInteraction

Detailed Description

A class for exporting a function for calculation of the Cholesky decomposition.

Author

Milan Vukov

Definition at line 50 of file export_cholesky_decomposition.hpp.

Constructor & Destructor Documentation

BEGIN_NAMESPACE_ACADO ExportCholeskyDecomposition::ExportCholeskyDecomposition	(	UserInteraction *	_userInteraction = 0,
		const std::string &	_commonHeaderName = ""
	)

Default constructor.

@param[in] _userInteraction         Pointer to corresponding user interface.
@param[in] _commonHeaderName        Name of common header file to be included.

Definition at line 41 of file export_cholesky_decomposition.cpp.

virtual ExportCholeskyDecomposition::~ExportCholeskyDecomposition ( )

inlinevirtual

Destructor.

Definition at line 64 of file export_cholesky_decomposition.hpp.

Member Function Documentation

returnValue ExportCholeskyDecomposition::getCode ( ExportStatementBlock &  code )

virtual

Exports source code of the auto-generated algorithm into the given directory.

@param[in] code                             Code block containing the auto-generated algorithm.

\return SUCCESSFUL_RETURN

Implements ExportAlgorithm.

Definition at line 119 of file export_cholesky_decomposition.cpp.

returnValue ExportCholeskyDecomposition::getDataDeclarations ( ExportStatementBlock &  declarations, ExportStruct  dataStruct = ACADO_ANY  ) const

virtual

Adds all data declarations of the auto-generated algorithm to given list of declarations.

@param[in] declarations             List of declarations.

\return SUCCESSFUL_RETURN

Implements ExportAlgorithm.

Definition at line 103 of file export_cholesky_decomposition.cpp.

returnValue ExportCholeskyDecomposition::getFunctionDeclarations ( ExportStatementBlock &  declarations ) const

virtual

Adds all function (forward) declarations of the auto-generated algorithm to given list of declarations.

@param[in] declarations             List of declarations.

\return SUCCESSFUL_RETURN

Implements ExportAlgorithm.

Definition at line 110 of file export_cholesky_decomposition.cpp.

const std::string ExportCholeskyDecomposition::getName

(

)

Get name of the function that perform the decomposition.

Definition at line 128 of file export_cholesky_decomposition.cpp.

returnValue ExportCholeskyDecomposition::init	(	const std::string &	_name,
		unsigned	_dim,
		bool	_unrolling = false
	)

Initializes the different parameters of the linear solver that will be exported.

\return SUCCESSFUL_RETURN

Definition at line 48 of file export_cholesky_decomposition.cpp.

returnValue ExportCholeskyDecomposition::setup ( )

virtual

Initializes code export into given file.

\return SUCCESSFUL_RETURN

Reimplemented from ExportAlgorithm.

Definition at line 61 of file export_cholesky_decomposition.cpp.

Member Data Documentation

ExportVariable ExportCholeskyDecomposition::A

private

Definition at line 115 of file export_cholesky_decomposition.hpp.

ExportFunction ExportCholeskyDecomposition::fcn

private

Definition at line 116 of file export_cholesky_decomposition.hpp.

bool ExportCholeskyDecomposition::unrolling

private

Definition at line 117 of file export_cholesky_decomposition.hpp.

---

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

• export_cholesky_decomposition.hpp
• export_cholesky_decomposition.cpp