ExportHessianRegularization Class Reference

A class for generating code implementing a symmetric EigenValue Decomposition. More...

#include <export_hessian_regularization.hpp>

Inheritance diagram for ExportHessianRegularization:

Public Member Functions
returnValue	configure (uint DIM, double eps)
	ExportHessianRegularization (const std::string &_sourceFileName, const std::string &_moduleName="acado", const std::string &_modulePrefix="ACADO", const std::string &_commonHeaderName="", const std::string &_realString="double", const std::string &_intString="int", int _precision=16, const std::string &_commentString=std::string())
virtual	~ExportHessianRegularization ()
Public Member Functions inherited from ExportTemplatedFile
virtual returnValue	configure ()
	ExportTemplatedFile ()
	ExportTemplatedFile (const std::string &_templateName, const std::string &_fileName, const std::string &_commonHeaderName="", const std::string &_realString="real_t", const std::string &_intString="int", int _precision=16, const std::string &_commentString=std::string())
virtual returnValue	setup (const std::string &_templateName, const std::string &_fileName, const std::string &_commonHeaderName="", const std::string &_realString="real_t", const std::string &_intString="int", int _precision=16, const std::string &_commentString=std::string())
virtual	~ExportTemplatedFile ()
Public Member Functions inherited from ExportFile
virtual returnValue	exportCode () const
	ExportFile ()
	ExportFile (const std::string &_fileName, const std::string &_commonHeaderName="", const std::string &_realString="real_t", const std::string &_intString="int", int _precision=16, const std::string &_commentString=std::string())
virtual returnValue	setup (const std::string &_fileName, const std::string &_commonHeaderName="", const std::string &_realString="real_t", const std::string &_intString="int", int _precision=16, const std::string &_commentString=std::string())
virtual	~ExportFile ()
Public Member Functions inherited from ExportStatementBlock
returnValue	addComment (const std::string &_comment)
returnValue	addComment (uint _nBlanks, const std::string &_comment)
returnValue	addDeclaration (const ExportVariable &_data, ExportStruct _dataStruct=ACADO_ANY)
returnValue	addDeclaration (const ExportIndex &_data, ExportStruct _dataStruct=ACADO_ANY)
returnValue	addDeclaration (const ExportFunction &_f)
returnValue	addDeclaration (const ExportAcadoFunction &_f)
returnValue	addFunction (const ExportFunction &_function)
returnValue	addFunctionCall (const std::string &_fName, const ExportArgument &_argument1=emptyConstExportArgument, const ExportArgument &_argument2=emptyConstExportArgument, const ExportArgument &_argument3=emptyConstExportArgument, const ExportArgument &_argument4=emptyConstExportArgument, const ExportArgument &_argument5=emptyConstExportArgument, const ExportArgument &_argument6=emptyConstExportArgument, const ExportArgument &_argument7=emptyConstExportArgument, const ExportArgument &_argument8=emptyConstExportArgument, const ExportArgument &_argument9=emptyConstExportArgument)
returnValue	addFunctionCall (const ExportFunction &_f, const ExportArgument &_argument1=emptyConstExportArgument, const ExportArgument &_argument2=emptyConstExportArgument, const ExportArgument &_argument3=emptyConstExportArgument, const ExportArgument &_argument4=emptyConstExportArgument, const ExportArgument &_argument5=emptyConstExportArgument, const ExportArgument &_argument6=emptyConstExportArgument, const ExportArgument &_argument7=emptyConstExportArgument, const ExportArgument &_argument8=emptyConstExportArgument, const ExportArgument &_argument9=emptyConstExportArgument)
returnValue	addLinebreak (uint num=1)
returnValue	addStatement (const ExportStatement &_statement)
returnValue	addStatement (const std::string &_statementString)
returnValue	clear ()
virtual ExportStatement *	clone () const
virtual returnValue	exportCode (std::ostream &stream, const std::string &_realString="real_t", const std::string &_intString="int", int _precision=16) const
virtual returnValue	exportDataDeclaration (std::ostream &stream, const std::string &_realString="real_t", const std::string &_intString="int", int _precision=16) const
	ExportStatementBlock ()
	ExportStatementBlock (const ExportStatementBlock &arg)
uint	getNumStatements () const
ExportStatementBlock &	operator= (const ExportStatementBlock &rhs)
virtual	~ExportStatementBlock ()
Public Member Functions inherited from ExportStatement
virtual ExportStatement &	acquire (ExportIndex &)
virtual ExportStatement &	allocate (MemoryAllocatorPtr)
	ExportStatement ()
	ExportStatement (const ExportStatement &arg)
ExportStatement &	operator= (const ExportStatement &arg)
virtual ExportStatement &	release (const ExportIndex &)
virtual	~ExportStatement ()

Private Attributes
std::string	moduleName
std::string	modulePrefix

Additional Inherited Members
Public Types inherited from ExportStatement
typedef std::shared_ptr< MemoryAllocator >	MemoryAllocatorPtr
typedef std::shared_ptr< ExportStatement >	StatementPtr
typedef std::vector< StatementPtr >	StatementPtrArray
Static Public Attributes inherited from ExportStatement
static std::string	fcnPrefix = "acado"
static std::string	varPrefix = "ACADO"
Protected Member Functions inherited from ExportTemplatedFile
returnValue	fillTemplate ()
Protected Attributes inherited from ExportTemplatedFile
std::map< std::string, std::string >	dictionary
std::string	folders
std::string	templateName
Protected Attributes inherited from ExportFile
std::string	commentString
std::string	commonHeaderName
std::string	fileName
std::string	intString
int	precision
std::string	realString
Protected Attributes inherited from ExportStatementBlock
StatementPtrArray	statements

Detailed Description

A class for generating code implementing a symmetric EigenValue Decomposition.

Author

Rien Quirynen

Definition at line 46 of file export_hessian_regularization.hpp.

Constructor & Destructor Documentation

BEGIN_NAMESPACE_ACADO ExportHessianRegularization::ExportHessianRegularization	(	const std::string &	_sourceFileName,
		const std::string &	_moduleName = "acado",
		const std::string &	_modulePrefix = "ACADO",
		const std::string &	_commonHeaderName = "",
		const std::string &	_realString = "double",
		const std::string &	_intString = "int",
		int	_precision = 16,
		const std::string &	_commentString = std::string()
	)

Default constructor.

@param[in] _moduleName              Module name for customization.

Parameters

[in]	_modulePrefix	Module name for customization.
[in]	_commonHeaderName	Name of common header file to be included.
[in]	_realString	std::string to be used to declare real variables.
[in]	_intString	std::string to be used to declare integer variables.
[in]	_precision	Number of digits to be used for exporting real values.
[in]	_commentString	std::string to be used for exporting comments.

Returns

SUCCESSFUL_RETURN

Definition at line 40 of file export_hessian_regularization.cpp.

virtual ExportHessianRegularization::~ExportHessianRegularization ( )

inlinevirtual

Destructor.

Definition at line 73 of file export_hessian_regularization.hpp.

Member Function Documentation

returnValue ExportHessianRegularization::configure	(	uint	DIM,
		double	eps
	)

Configure the template

Returns

SUCCESSFUL_RETURN

Definition at line 56 of file export_hessian_regularization.cpp.

Member Data Documentation

std::string ExportHessianRegularization::moduleName

private

Definition at line 84 of file export_hessian_regularization.hpp.

std::string ExportHessianRegularization::modulePrefix

private

Definition at line 85 of file export_hessian_regularization.hpp.

---

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

• export_hessian_regularization.hpp
• export_hessian_regularization.cpp