Inheritance diagram for CppAD::cg::LangCCustomVariableNameGenerator< Base >:

Collaboration diagram for CppAD::cg::LangCCustomVariableNameGenerator< Base >:

Public Member Functions
	LangCCustomVariableNameGenerator (std::vector< std::string > depNames, std::vector< std::string > indepNames, const std::string &depName="y", const std::string &indepName="x", const std::string &tmpName="v", const std::string &tmpArrayName="array")

std::string	generateDependent (size_t index) override

std::string	generateIndependent (const OperationNode< Base > &independent, size_t id) override

bool	isConsecutiveInIndepArray (const OperationNode< Base > &indepFirst, size_t idFirst, const OperationNode< Base > &indepSecond, size_t idSecond) override

bool	isInSameIndependentArray (const OperationNode< Base > &indep1, size_t id1, const OperationNode< Base > &indep2, size_t id2) override

size_t	getMinTemporaryVariableID () const override

size_t	getMaxTemporaryVariableID () const override

size_t	getMaxTemporaryArrayVariableID () const override

size_t	getMaxTemporarySparseArrayVariableID () const override

std::string	generateTemporary (const OperationNode< Base > &variable, size_t id) override

std::string	generateTemporaryArray (const OperationNode< Base > &variable, size_t id) override

std::string	generateTemporarySparseArray (const OperationNode< Base > &variable, size_t id) override

std::string	generateIndexedDependent (const OperationNode< Base > &var, size_t id, const IndexPattern &ip) override

std::string	generateIndexedIndependent (const OperationNode< Base > &independent, size_t id, const IndexPattern &ip) override

void	setTemporaryVariableID (size_t minTempID, size_t maxTempID, size_t maxTempArrayID, size_t maxTempSparseArrayID) override

const std::string &	getIndependentArrayName (const OperationNode< Base > &indep, size_t id) override

size_t	getIndependentArrayIndex (const OperationNode< Base > &indep, size_t id) override

const std::string &	getTemporaryVarArrayName (const OperationNode< Base > &var, size_t id) override

size_t	getTemporaryVarArrayIndex (const OperationNode< Base > &var, size_t id) override

bool	isConsecutiveInTemporaryVarArray (const OperationNode< Base > &varFirst, size_t idFirst, const OperationNode< Base > &varSecond, size_t idSecond) override

bool	isInSameTemporaryVarArray (const OperationNode< Base > &var1, size_t id1, const OperationNode< Base > &var2, size_t id2) override

virtual const std::vector< FuncArgument > &	getDependent () const

virtual const std::vector< FuncArgument > &	getIndependent () const

virtual const std::vector< FuncArgument > &	getTemporary () const

virtual void	customFunctionVariableDeclarations (std::ostream &out)

virtual void	prepareCustomFunctionVariables (std::ostream &out)

virtual void	finalizeCustomFunctionVariables (std::ostream &out)

Static Protected Member Functions
static std::vector< const OperationNode< Base > * >	getIndexes (const OperationNode< Base > &var, size_t offset)

Protected Attributes
const std::vector< std::string >	depNames_

const std::vector< std::string >	indepNames_

std::stringstream	_ss

std::string	_depName

std::string	_indepName

std::string	_tmpName

std::string	_tmpArrayName

std::string	_tmpSparseArrayName

size_t	_minTemporaryID

size_t	_maxTemporaryID

size_t	_maxTemporaryArrayID

size_t	_maxTemporarySparseArrayID

std::vector< FuncArgument >	_dependent

std::vector< FuncArgument >	_independent

std::vector< FuncArgument >	_temporary

Detailed Description

template<class Base>
class CppAD::cg::LangCCustomVariableNameGenerator< Base >

Creates variables names for the source code using a list of provided custom names.

Author: Joao Leal

Definition at line 135 of file declare_cg.hpp.

Member Function Documentation

◆ generateDependent()

template<class Base>

std::string CppAD::cg::LangCCustomVariableNameGenerator< Base >::generateDependent ( size_t index )

inlineoverridevirtual

Creates a name for a dependent variable.

Parameters

index the dependent variable index

Returns: the generated name

Implements CppAD::cg::VariableNameGenerator< Base >.

Definition at line 49 of file lang_c_custom_var_name_gen.hpp.

◆ generateIndependent()

template<class Base>

std::string CppAD::cg::LangCCustomVariableNameGenerator< Base >::generateIndependent	(	const OperationNode< Base > &	variable,
		size_t	id
	)

inlineoverridevirtual

Creates a name for a dependent variable.

Parameters

variable	the node representing the independent variable
id	an ID assigned by the CodeHandler to the operation node (unique for independent variables)

Returns: the generated name

Implements CppAD::cg::VariableNameGenerator< Base >.

Definition at line 57 of file lang_c_custom_var_name_gen.hpp.

◆ generateIndexedDependent()

template<class Base >

std::string CppAD::cg::LangCDefaultVariableNameGenerator< Base >::generateIndexedDependent	(	const OperationNode< Base > &	var,
		size_t	id,
		const IndexPattern &	ip
	)

inlineoverridevirtualinherited

Creates a name for a reference to an indexed dependent variable expression.

Parameters

var	the node representing an indexed dependent variable
id	an ID assigned by the CodeHandler to the operation node (potentially not unique)
ip	the index pattern

Returns: the generated name

Implements CppAD::cg::VariableNameGenerator< Base >.

Definition at line 149 of file lang_c_default_var_name_gen.hpp.

◆ generateIndexedIndependent()

template<class Base >

std::string CppAD::cg::LangCDefaultVariableNameGenerator< Base >::generateIndexedIndependent	(	const OperationNode< Base > &	var,
		size_t	id,
		const IndexPattern &	ip
	)

inlineoverridevirtualinherited

Creates a name for a reference to an indexed independent variable expression.

Parameters

var	the node representing an indexed independent variable
id	an ID assigned by the CodeHandler to the operation node (unique for indexed independent variables)
ip	the index pattern

Returns: the generated name

Implements CppAD::cg::VariableNameGenerator< Base >.

Definition at line 163 of file lang_c_default_var_name_gen.hpp.

◆ generateTemporary()

template<class Base >

std::string CppAD::cg::LangCDefaultVariableNameGenerator< Base >::generateTemporary	(	const OperationNode< Base > &	variable,
		size_t	id
	)

inlineoverridevirtualinherited

Creates a name for a temporary variable.

Parameters

variable	the node representing the temporary variable
id	an ID assigned by the CodeHandler to the operation node (potentially not unique)

Returns: the generated name

Implements CppAD::cg::VariableNameGenerator< Base >.

Definition at line 111 of file lang_c_default_var_name_gen.hpp.

◆ generateTemporaryArray()

template<class Base >

std::string CppAD::cg::LangCDefaultVariableNameGenerator< Base >::generateTemporaryArray	(	const OperationNode< Base > &	variable,
		size_t	id
	)

inlineoverridevirtualinherited

Creates a name for a temporary dense array variable.

Parameters

variable	the node representing the dense array variable creation
id	an ID assigned by the CodeHandler to the operation node (potentially not unique)

Returns: the generated name

Implements CppAD::cg::VariableNameGenerator< Base >.

Definition at line 125 of file lang_c_default_var_name_gen.hpp.

◆ generateTemporarySparseArray()

template<class Base >

std::string CppAD::cg::LangCDefaultVariableNameGenerator< Base >::generateTemporarySparseArray	(	const OperationNode< Base > &	variable,
		size_t	id
	)

inlineoverridevirtualinherited

Creates a name for a temporary sparse array variable.

Parameters

variable	the node representing the sparse array variable creation
id	an ID assigned by the CodeHandler to the operation node (potentially not unique)

Returns: the generated name

Implements CppAD::cg::VariableNameGenerator< Base >.

Definition at line 137 of file lang_c_default_var_name_gen.hpp.

◆ getDependent()

template<class Base>

virtual const std::vector<FuncArgument>& CppAD::cg::VariableNameGenerator< Base >::getDependent ( ) const

inlinevirtualinherited

Provides the dependent variable arguments used by a function.

Returns: the dependent variable arguments

Reimplemented in CppAD::cg::LangCDefaultReverse2VarNameGenerator< Base >, and CppAD::cg::LangCDefaultHessianVarNameGenerator< Base >.

Definition at line 56 of file variable_name_generator.hpp.

Referenced by CppAD::cg::LangCDefaultHessianVarNameGenerator< Base >::getDependent(), and CppAD::cg::LangCDefaultReverse2VarNameGenerator< Base >::getDependent().

◆ getIndependent()

template<class Base>

virtual const std::vector<FuncArgument>& CppAD::cg::VariableNameGenerator< Base >::getIndependent ( ) const

inlinevirtualinherited

Provides the independent variable arguments used by a function.

Returns: the independent variable arguments

Definition at line 65 of file variable_name_generator.hpp.

Referenced by CppAD::cg::LangCDefaultHessianVarNameGenerator< Base >::isInSameTemporaryVarArray(), and CppAD::cg::LangCDefaultReverse2VarNameGenerator< Base >::setTemporaryVariableID().

◆ getIndependentArrayIndex()

template<class Base >

size_t CppAD::cg::LangCDefaultVariableNameGenerator< Base >::getIndependentArrayIndex	(	const OperationNode< Base > &	indep,
		size_t	id
	)

inlineoverridevirtualinherited

Provides the index in the associated independent array of an independent variable. It should only be called if independents are saved in an array.

Parameters

indep	the independent variable node (CGInvOp)
id	an ID assigned by the CodeHandler to the operation node (unique for independent variable arrays)

Returns: the index

Implements CppAD::cg::VariableNameGenerator< Base >.

Definition at line 197 of file lang_c_default_var_name_gen.hpp.

◆ getIndependentArrayName()

template<class Base >

const std::string& CppAD::cg::LangCDefaultVariableNameGenerator< Base >::getIndependentArrayName	(	const OperationNode< Base > &	indep,
		size_t	id
	)

inlineoverridevirtualinherited

Provides the array name where independent variables are provided to the function. It should only be called if independents are saved in an array.

Parameters

indep	the independent variable node (CGInvOp)
id	an ID assigned by the CodeHandler to the operation node (unique for independent variable arrays)

Returns: the array name

Implements CppAD::cg::VariableNameGenerator< Base >.

Definition at line 192 of file lang_c_default_var_name_gen.hpp.

◆ getMaxTemporaryArrayVariableID()

template<class Base >

size_t CppAD::cg::LangCDefaultVariableNameGenerator< Base >::getMaxTemporaryArrayVariableID ( ) const

inlineoverridevirtualinherited

Provides the maximum variable ID of temporary dense array variables.

Implements CppAD::cg::VariableNameGenerator< Base >.

Definition at line 84 of file lang_c_default_var_name_gen.hpp.

◆ getMaxTemporarySparseArrayVariableID()

template<class Base >

size_t CppAD::cg::LangCDefaultVariableNameGenerator< Base >::getMaxTemporarySparseArrayVariableID ( ) const

inlineoverridevirtualinherited

Provides the maximum variable ID of temporary sparse array variables.

Implements CppAD::cg::VariableNameGenerator< Base >.

Definition at line 88 of file lang_c_default_var_name_gen.hpp.

◆ getMaxTemporaryVariableID()

template<class Base >

size_t CppAD::cg::LangCDefaultVariableNameGenerator< Base >::getMaxTemporaryVariableID ( ) const

inlineoverridevirtualinherited

Provides the maximum used variable ID of temporary variables.

Implements CppAD::cg::VariableNameGenerator< Base >.

Definition at line 80 of file lang_c_default_var_name_gen.hpp.

◆ getMinTemporaryVariableID()

template<class Base >

size_t CppAD::cg::LangCDefaultVariableNameGenerator< Base >::getMinTemporaryVariableID ( ) const

inlineoverridevirtualinherited

Provides the minimum variable ID of temporary variables.

Implements CppAD::cg::VariableNameGenerator< Base >.

Definition at line 76 of file lang_c_default_var_name_gen.hpp.

◆ getTemporary()

template<class Base>

virtual const std::vector<FuncArgument>& CppAD::cg::VariableNameGenerator< Base >::getTemporary ( ) const

inlinevirtualinherited

Provides the temporary variable arguments used by a function.

Returns: the temporary variable arguments

Reimplemented in CppAD::cg::LangCDefaultReverse2VarNameGenerator< Base >, and CppAD::cg::LangCDefaultHessianVarNameGenerator< Base >.

Definition at line 74 of file variable_name_generator.hpp.

Referenced by CppAD::cg::LangCDefaultHessianVarNameGenerator< Base >::getTemporary(), and CppAD::cg::LangCDefaultReverse2VarNameGenerator< Base >::getTemporary().

◆ getTemporaryVarArrayIndex()

template<class Base >

size_t CppAD::cg::LangCDefaultVariableNameGenerator< Base >::getTemporaryVarArrayIndex	(	const OperationNode< Base > &	var,
		size_t	id
	)

inlineoverridevirtualinherited

Provides the index in the associated temporary array of a temporary variable. It should only be called if temporary variables are saved in an array.

Parameters

var	the temporary variable node
id	an ID assigned by the CodeHandler to the operation node (potentially not unique)

Returns: the index

Implements CppAD::cg::VariableNameGenerator< Base >.

Definition at line 221 of file lang_c_default_var_name_gen.hpp.

◆ getTemporaryVarArrayName()

template<class Base >

const std::string& CppAD::cg::LangCDefaultVariableNameGenerator< Base >::getTemporaryVarArrayName	(	const OperationNode< Base > &	var,
		size_t	id
	)

inlineoverridevirtualinherited

Provides the array name for the temporary variables. It should only be called if temporary variables are saved in an array.

Parameters

var	the temporary variable node
id	an ID assigned by the CodeHandler to the operation node (potentially not unique)

Returns: the array name

Implements CppAD::cg::VariableNameGenerator< Base >.

Definition at line 216 of file lang_c_default_var_name_gen.hpp.

◆ isConsecutiveInIndepArray()

template<class Base>

bool CppAD::cg::LangCCustomVariableNameGenerator< Base >::isConsecutiveInIndepArray	(	const OperationNode< Base > &	indepFirst,
		size_t	idFirst,
		const OperationNode< Base > &	indepSecond,
		size_t	idSecond
	)

inlineoverridevirtual

Whether or not two independent variables are considered to be part of the same independent variable array at consecutive locations.

Parameters

indepFirst	the independent node (CGInvOp) with the lower index
idFirst	an ID assigned by the CodeHandler to the first node (unique for independent variables)
indepSecond	the independent node (CGInvOp) with the higher index
idSecond	an ID assigned by the CodeHandler to the second node (unique for independent variables)

Returns: true if the independents are consecutive

Implements CppAD::cg::VariableNameGenerator< Base >.

Definition at line 67 of file lang_c_custom_var_name_gen.hpp.

◆ isConsecutiveInTemporaryVarArray()

template<class Base >

bool CppAD::cg::LangCDefaultVariableNameGenerator< Base >::isConsecutiveInTemporaryVarArray	(	const OperationNode< Base > &	varFirst,
		size_t	idFirst,
		const OperationNode< Base > &	varSecond,
		size_t	idSecond
	)

inlineoverridevirtualinherited

Whether or not two temporary variables are considered to be part of the same temporary variable array at consecutive locations.

Parameters

varFirst	the temporary variable node with the lower index
idFirst	an ID assigned by the CodeHandler to the first node (potentially not unique)
varSecond	the temporary variable node with the higher index
varSecond	an ID assigned by the CodeHandler to the second node (potentially not unique)

Returns: true if they are consecutive

Implements CppAD::cg::VariableNameGenerator< Base >.

Definition at line 226 of file lang_c_default_var_name_gen.hpp.

◆ isInSameIndependentArray()

template<class Base>

bool CppAD::cg::LangCCustomVariableNameGenerator< Base >::isInSameIndependentArray	(	const OperationNode< Base > &	indep1,
		size_t	id1,
		const OperationNode< Base > &	indep2,
		size_t	id2
	)

inlineoverridevirtual

Determines whether or not two independents are part of the same independent variable array.

Parameters

indep1	the first independent node (CGInvOp or CGLoopIndexedIndepOp)
id1	an ID assigned by the CodeHandler to indep1 (unique for independent variables)
indep2	the second independent node (CGInvOp or CGLoopIndexedIndepOp)
id2	an ID assigned by the CodeHandler to indep2 (unique for independent variables)

Returns: true if the independents are part of the same array

Implements CppAD::cg::VariableNameGenerator< Base >.

Definition at line 82 of file lang_c_custom_var_name_gen.hpp.

◆ isInSameTemporaryVarArray()

template<class Base >

bool CppAD::cg::LangCDefaultVariableNameGenerator< Base >::isInSameTemporaryVarArray	(	const OperationNode< Base > &	var1,
		size_t	id1,
		const OperationNode< Base > &	var2,
		size_t	id2
	)

inlineoverridevirtualinherited

Determines whether or not two temporary variables are part of the same temporary variable array.

Parameters

var1	the temporary variable node
id1	an ID assigned by the CodeHandler to var1 (potentially not unique)
var2	the temporary variable node
id2	an ID assigned by the CodeHandler to var2 (potentially not unique)

Returns: true if the temporary variables are part of the same array

Implements CppAD::cg::VariableNameGenerator< Base >.

Definition at line 233 of file lang_c_default_var_name_gen.hpp.

◆ setTemporaryVariableID()

template<class Base >

void CppAD::cg::LangCDefaultVariableNameGenerator< Base >::setTemporaryVariableID	(	size_t	minTempID,
		size_t	maxTempID,
		size_t	maxTempArrayID,
		size_t	maxTempSparseArrayID
	)

inlineoverridevirtualinherited

Defines the ID ranges used by each variable type.

Parameters

minTempID	the lowest ID of temporary variables
maxTempID	the highest used ID of temporary variables
maxTempArrayID	the highest used ID of temporary dense array variables
maxTempSparseArrayID	the highest used ID of temporary sparse array variables

Implements CppAD::cg::VariableNameGenerator< Base >.

Definition at line 177 of file lang_c_default_var_name_gen.hpp.

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

include/cppad/cg/declare_cg.hpp
include/cppad/cg/lang/c/lang_c_custom_var_name_gen.hpp

Public Member Functions

Static Protected Member Functions

Protected Attributes

Detailed Description

template<class Base> class CppAD::cg::LangCCustomVariableNameGenerator< Base >

Member Function Documentation

◆ generateDependent()

◆ generateIndependent()

◆ generateIndexedDependent()

◆ generateIndexedIndependent()

◆ generateTemporary()

◆ generateTemporaryArray()

◆ generateTemporarySparseArray()

◆ getDependent()

◆ getIndependent()

◆ getIndependentArrayIndex()

◆ getIndependentArrayName()

◆ getMaxTemporaryArrayVariableID()

◆ getMaxTemporarySparseArrayVariableID()

◆ getMaxTemporaryVariableID()

◆ getMinTemporaryVariableID()

◆ getTemporary()

◆ getTemporaryVarArrayIndex()

◆ getTemporaryVarArrayName()

◆ isConsecutiveInIndepArray()

◆ isConsecutiveInTemporaryVarArray()

◆ isInSameIndependentArray()

◆ isInSameTemporaryVarArray()

◆ setTemporaryVariableID()

template<class Base>
class CppAD::cg::LangCCustomVariableNameGenerator< Base >