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

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

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

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

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

virtual size_t	getMinTemporaryVariableID () const =0

virtual size_t	getMaxTemporaryVariableID () const =0

virtual size_t	getMaxTemporaryArrayVariableID () const =0

virtual size_t	getMaxTemporarySparseArrayVariableID () const =0

virtual std::string	generateDependent (size_t index)=0

virtual std::string	generateIndependent (const OperationNode< Base > &variable, size_t id)=0

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

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

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

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

virtual std::string	generateIndexedIndependent (const OperationNode< Base > &var, size_t id, const IndexPattern &ip)=0

virtual void	setTemporaryVariableID (size_t minTempID, size_t maxTempID, size_t maxTempArrayID, size_t maxTempSparseArrayID)=0

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

virtual size_t	getIndependentArrayIndex (const OperationNode< Base > &indep, size_t id)=0

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

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

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

virtual size_t	getTemporaryVarArrayIndex (const OperationNode< Base > &var, size_t id)=0

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

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

virtual void	customFunctionVariableDeclarations (std::ostream &out)

virtual void	prepareCustomFunctionVariables (std::ostream &out)

virtual void	finalizeCustomFunctionVariables (std::ostream &out)

Protected Attributes
std::vector< FuncArgument >	_dependent

std::vector< FuncArgument >	_independent

std::vector< FuncArgument >	_temporary

Detailed Description

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

Creates variables names for the source code.

Author: Joao Leal

Definition at line 129 of file declare_cg.hpp.

Member Function Documentation

◆ generateDependent()

template<class Base>

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

pure virtual

Creates a name for a dependent variable.

Parameters

index the dependent variable index

Returns: the generated name

Implemented in CppAD::cg::LangCDefaultReverse2VarNameGenerator< Base >, CppAD::cg::LangCDefaultHessianVarNameGenerator< Base >, CppAD::cg::LangCDefaultVariableNameGenerator< Base >, CppAD::cg::LangLatexDefaultVariableNameGenerator< Base >, CppAD::cg::LangMathMLDefaultVariableNameGenerator< Base >, CppAD::cg::LangLatexCustomVariableNameGenerator< Base >, CppAD::cg::LangMathMLCustomVariableNameGenerator< Base >, and CppAD::cg::LangCCustomVariableNameGenerator< Base >.

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

◆ generateIndependent()

template<class Base>

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

pure virtual

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

Implemented in CppAD::cg::LangCDefaultReverse2VarNameGenerator< Base >, CppAD::cg::LangMathMLDefaultVariableNameGenerator< Base >, CppAD::cg::LangLatexDefaultVariableNameGenerator< Base >, CppAD::cg::LangCDefaultVariableNameGenerator< Base >, CppAD::cg::LangCDefaultHessianVarNameGenerator< Base >, CppAD::cg::LangLatexCustomVariableNameGenerator< Base >, CppAD::cg::LangMathMLCustomVariableNameGenerator< Base >, and CppAD::cg::LangCCustomVariableNameGenerator< Base >.

Referenced by CppAD::cg::LanguageMathML< Base >::createHtmlID(), CppAD::cg::LangCDefaultHessianVarNameGenerator< Base >::generateIndependent(), CppAD::cg::LangCDefaultReverse2VarNameGenerator< Base >::generateIndependent(), CppAD::cg::LanguageDot< Base >::generateSourceCode(), CppAD::cg::LanguageMathML< Base >::generateSourceCode(), CppAD::cg::LanguageLatex< Base >::generateSourceCode(), and CppAD::cg::LanguageLatex< Base >::requiresVariableDependencies().

◆ generateIndexedDependent()

template<class Base>

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

pure virtual

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

Implemented in CppAD::cg::LangMathMLDefaultVariableNameGenerator< Base >, CppAD::cg::LangLatexDefaultVariableNameGenerator< Base >, CppAD::cg::LangCDefaultVariableNameGenerator< Base >, CppAD::cg::LangCDefaultReverse2VarNameGenerator< Base >, and CppAD::cg::LangCDefaultHessianVarNameGenerator< Base >.

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

◆ generateIndexedIndependent()

template<class Base>

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

pure virtual

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

Implemented in CppAD::cg::LangMathMLDefaultVariableNameGenerator< Base >, CppAD::cg::LangLatexDefaultVariableNameGenerator< Base >, CppAD::cg::LangCDefaultVariableNameGenerator< Base >, CppAD::cg::LangCDefaultReverse2VarNameGenerator< Base >, and CppAD::cg::LangCDefaultHessianVarNameGenerator< Base >.

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

◆ generateTemporary()

template<class Base>

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

pure virtual

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

Implemented in CppAD::cg::LangCDefaultReverse2VarNameGenerator< Base >, CppAD::cg::LangMathMLDefaultVariableNameGenerator< Base >, CppAD::cg::LangLatexDefaultVariableNameGenerator< Base >, CppAD::cg::LangCDefaultVariableNameGenerator< Base >, and CppAD::cg::LangCDefaultHessianVarNameGenerator< Base >.

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

◆ generateTemporaryArray()

template<class Base>

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

pure virtual

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

Implemented in CppAD::cg::LangMathMLDefaultVariableNameGenerator< Base >, CppAD::cg::LangCDefaultReverse2VarNameGenerator< Base >, CppAD::cg::LangLatexDefaultVariableNameGenerator< Base >, CppAD::cg::LangCDefaultVariableNameGenerator< Base >, and CppAD::cg::LangCDefaultHessianVarNameGenerator< Base >.

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

◆ generateTemporarySparseArray()

template<class Base>

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

pure virtual

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

Implemented in CppAD::cg::LangMathMLDefaultVariableNameGenerator< Base >, CppAD::cg::LangLatexDefaultVariableNameGenerator< Base >, CppAD::cg::LangCDefaultVariableNameGenerator< Base >, CppAD::cg::LangCDefaultReverse2VarNameGenerator< Base >, and CppAD::cg::LangCDefaultHessianVarNameGenerator< Base >.

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

◆ getDependent()

template<class Base>

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

inlinevirtual

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

inlinevirtual

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>

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

pure virtual

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

Implemented in CppAD::cg::LangMathMLDefaultVariableNameGenerator< Base >, CppAD::cg::LangLatexDefaultVariableNameGenerator< Base >, CppAD::cg::LangCDefaultVariableNameGenerator< Base >, CppAD::cg::LangCDefaultReverse2VarNameGenerator< Base >, and CppAD::cg::LangCDefaultHessianVarNameGenerator< Base >.

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

◆ getIndependentArrayName()

template<class Base>

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

pure virtual

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

Implemented in CppAD::cg::LangMathMLDefaultVariableNameGenerator< Base >, CppAD::cg::LangLatexDefaultVariableNameGenerator< Base >, CppAD::cg::LangCDefaultVariableNameGenerator< Base >, CppAD::cg::LangCDefaultReverse2VarNameGenerator< Base >, and CppAD::cg::LangCDefaultHessianVarNameGenerator< Base >.

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

◆ getMaxTemporaryArrayVariableID()

template<class Base>

virtual size_t CppAD::cg::VariableNameGenerator< Base >::getMaxTemporaryArrayVariableID ( ) const

pure virtual

Provides the maximum variable ID of temporary dense array variables.

Implemented in CppAD::cg::LangCDefaultReverse2VarNameGenerator< Base >, CppAD::cg::LangCDefaultHessianVarNameGenerator< Base >, CppAD::cg::LangCDefaultVariableNameGenerator< Base >, CppAD::cg::LangLatexDefaultVariableNameGenerator< Base >, and CppAD::cg::LangMathMLDefaultVariableNameGenerator< Base >.

Referenced by CppAD::cg::LanguageMathML< Base >::generateSourceCode(), CppAD::cg::LanguageLatex< Base >::generateSourceCode(), CppAD::cg::LangCDefaultHessianVarNameGenerator< Base >::getMaxTemporaryArrayVariableID(), and CppAD::cg::LangCDefaultReverse2VarNameGenerator< Base >::getMaxTemporaryArrayVariableID().

◆ getMaxTemporarySparseArrayVariableID()

template<class Base>

virtual size_t CppAD::cg::VariableNameGenerator< Base >::getMaxTemporarySparseArrayVariableID ( ) const

pure virtual

Provides the maximum variable ID of temporary sparse array variables.

Implemented in CppAD::cg::LangCDefaultReverse2VarNameGenerator< Base >, CppAD::cg::LangCDefaultHessianVarNameGenerator< Base >, CppAD::cg::LangCDefaultVariableNameGenerator< Base >, CppAD::cg::LangLatexDefaultVariableNameGenerator< Base >, and CppAD::cg::LangMathMLDefaultVariableNameGenerator< Base >.

Referenced by CppAD::cg::LanguageMathML< Base >::generateSourceCode(), CppAD::cg::LanguageLatex< Base >::generateSourceCode(), CppAD::cg::LangCDefaultHessianVarNameGenerator< Base >::getMaxTemporarySparseArrayVariableID(), and CppAD::cg::LangCDefaultReverse2VarNameGenerator< Base >::getMaxTemporarySparseArrayVariableID().

◆ getMaxTemporaryVariableID()

template<class Base>

virtual size_t CppAD::cg::VariableNameGenerator< Base >::getMaxTemporaryVariableID ( ) const

pure virtual

Provides the maximum used variable ID of temporary variables.

Implemented in CppAD::cg::LangCDefaultReverse2VarNameGenerator< Base >, CppAD::cg::LangCDefaultHessianVarNameGenerator< Base >, CppAD::cg::LangCDefaultVariableNameGenerator< Base >, CppAD::cg::LangLatexDefaultVariableNameGenerator< Base >, and CppAD::cg::LangMathMLDefaultVariableNameGenerator< Base >.

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

◆ getMinTemporaryVariableID()

template<class Base>

virtual size_t CppAD::cg::VariableNameGenerator< Base >::getMinTemporaryVariableID ( ) const

pure virtual

Provides the minimum variable ID of temporary variables.

Implemented in CppAD::cg::LangCDefaultReverse2VarNameGenerator< Base >, CppAD::cg::LangCDefaultHessianVarNameGenerator< Base >, CppAD::cg::LangCDefaultVariableNameGenerator< Base >, CppAD::cg::LangLatexDefaultVariableNameGenerator< Base >, and CppAD::cg::LangMathMLDefaultVariableNameGenerator< Base >.

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

◆ getTemporary()

template<class Base>

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

inlinevirtual

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>

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

pure virtual

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

Implemented in CppAD::cg::LangMathMLDefaultVariableNameGenerator< Base >, CppAD::cg::LangCDefaultReverse2VarNameGenerator< Base >, CppAD::cg::LangLatexDefaultVariableNameGenerator< Base >, CppAD::cg::LangCDefaultVariableNameGenerator< Base >, and CppAD::cg::LangCDefaultHessianVarNameGenerator< Base >.

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

◆ getTemporaryVarArrayName()

template<class Base>

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

pure virtual

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

Implemented in CppAD::cg::LangMathMLDefaultVariableNameGenerator< Base >, CppAD::cg::LangCDefaultReverse2VarNameGenerator< Base >, CppAD::cg::LangLatexDefaultVariableNameGenerator< Base >, CppAD::cg::LangCDefaultVariableNameGenerator< Base >, and CppAD::cg::LangCDefaultHessianVarNameGenerator< Base >.

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

◆ isConsecutiveInIndepArray()

template<class Base>

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

pure virtual

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

Implemented in CppAD::cg::LangMathMLDefaultVariableNameGenerator< Base >, CppAD::cg::LangLatexDefaultVariableNameGenerator< Base >, CppAD::cg::LangCDefaultVariableNameGenerator< Base >, CppAD::cg::LangCDefaultReverse2VarNameGenerator< Base >, CppAD::cg::LangCDefaultHessianVarNameGenerator< Base >, CppAD::cg::LangLatexCustomVariableNameGenerator< Base >, CppAD::cg::LangMathMLCustomVariableNameGenerator< Base >, and CppAD::cg::LangCCustomVariableNameGenerator< Base >.

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

◆ isConsecutiveInTemporaryVarArray()

template<class Base>

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

pure virtual

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

Implemented in CppAD::cg::LangMathMLDefaultVariableNameGenerator< Base >, CppAD::cg::LangCDefaultReverse2VarNameGenerator< Base >, CppAD::cg::LangLatexDefaultVariableNameGenerator< Base >, CppAD::cg::LangCDefaultVariableNameGenerator< Base >, and CppAD::cg::LangCDefaultHessianVarNameGenerator< Base >.

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

◆ isInSameIndependentArray()

template<class Base>

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

pure virtual

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

Implemented in CppAD::cg::LangMathMLDefaultVariableNameGenerator< Base >, CppAD::cg::LangLatexDefaultVariableNameGenerator< Base >, CppAD::cg::LangCDefaultReverse2VarNameGenerator< Base >, CppAD::cg::LangCDefaultVariableNameGenerator< Base >, CppAD::cg::LangCDefaultHessianVarNameGenerator< Base >, CppAD::cg::LangLatexCustomVariableNameGenerator< Base >, CppAD::cg::LangMathMLCustomVariableNameGenerator< Base >, and CppAD::cg::LangCCustomVariableNameGenerator< Base >.

◆ isInSameTemporaryVarArray()

template<class Base>

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

pure virtual

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

Implemented in CppAD::cg::LangMathMLDefaultVariableNameGenerator< Base >, CppAD::cg::LangCDefaultReverse2VarNameGenerator< Base >, CppAD::cg::LangLatexDefaultVariableNameGenerator< Base >, CppAD::cg::LangCDefaultVariableNameGenerator< Base >, and CppAD::cg::LangCDefaultHessianVarNameGenerator< Base >.

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

◆ setTemporaryVariableID()

template<class Base>

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

pure virtual

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

Implemented in CppAD::cg::LangCDefaultReverse2VarNameGenerator< Base >, CppAD::cg::LangMathMLDefaultVariableNameGenerator< Base >, CppAD::cg::LangCDefaultHessianVarNameGenerator< Base >, CppAD::cg::LangLatexDefaultVariableNameGenerator< Base >, and CppAD::cg::LangCDefaultVariableNameGenerator< Base >.

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

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

include/cppad/cg/declare_cg.hpp
include/cppad/cg/variable_name_generator.hpp

Public Member Functions

Protected Attributes

Detailed Description

template<class Base> class CppAD::cg::VariableNameGenerator< 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::VariableNameGenerator< Base >