TMB Documentation  v1.9.11
Public Member Functions | Public Attributes | Friends | List of all members
sparse_matrix_exponential::expm_series< T > Struct Template Reference

Matrix exponential multiplied by vector. More...

#include <sparse_matrix_exponential.hpp>

Public Member Functions

vec operator() (vec x)
 Evaluate x^T*exp(A)
 
void update (Eigen::SparseMatrix< T > &A)
 

Public Attributes

vec A_values
 
config< T > cfg
 
TMBad::ADFun_packed F
 
TMBad::global::Complete< SpAxOp< T > > multiply
 
N
 

Friends

class TMBad::PackWrap< expm_series >
 

Detailed Description

template<class T>
struct sparse_matrix_exponential::expm_series< T >

Matrix exponential multiplied by vector.

This shared atomic operator can be used in cases where x^T*exp(A) needs to be calculated many times for same sparsity pattern. The number of terms (N) in series can be variable and retaping is triggered if (and only if) N changes compared to previous evaluation.

Note
Multiplication with vector is from the left: x^T * exp(A)

Definition at line 135 of file sparse_matrix_exponential.hpp.

Member Function Documentation

§ update()

template<class T>
void sparse_matrix_exponential::expm_series< T >::update ( Eigen::SparseMatrix< T > &  A)
inline

Helper to update generator

Definition at line 148 of file sparse_matrix_exponential.hpp.

Member Data Documentation

§ A_values

template<class T>
vec sparse_matrix_exponential::expm_series< T >::A_values

Vector of sparse matrix non zeros

Definition at line 140 of file sparse_matrix_exponential.hpp.

§ cfg

template<class T>
config<T> sparse_matrix_exponential::expm_series< T >::cfg

§ F

ADFun object that holds the entire matexp tape

Definition at line 144 of file sparse_matrix_exponential.hpp.

§ multiply

template<class T>
TMBad::global::Complete<SpAxOp<T> > sparse_matrix_exponential::expm_series< T >::multiply

Operator that multiplies sparse matrix with vector

Definition at line 142 of file sparse_matrix_exponential.hpp.

§ N

template<class T>
T sparse_matrix_exponential::expm_series< T >::N

Number of terms

Definition at line 138 of file sparse_matrix_exponential.hpp.


The documentation for this struct was generated from the following file:
License: GPL v2