Reference documentation for deal.II version Git d228448 2017-10-17 21:17:08 +0200
Enumerations | Functions | Variables
LAPACKSupport Namespace Reference

Enumerations

enum  State {
  matrix, inverse_matrix, lu, cholesky,
  eigenvalues, svd, inverse_svd, unusable = 0x8000
}
 
enum  Property {
  general = 0, symmetric = 1, upper_triangular = 2, lower_triangular = 4,
  diagonal = 6, hessenberg = 8
}
 

Functions

const char * state_name (State s)
 
const char * property_name (const Property s)
 
static::ExceptionBase & ExcErrorCode (char *arg1, int arg2)
 
static::ExceptionBase & ExcState (State arg1)
 
static::ExceptionBase & ExcProperty (Property arg1)
 
static::ExceptionBase & ExcMissing (char *arg1)
 

Variables

static const char A = 'A'
 
static const char N = 'N'
 
static const char T = 'T'
 
static const char U = 'U'
 
static const char L = 'L'
 
static const char V = 'V'
 
static const int zero = 0
 
static const int one = 1
 

Detailed Description

A namespace containing constants, exceptions, enumerations, and other utilities used by the deal.II LAPACK bindings.

Enumeration Type Documentation

Most of the LAPACK functions one can apply to a matrix (e.g., by calling the member functions of this class) change its content in some ways. For example, they may invert the matrix, or may replace it by a matrix whose columns represent the eigenvectors of the original content of the matrix. The elements of this enumeration are therefore used to track what is currently being stored by this object.

Author
Guido Kanschat, 2005
Enumerator
matrix 

Contents is actually a matrix.

inverse_matrix 

Contents is the inverse of a matrix.

lu 

Contents is an LU decomposition.

cholesky 

Contents is a Cholesky decomposition.

eigenvalues 

Eigenvalue vector is filled.

svd 

Matrix contains singular value decomposition,.

inverse_svd 

Matrix is the inverse of a singular value decomposition.

unusable 

Contents is something useless.

Definition at line 42 of file lapack_support.h.

A matrix can have certain features allowing for optimization, but hard to test. These are listed here.

Enumerator
general 

No special properties.

symmetric 

Matrix is symmetric.

upper_triangular 

Matrix is upper triangular.

lower_triangular 

Matrix is lower triangular.

diagonal 

Matrix is diagonal.

hessenberg 

Matrix is in upper Hessenberg form.

Definition at line 92 of file lapack_support.h.

Function Documentation

const char* LAPACKSupport::state_name ( State  s)
inline

Function printing the name of a State.

Definition at line 65 of file lapack_support.h.

const char* LAPACKSupport::property_name ( const Property  s)
inline

Function printing the name of a Property.

Definition at line 111 of file lapack_support.h.

Variable Documentation

const char LAPACKSupport::A = 'A'
static

Character constant.

Definition at line 136 of file lapack_support.h.

const char LAPACKSupport::N = 'N'
static

Character constant.

Definition at line 140 of file lapack_support.h.

const char LAPACKSupport::T = 'T'
static

Character constant.

Definition at line 144 of file lapack_support.h.

const char LAPACKSupport::U = 'U'
static

Character constant.

Definition at line 148 of file lapack_support.h.

const char LAPACKSupport::L = 'L'
static

Character constant.

Definition at line 152 of file lapack_support.h.

const char LAPACKSupport::V = 'V'
static

Character constant.

Definition at line 156 of file lapack_support.h.

const int LAPACKSupport::zero = 0
static

Integer constant.

Definition at line 160 of file lapack_support.h.

const int LAPACKSupport::one = 1
static

Integer constant.

Definition at line 164 of file lapack_support.h.