Allows to export Householder QR Factorization for solving linear systems of specific dimensions. More...
#include <householder_qr_export.hpp>
Public Member Functions | |
| returnValue | appendVariableNames (std::stringstream &string) |
| ExportHouseholderQR (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 |
| virtual ExportVariable | getGlobalExportVariable (const uint factor) const |
| virtual returnValue | setup () |
| virtual | ~ExportHouseholderQR () |
Protected Attributes | |
| ExportVariable | rk_temp |
Detailed Description
Allows to export Householder QR Factorization for solving linear systems of specific dimensions.
The class ExportHouseholderQR allows to export Householder QR Factorization for solving linear systems of specific dimensions.
Definition at line 54 of file householder_qr_export.hpp.
Constructor & Destructor Documentation
| BEGIN_NAMESPACE_ACADO ExportHouseholderQR::ExportHouseholderQR | ( | 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 44 of file householder_qr_export.cpp.
| ExportHouseholderQR::~ExportHouseholderQR | ( | ) | [virtual] |
Destructor.
Definition at line 51 of file householder_qr_export.cpp.
Member Function Documentation
| returnValue ExportHouseholderQR::appendVariableNames | ( | std::stringstream & | string | ) | [virtual] |
Appends the names of the used variables to a given stringstream.
- Parameters:
-
[in] string The string to which the names of the used variables are appended.
- Returns:
- SUCCESSFUL_RETURN
Implements ExportLinearSolver.
Definition at line 300 of file householder_qr_export.cpp.
| returnValue ExportHouseholderQR::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 ExportLinearSolver.
Definition at line 77 of file householder_qr_export.cpp.
| returnValue ExportHouseholderQR::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 ExportLinearSolver.
Definition at line 56 of file householder_qr_export.cpp.
| returnValue ExportHouseholderQR::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 ExportLinearSolver.
Definition at line 64 of file householder_qr_export.cpp.
| ExportVariable ExportHouseholderQR::getGlobalExportVariable | ( | const uint | factor | ) | const [virtual] |
Returns the dimension of the auxiliary variables for the linear solver.
- Returns:
- The dimension of the auxiliary variables for the linear solver.
Reimplemented from ExportLinearSolver.
Definition at line 334 of file householder_qr_export.cpp.
| returnValue ExportHouseholderQR::setup | ( | ) | [virtual] |
Initializes code export into given file.
- Returns:
- SUCCESSFUL_RETURN
Implements ExportLinearSolver.
Definition at line 306 of file householder_qr_export.cpp.
Member Data Documentation
ExportVariable ExportHouseholderQR::rk_temp [protected] |
Variable that is used to store intermediate results that can be reused.
Definition at line 137 of file householder_qr_export.hpp.
The documentation for this class was generated from the following files: