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 (std::string arg1, types::blas_int arg2)
static ::ExceptionBase &	ExcState (State arg1)
static ::ExceptionBase &	ExcProperty (Property arg1)
static ::ExceptionBase &	ExcMissing (std::string arg1)

Variables
constexpr char	A = 'A'
constexpr char	N = 'N'
constexpr char	O = 'O'
constexpr char	T = 'T'
constexpr char	U = 'U'
constexpr char	L = 'L'
constexpr char	V = 'V'
constexpr types::blas_int	zero = 0
constexpr types::blas_int	one = 1

Detailed Description

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

Enumeration Type Documentation

State

enum LAPACKSupport::State

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.

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 53 of file lapack_support.h.

Property

enum LAPACKSupport::Property

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 106 of file lapack_support.h.

Function Documentation

state_name()

const char * LAPACKSupport::state_name ( State  s )

inline

Function printing the name of a State.

Definition at line 77 of file lapack_support.h.

property_name()

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

inline

Function printing the name of a Property.

Definition at line 126 of file lapack_support.h.

Variable Documentation

A

constexpr char LAPACKSupport::A = 'A'

constexpr

Character constant.

Definition at line 151 of file lapack_support.h.

N

constexpr char LAPACKSupport::N = 'N'

constexpr

Character constant.

Definition at line 155 of file lapack_support.h.

O

constexpr char LAPACKSupport::O = 'O'

constexpr

Character constant.

Definition at line 159 of file lapack_support.h.

T

constexpr char LAPACKSupport::T = 'T'

constexpr

Character constant.

Definition at line 163 of file lapack_support.h.

U

constexpr char LAPACKSupport::U = 'U'

constexpr

Character constant.

Definition at line 167 of file lapack_support.h.

L

constexpr char LAPACKSupport::L = 'L'

constexpr

Character constant.

Definition at line 171 of file lapack_support.h.

V

constexpr char LAPACKSupport::V = 'V'

constexpr

Character constant.

Definition at line 175 of file lapack_support.h.

zero

constexpr types::blas_int LAPACKSupport::zero = 0

constexpr

Integer constant.

Definition at line 179 of file lapack_support.h.

one

constexpr types::blas_int LAPACKSupport::one = 1

constexpr

Integer constant.

Definition at line 183 of file lapack_support.h.