Implementation class for computing the logical sparsity of a derivative using forward-mode AD. More...

#include <Sacado_LFad_LogicalSparse.hpp>

Inheritance diagram for Sacado::LFad::LogicalSparseImp< ValT, LogT >:

Public Types
typedef ValT	value_type
	Typename of values (e.g., double) More...

typedef ScalarType< value_type > ::type	scalar_type
	Typename of scalar's (which may be different from ValT) More...

typedef LogT	logical_type
	Logical type (i.e., type for derivative array components (e.g., bool) More...

Public Types inherited from Sacado::Fad::DynamicStorage< ValT, LogT >
typedef ValT	value_type

Private Types
typedef Fad::DynamicStorage < ValT, LogT >	Storage

Initialization methods
	LogicalSparseImp ()
	Default constructor. More...

template<typename S >
	LogicalSparseImp (const S &x, SACADO_ENABLE_VALUE_CTOR_DECL)
	Constructor with supplied value `x`. More...

	LogicalSparseImp (const int sz, const value_type &x)
	Constructor with size `sz` and value `x`. More...

	LogicalSparseImp (const int sz, const int i, const value_type &x)
	Constructor with size `sz`, index `i`, and value `x`. More...

	LogicalSparseImp (const LogicalSparseImp &x)
	Copy constructor. More...

template<typename S >
	LogicalSparseImp (const Expr< S > &x, SACADO_ENABLE_EXPR_CTOR_DECL)
	Copy constructor from any Expression object. More...

	~LogicalSparseImp ()
	Destructor. More...

void	diff (const int ith, const int n)
	Set LogicalSparseImp object as the `ith` independent variable. More...

template<typename S >
	SACADO_ENABLE_EXPR_FUNC (bool) isEqualTo(const Expr< S > &x) const
	Returns whether two Fad objects have the same values. More...

Derivative accessor methods
bool	hasFastAccess () const
	Returns true if derivative array is not empty. More...

bool	isPassive () const
	Returns true if derivative array is empty. More...

void	setIsConstant (bool is_const)
	Set whether variable is constant. More...

Additional Inherited Members
Public Member Functions inherited from Sacado::Fad::DynamicStorage< ValT, LogT >
SACADO_INLINE_FUNCTION	DynamicStorage (const S &x, SACADO_ENABLE_VALUE_CTOR_DECL)
	Default constructor. More...

SACADO_INLINE_FUNCTION	DynamicStorage (const int sz, const ValT &x, const DerivInit zero_out=InitDerivArray)
	Constructor with size `sz`. More...

SACADO_INLINE_FUNCTION	DynamicStorage (const DynamicStorage &x)
	Copy constructor. More...

SACADO_INLINE_FUNCTION	~DynamicStorage ()
	Destructor. More...

SACADO_INLINE_FUNCTION DynamicStorage &	operator= (const DynamicStorage &x)
	Assignment. More...

SACADO_INLINE_FUNCTION int	size () const
	Returns number of derivative components. More...

SACADO_INLINE_FUNCTION int	length () const
	Returns array length. More...

SACADO_INLINE_FUNCTION void	resize (int sz)
	Resize the derivative array to sz. More...

SACADO_INLINE_FUNCTION void	resizeAndZero (int sz)
	Resize the derivative array to sz. More...

SACADO_INLINE_FUNCTION void	expand (int sz)
	Expand derivative array to size sz. More...

SACADO_INLINE_FUNCTION void	zero ()
	Zero out derivative array. More...

SACADO_INLINE_FUNCTION const ValT &	val () const
	Returns value. More...

SACADO_INLINE_FUNCTION ValT &	val ()
	Returns value. More...

SACADO_INLINE_FUNCTION const LogT *	dx () const
	Returns derivative array. More...

SACADO_INLINE_FUNCTION LogT	dx (int i) const
	Returns derivative component `i` with bounds checking. More...

SACADO_INLINE_FUNCTION LogT &	fastAccessDx (int i)
	Returns derivative component `i` without bounds checking. More...

SACADO_INLINE_FUNCTION const LogT &	fastAccessDx (int i) const
	Returns derivative component `i` without bounds checking. More...

Protected Attributes inherited from Sacado::Fad::DynamicStorage< ValT, LogT >
ValT	val_
	Value. More...

int	sz_
	Derivative array size. More...

int	len_
	Derivative array length. More...

LogT *	dx_
	Derivative array. More...

Detailed Description

template<typename ValT, typename LogT>
class Sacado::LFad::LogicalSparseImp< ValT, LogT >

Implementation class for computing the logical sparsity of a derivative using forward-mode AD.

Definition at line 65 of file Sacado_LFad_LogicalSparse.hpp.

Member Typedef Documentation

template<typename ValT, typename LogT>

typedef Fad::DynamicStorage<ValT,LogT> Sacado::LFad::LogicalSparseImp< ValT, LogT >::Storage

private

Definition at line 68 of file Sacado_LFad_LogicalSparse.hpp.

template<typename ValT, typename LogT>

typedef ValT Sacado::LFad::LogicalSparseImp< ValT, LogT >::value_type

Typename of values (e.g., double)

Definition at line 73 of file Sacado_LFad_LogicalSparse.hpp.

template<typename ValT, typename LogT>

typedef ScalarType<value_type>::type Sacado::LFad::LogicalSparseImp< ValT, LogT >::scalar_type

Typename of scalar's (which may be different from ValT)

Definition at line 76 of file Sacado_LFad_LogicalSparse.hpp.

template<typename ValT, typename LogT>

typedef LogT Sacado::LFad::LogicalSparseImp< ValT, LogT >::logical_type

Logical type (i.e., type for derivative array components (e.g., bool)

Definition at line 79 of file Sacado_LFad_LogicalSparse.hpp.

Constructor & Destructor Documentation

template<typename ValT, typename LogT>

Sacado::LFad::LogicalSparseImp< ValT, LogT >::LogicalSparseImp ( )

inline

Default constructor.

Definition at line 87 of file Sacado_LFad_LogicalSparse.hpp.

template<typename ValT, typename LogT>

template<typename S >

Sacado::LFad::LogicalSparseImp< ValT, LogT >::LogicalSparseImp	(	const S &	x,
		SACADO_ENABLE_VALUE_CTOR_DECL
	)

inline

Constructor with supplied value x.

Initializes value to x and derivative array is empty

Definition at line 94 of file Sacado_LFad_LogicalSparse.hpp.

template<typename ValT, typename LogT>

Sacado::LFad::LogicalSparseImp< ValT, LogT >::LogicalSparseImp	(	const int	sz,
		const value_type &	x
	)

inline

Constructor with size sz and value x.

Initializes value to x and derivative array 0 of length sz

Definition at line 101 of file Sacado_LFad_LogicalSparse.hpp.

template<typename ValT, typename LogT>

Sacado::LFad::LogicalSparseImp< ValT, LogT >::LogicalSparseImp	(	const int	sz,
		const int	i,
		const value_type &	x
	)

inline

Constructor with size sz, index i, and value x.

Initializes value to x and derivative array of length sz as row i of the identity matrix, i.e., sets derivative component i to 1 and all other's to zero.

Definition at line 110 of file Sacado_LFad_LogicalSparse.hpp.

template<typename ValT, typename LogT>

Sacado::LFad::LogicalSparseImp< ValT, LogT >::LogicalSparseImp ( const LogicalSparseImp< ValT, LogT > & x )

inline

Copy constructor.

Definition at line 116 of file Sacado_LFad_LogicalSparse.hpp.

template<typename ValT, typename LogT>

template<typename S >

Sacado::LFad::LogicalSparseImp< ValT, LogT >::LogicalSparseImp	(	const Expr< S > &	x,
		SACADO_ENABLE_EXPR_CTOR_DECL
	)

inline

Copy constructor from any Expression object.

Definition at line 121 of file Sacado_LFad_LogicalSparse.hpp.

template<typename ValT, typename LogT>

Sacado::LFad::LogicalSparseImp< ValT, LogT >::~LogicalSparseImp ( )

inline

Destructor.

Definition at line 141 of file Sacado_LFad_LogicalSparse.hpp.

Member Function Documentation

template<typename ValT, typename LogT>

void Sacado::LFad::LogicalSparseImp< ValT, LogT >::diff	(	const int	ith,
		const int	n
	)

inline

Set LogicalSparseImp object as the ith independent variable.

Sets the derivative array of length n to the ith row of the identity matrix and has the same affect as the Implementation(const int sz, const int i, const T & x) constructor.

Definition at line 150 of file Sacado_LFad_LogicalSparse.hpp.

template<typename ValT, typename LogT>

template<typename S >

Sacado::LFad::LogicalSparseImp< ValT, LogT >::SACADO_ENABLE_EXPR_FUNC ( bool ) const

inline

Returns whether two Fad objects have the same values.

Definition at line 160 of file Sacado_LFad_LogicalSparse.hpp.

template<typename ValT, typename LogT>

bool Sacado::LFad::LogicalSparseImp< ValT, LogT >::hasFastAccess ( ) const

inline

Returns true if derivative array is not empty.

Definition at line 177 of file Sacado_LFad_LogicalSparse.hpp.