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:

List of all members.

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 ()
Private Attributes
ExportVariable	A
ExportFunction	fcn
bool	unrolling

---

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.

Parameters:

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

Definition at line 41 of file export_cholesky_decomposition.cpp.

virtual ExportCholeskyDecomposition::~ExportCholeskyDecomposition

(

)

[inline, virtual]

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.

Parameters:

[in]

code

Code block containing the auto-generated algorithm.

Returns:

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.

Parameters:

[in]

declarations

List of declarations.

Returns:

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.

Parameters:

[in]

declarations

List of declarations.

Returns:

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.

Returns:

SUCCESSFUL_RETURN

Definition at line 48 of file export_cholesky_decomposition.cpp.

returnValue ExportCholeskyDecomposition::setup

(

)

[virtual]

Initializes code export into given file.

Returns:

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