ADOLC Namespace Reference

Namespaces
namespace	CP
namespace	detail
namespace	Sparse

Classes
struct	AbsNormalForm
	Dense abs-normal form container backed by contiguous storage. More...
struct	ANFShape
	Base tag for abs-normal form shapes. More...
struct	DenseShape
	Stores the principal dimensions of a dense abs-normal form. More...

Concepts
concept	DerivedFromANFShape
concept	AbsNormalFormType
	Structural concept for abs-normal form objects.

Enumerations
enum class	UpdateConsts { True , False }
	Compile-time selector for constant-term updates in ADOLC::abs_normal. More...

Functions
DenseShape	getShapeFromTape (short tapeId)
template<UpdateConsts uc = UpdateConsts::True>
ADOLC_API int	abs_normal (short tapeId, std::span< const double > x, AbsNormalForm &anf)
	Compute the abs-normal form of a taped function at a point.
template<>
ADOLC_API int	abs_normal< UpdateConsts::True > (short tapeId, std::span< const double > x, AbsNormalForm &anf)
	Specialization that updates cy and cz after evaluation.
template<>
ADOLC_API int	abs_normal< UpdateConsts::False > (short tapeId, std::span< const double > x, AbsNormalForm &anf)
	Specialization that leaves cy and cz unchanged.

Enumeration Type Documentation

UpdateConsts

enum class ADOLC::UpdateConsts

strong

Compile-time selector for constant-term updates in ADOLC::abs_normal.

• UpdateConsts::True computes cy and cz after the abs-normal form data has been populated.
• UpdateConsts::False leaves cy and cz untouched.

Enumerator
True
False

Function Documentation

abs_normal()

template<UpdateConsts uc = UpdateConsts::True>

ADOLC_API int ADOLC::abs_normal	(	short	tapeId,
		std::span< const double >	x,
		AbsNormalForm &	anf
	)

Compute the abs-normal form of a taped function at a point.

Parameters

tapeId	Tape identifier.
x	Span view of the base point (input values).
anf	AbsNormalForm object to store results.

Template Parameters

uc	Dispatcher for version with or without updating the constant terms cy and cz.

Returns

Zero on success, nonzero on failure.

abs_normal< UpdateConsts::False >()

template<>

ADOLC_API int ADOLC::abs_normal< UpdateConsts::False >	(	short	tapeId,
		std::span< const double >	x,
		AbsNormalForm &	anf
	)

Specialization that leaves cy and cz unchanged.

abs_normal< UpdateConsts::True >()

template<>

ADOLC_API int ADOLC::abs_normal< UpdateConsts::True >	(	short	tapeId,
		std::span< const double >	x,
		AbsNormalForm &	anf
	)

Specialization that updates cy and cz after evaluation.

getShapeFromTape()

DenseShape ADOLC::getShapeFromTape

(

short

tapeId

)