Public Member Functions | Protected Member Functions | Protected Attributes

Defines a matrix-valued variable that can be passed as argument to exported functions. More...

#include <export_argument_internal.hpp>

Inheritance diagram for ExportArgumentInternal:
Inheritance graph
[legend]

List of all members.

Public Member Functions

returnValue callByValue ()
virtual ExportArgumentInternalclone () const
 Make a deep copy of the instance.
virtual void deepCopyMembers (std::map< CasADi::SharedObjectNode *, CasADi::SharedObject > &already_copied)
 ExportArgumentInternal ()
 ExportArgumentInternal (const std::string &_name, const DMatrixPtr &_data, ExportType _type, ExportStruct _dataStruct, bool _callByValue, const ExportIndex &_addressIdx, const std::string &_prefix)
virtual returnValue exportDataDeclaration (std::ostream &stream, const std::string &_realString="real_t", const std::string &_intString="int", int _precision=16) const
ExportArgument getAddress (const ExportIndex &rowIdx, const ExportIndex &colIdx=emptyConstExportIndex) const
const std::string getAddressString (bool withDataStruct=true) const
virtual uint getDim () const
virtual uint getNumCols () const
virtual uint getNumRows () const
bool isCalledByValue () const
virtual bool isGiven () const
virtual ~ExportArgumentInternal ()

Protected Member Functions

virtual uint getColDim () const
virtual ExportIndex getTotalIdx (const ExportIndex &rowIdx, const ExportIndex &colIdx) const

Protected Attributes

ExportIndex addressIdx
bool callItByValue
DMatrixPtr data

Detailed Description

Defines a matrix-valued variable that can be passed as argument to exported functions.

The class ExportArgumentInternal defines a matrix-valued variable that can be passed as argument to exported functions. By default, all entries of an arguments are undefined, but each of its component can be set to a fixed value if known beforehand.

Author:
Hans Joachim Ferreau, Boris Houska, Milan Vukov

Definition at line 63 of file export_argument_internal.hpp.


Constructor & Destructor Documentation

Default constructor.

Definition at line 51 of file export_argument_internal.cpp.

ExportArgumentInternal::ExportArgumentInternal ( const std::string &  _name,
const DMatrixPtr _data,
ExportType  _type,
ExportStruct  _dataStruct,
bool  _callByValue,
const ExportIndex _addressIdx,
const std::string &  _prefix 
)

Constructor which takes the name and type of the argument. Moreover, it initializes the argument with the dimensions and the values of the given matrix.

Parameters:
[in]_nameName of the argument.
[in]_dataDMatrix used for initialization.
[in]_typeData type of the argument.
[in]_dataStructGlobal data struct to which the argument belongs to (if any).
[in]_callByValueFlag indicating whether argument it to be called by value.
[in]_addressIdxIf an address index is specified, not the argument itself but a pointer to this address within the memory of the argument is passed.

Definition at line 58 of file export_argument_internal.cpp.

Destructor.

Definition at line 73 of file export_argument_internal.cpp.


Member Function Documentation

Specifies to call argument by value.

Returns:
SUCCESSFUL_RETURN

Definition at line 178 of file export_argument_internal.cpp.

Make a deep copy of the instance.

Implements ExportDataInternal.

Reimplemented in ExportVariableInternal.

Definition at line 76 of file export_argument_internal.cpp.

void ExportArgumentInternal::deepCopyMembers ( std::map< CasADi::SharedObjectNode *, CasADi::SharedObject > &  already_copied) [virtual]

Deep copy data members.

Reimplemented from CasADi::SharedObjectNode.

Definition at line 81 of file export_argument_internal.cpp.

returnValue ExportArgumentInternal::exportDataDeclaration ( std::ostream &  stream,
const std::string &  _realString = "real_t",
const std::string &  _intString = "int",
int  _precision = 16 
) const [virtual]

Exports declaration of the argument into given file. Its appearance can can be adjusted by various options.

Parameters:
[in]streamName of file to be used to export declaration.
[in]_realStringstd::string to be used to declare real variables.
[in]_intStringstd::string to be used to declare integer variables.
[in]_precisionNumber of digits to be used for exporting real values.
Returns:
SUCCESSFUL_RETURN

Implements ExportDataInternal.

Definition at line 185 of file export_argument_internal.cpp.

Returns a copy of the argument with address index set to given location.

Parameters:
[in]rowIdxRow index of the adress.
[in]colIdxColumn index of the adress.
Returns:
Copy of the argument with address index set to given location

Definition at line 87 of file export_argument_internal.cpp.

const std::string ExportArgumentInternal::getAddressString ( bool  withDataStruct = true) const

Returns a string containing the address of the argument to be called. If an address index has been set, the string contains a pointer to the desired location. The string also depends on whether the argument is to be called by value or not.

Returns:
std::string containing the address of the argument

Definition at line 108 of file export_argument_internal.cpp.

uint ExportArgumentInternal::getColDim ( ) const [protected, virtual]

Returns column dimension of the argument.

Returns:
Column dimension of the argument

Reimplemented in ExportVariableInternal.

Definition at line 273 of file export_argument_internal.cpp.

uint ExportArgumentInternal::getDim ( ) const [virtual]

Returns total dimension of the argument.

Returns:
Total dimension of the argument

Reimplemented in ExportVariableInternal.

Definition at line 148 of file export_argument_internal.cpp.

Returns number of columns of the argument.

Returns:
Number of columns of the argument

Reimplemented in ExportVariableInternal.

Definition at line 142 of file export_argument_internal.cpp.

Returns number of rows of the argument.

Returns:
Number of rows of the argument

Reimplemented in ExportVariableInternal.

Definition at line 136 of file export_argument_internal.cpp.

ExportIndex ExportArgumentInternal::getTotalIdx ( const ExportIndex rowIdx,
const ExportIndex colIdx 
) const [protected, virtual]

Returns total index of given component within memory.

Parameters:
[in]rowIdxRow index of the component.
[in]colIdxColumn index of the component.
Returns:
Total index of given component

Reimplemented in ExportVariableInternal.

Definition at line 278 of file export_argument_internal.cpp.

Returns whether argument is to be called by value.

Returns:
true iff argument is to be called by value,
false otherwise

Definition at line 172 of file export_argument_internal.cpp.

bool ExportArgumentInternal::isGiven ( ) const [virtual]

Returns whether all components of the argument are given.

Returns:
true iff all components of the argument have given values,
false otherwise

Implements ExportDataInternal.

Reimplemented in ExportVariableInternal.

Definition at line 154 of file export_argument_internal.cpp.


Member Data Documentation

Address index in case not the argument itself but a pointer to this address within the memory of the argument is to be passed.

Definition at line 209 of file export_argument_internal.hpp.

Flag indicating whether argument it to be called by value.

Definition at line 211 of file export_argument_internal.hpp.

DMatrix containing the values of each component of the argument (by default, all entries are undefined).

Definition at line 207 of file export_argument_internal.hpp.


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


acado
Author(s): Milan Vukov, Rien Quirynen
autogenerated on Sat Jun 8 2019 19:40:23