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

#include <export_argument_internal.hpp>

Inheritance diagram for ExportArgumentInternal:

Public Member Functions
returnValue	callByValue ()
virtual ExportArgumentInternal *	clone () 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

ExportArgumentInternal::ExportArgumentInternal ( )

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]	_name	Name of the argument.
[in]	_data	DMatrix used for initialization.
[in]	_type	Data type of the argument.
[in]	_dataStruct	Global data struct to which the argument belongs to (if any).
[in]	_callByValue	Flag indicating whether argument it to be called by value.
[in]	_addressIdx	If 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.

ExportArgumentInternal::~ExportArgumentInternal ( ) [virtual]

Destructor.

Definition at line 73 of file export_argument_internal.cpp.

Member Function Documentation

returnValue ExportArgumentInternal::callByValue ( )

Specifies to call argument by value.

Returns:: SUCCESSFUL_RETURN

Definition at line 178 of file export_argument_internal.cpp.

ExportArgumentInternal * ExportArgumentInternal::clone ( ) const [virtual]

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]	stream	Name of file to be used to export declaration.
[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.

Returns:: SUCCESSFUL_RETURN

Implements ExportDataInternal.

Definition at line 185 of file export_argument_internal.cpp.

ExportArgument ExportArgumentInternal::getAddress	(	const ExportIndex &	rowIdx,
		const ExportIndex &	colIdx = `emptyConstExportIndex`
	)		const

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

Parameters:

[in]	rowIdx	Row index of the adress.
[in]	colIdx	Column 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.