Sacado Package Browser (Single Doxygen Collection)  Version of the Day
Classes | Public Types | List of all members
Sacado::LFad::LogicalSparse< ValT, LogT > Class Template Reference

User inteface class for computing the logical sparsity pattern of a derivative via forward-mode AD. More...

#include <Sacado_LFad_LogicalSparse.hpp>

Inheritance diagram for Sacado::LFad::LogicalSparse< ValT, LogT >:
Inheritance graph
[legend]

Classes

struct  apply
 Turn LogicalSparse into a meta-function class usable with mpl::apply. More...
 

Public Types

typedef LogicalSparseImp< ValT, LogT > ImplType
 Base classes. More...
 
typedef Expr< ImplTypeExprType
 
typedef ExprType::value_type value_type
 Typename of values. More...
 
typedef ExprType::scalar_type scalar_type
 Typename of scalar's (which may be different from value_type) More...
 

Initialization methods

 LogicalSparse ()
 Default constructor. More...
 
template<typename S >
 LogicalSparse (const S &x, SACADO_ENABLE_VALUE_CTOR_DECL)
 Constructor with supplied value x of type ValueT. More...
 
 LogicalSparse (const int sz, const ValT &x)
 Constructor with size sz and value x. More...
 
 LogicalSparse (const int sz, const int i, const ValT &x)
 Constructor with size sz, index i, and value x. More...
 
 LogicalSparse (const LogicalSparse &x)
 Copy constructor. More...
 
template<typename S >
 LogicalSparse (const Expr< S > &x, SACADO_ENABLE_EXPR_CTOR_DECL)
 Copy constructor from any Expression object. More...
 
 ~LogicalSparse ()
 Destructor. More...
 

Detailed Description

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

User inteface class for computing the logical sparsity pattern of a derivative via forward-mode AD.

Definition at line 604 of file Sacado_LFad_LogicalSparse.hpp.

Member Typedef Documentation

◆ ImplType

template<typename ValT , typename LogT >
typedef LogicalSparseImp< ValT,LogT > Sacado::LFad::LogicalSparse< ValT, LogT >::ImplType

Base classes.

Definition at line 609 of file Sacado_LFad_LogicalSparse.hpp.

◆ ExprType

template<typename ValT , typename LogT >
typedef Expr<ImplType> Sacado::LFad::LogicalSparse< ValT, LogT >::ExprType

Definition at line 610 of file Sacado_LFad_LogicalSparse.hpp.

◆ value_type

template<typename ValT , typename LogT >
typedef ExprType::value_type Sacado::LFad::LogicalSparse< ValT, LogT >::value_type

Typename of values.

Definition at line 613 of file Sacado_LFad_LogicalSparse.hpp.

◆ scalar_type

template<typename ValT , typename LogT >
typedef ExprType::scalar_type Sacado::LFad::LogicalSparse< ValT, LogT >::scalar_type

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

Definition at line 616 of file Sacado_LFad_LogicalSparse.hpp.

Constructor & Destructor Documentation

◆ LogicalSparse() [1/6]

template<typename ValT , typename LogT >
Sacado::LFad::LogicalSparse< ValT, LogT >::LogicalSparse ( )
inline

Default constructor.

Initializes value to 0 and derivative array is empty

Definition at line 633 of file Sacado_LFad_LogicalSparse.hpp.

◆ LogicalSparse() [2/6]

template<typename ValT , typename LogT >
template<typename S >
Sacado::LFad::LogicalSparse< ValT, LogT >::LogicalSparse ( const S &  x,
SACADO_ENABLE_VALUE_CTOR_DECL   
)
inline

Constructor with supplied value x of type ValueT.

Initializes value to x and derivative array is empty

Definition at line 641 of file Sacado_LFad_LogicalSparse.hpp.

◆ LogicalSparse() [3/6]

template<typename ValT , typename LogT >
Sacado::LFad::LogicalSparse< ValT, LogT >::LogicalSparse ( const int  sz,
const ValT &  x 
)
inline

Constructor with size sz and value x.

Initializes value to x and derivative array 0 of length sz

Definition at line 648 of file Sacado_LFad_LogicalSparse.hpp.

◆ LogicalSparse() [4/6]

template<typename ValT , typename LogT >
Sacado::LFad::LogicalSparse< ValT, LogT >::LogicalSparse ( const int  sz,
const int  i,
const ValT &  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 657 of file Sacado_LFad_LogicalSparse.hpp.

◆ LogicalSparse() [5/6]

template<typename ValT , typename LogT >
Sacado::LFad::LogicalSparse< ValT, LogT >::LogicalSparse ( const LogicalSparse< ValT, LogT > &  x)
inline

Copy constructor.

Definition at line 661 of file Sacado_LFad_LogicalSparse.hpp.

◆ LogicalSparse() [6/6]

template<typename ValT , typename LogT >
template<typename S >
Sacado::LFad::LogicalSparse< ValT, LogT >::LogicalSparse ( const Expr< S > &  x,
SACADO_ENABLE_EXPR_CTOR_DECL   
)
inline

Copy constructor from any Expression object.

Definition at line 666 of file Sacado_LFad_LogicalSparse.hpp.

◆ ~LogicalSparse()

template<typename ValT , typename LogT >
Sacado::LFad::LogicalSparse< ValT, LogT >::~LogicalSparse ( )
inline

Destructor.

Definition at line 672 of file Sacado_LFad_LogicalSparse.hpp.


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