CppAD::cg::LinearIndexPattern Class Reference

Inheritance diagram for CppAD::cg::LinearIndexPattern:

Collaboration diagram for CppAD::cg::LinearIndexPattern:

Public Member Functions
	LinearIndexPattern (long xOffset, long dy, long dx, long b)
long	getXOffset () const
long	getLinearSlopeDy () const
void	setLinearSlopeDy (long dy)
long	getLinearSlopeDx () const
long	getLinearConstantTerm () const
void	setLinearConstantTerm (long b)
IndexPatternType	getType () const override
void	getSubIndexes (std::set< IndexPattern *> &indexes) const override
long	evaluate (long x) const

Static Public Member Functions
template<class VectorSizeT >
static IndexPattern *	detect (const VectorSizeT &x2y)
static IndexPattern *	detect (const std::map< size_t, size_t > &x2y)
static bool	isConstant (const IndexPattern &ip)

Protected Attributes
long	xOffset_
long	dy_
long	dx_
long	b_

Detailed Description

Linear pattern y = ((x - offset) / dx) * dy + b

Definition at line 25 of file linear_index_pattern.hpp.

Member Function Documentation

detect() [1/2]

template<class VectorSizeT >

IndexPattern * CppAD::cg::IndexPattern::detect ( const VectorSizeT &  x2y )

inlinestaticinherited

Detects the index pattern for the provided points (y = f(x))

Parameters

indexX	the index of the independents (x)
x2y	maps the independents to the dependents (indexes[x] = y )

Returns

the generated index pattern (must be deleted by user)

Definition at line 22 of file index_pattern_impl.hpp.

Referenced by CppAD::cg::Plane2DIndexPattern::detectPlane2D(), CppAD::cg::LoopModel< Base >::getIndexedTapeIndexes(), CppAD::cg::ModelCSourceGen< Base >::prepareSparseForwardOneWithLoops(), CppAD::cg::ModelCSourceGen< Base >::prepareSparseJacobianRowWithLoops(), and CppAD::cg::ModelCSourceGen< Base >::prepareSparseReverseOneWithLoops().

detect() [2/2]

IndexPattern * CppAD::cg::IndexPattern::detect ( const std::map< size_t, size_t > &  x2y )

inlinestaticinherited

Detects the index pattern for the provided points (y = f(x))

Parameters

indexX	the index of the independents (x)
x2y	maps the independents to the dependents (x,y)

Returns

the generated index pattern (must be deleted by user)

Definition at line 38 of file index_pattern_impl.hpp.

---

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

• include/cppad/cg/patterns/index/linear_index_pattern.hpp