Mathter
A configurable 3D math library for game developers.
Public Member Functions | Public Attributes | Friends | List of all members
mathter::DecompositionLU< T, Dim, Order, Layout, Packed > Class Template Reference

A utility class that can do common operations with the LU decomposition, i.e. solving equation systems. More...

#include <DecomposeLU.hpp>

Public Member Functions

 DecompositionLU (MatrixT L, MatrixT U)
 
Vector< float, Dim, Packed > Solve (const Vector< T, Dim, Packed > &b) const
 Solves the equation system Ax=b, that is LUx=b. More...
 
bool Solvable () const
 

Public Attributes

MatrixT L
 
Parameters
LLower triangular matrix, LU=P'A.
More...
 
MatrixT U
 
Parameters
UUpper triangular matrix, LU=P'A.
More...
 

Friends

template<class T2 , int Dim2, eMatrixOrder Order2, eMatrixLayout Layout2, bool Packed2>
class DecompositionLUP
 

Detailed Description

template<class T, int Dim, eMatrixOrder Order, eMatrixLayout Layout, bool Packed>
class mathter::DecompositionLU< T, Dim, Order, Layout, Packed >

A utility class that can do common operations with the LU decomposition, i.e. solving equation systems.

Constructor & Destructor Documentation

◆ DecompositionLU()

template<class T , int Dim, eMatrixOrder Order, eMatrixLayout Layout, bool Packed>
mathter::DecompositionLU< T, Dim, Order, Layout, Packed >::DecompositionLU ( MatrixT  L,
MatrixT  U 
)
inline

Member Function Documentation

◆ Solvable()

template<class T , int Dim, eMatrixOrder Order, eMatrixLayout Layout, bool Packed>
bool mathter::DecompositionLU< T, Dim, Order, Layout, Packed >::Solvable ( ) const
inline

◆ Solve()

template<class T , int Dim, eMatrixOrder Order, eMatrixLayout Layout, bool Packed>
Vector<float, Dim, Packed> mathter::DecompositionLU< T, Dim, Order, Layout, Packed >::Solve ( const Vector< T, Dim, Packed > &  b) const
inline

Solves the equation system Ax=b, that is LUx=b.

If the equation is singular or the LU decomposition fails, garbage is returned.

Parameters
bThe right hand side vector.
Returns
The solution x.

Friends And Related Function Documentation

◆ DecompositionLUP

template<class T , int Dim, eMatrixOrder Order, eMatrixLayout Layout, bool Packed>
template<class T2 , int Dim2, eMatrixOrder Order2, eMatrixLayout Layout2, bool Packed2>
friend class DecompositionLUP
friend

Member Data Documentation

◆ L

template<class T , int Dim, eMatrixOrder Order, eMatrixLayout Layout, bool Packed>
MatrixT mathter::DecompositionLU< T, Dim, Order, Layout, Packed >::L

Parameters
LLower triangular matrix, LU=P'A.

◆ U

template<class T , int Dim, eMatrixOrder Order, eMatrixLayout Layout, bool Packed>
MatrixT mathter::DecompositionLU< T, Dim, Order, Layout, Packed >::U

Parameters
UUpper triangular matrix, LU=P'A.


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