0.3.0
Loading...
Searching...
No Matches
Public Member Functions | Private Member Functions | Private Attributes | List of all members
NAV::CubicSpline< Scalar >::BandMatrix Class Reference

Sparse matrix whose non-zero entries are confined to a diagonal band, comprising the main diagonal and zero or more diagonals on either side. More...

Public Member Functions

 BandMatrix (size_t dim, size_t nUpper, size_t nLower)
 Constructor.
 
std::vector< Scalar > lu_solve (const std::vector< Scalar > &b, bool is_lu_decomposed=false)
 
Scalar & operator() (size_t i, size_t j)
 Access operator i ∈ [i=0,...,dim()-1].
 
const Scalar & operator() (size_t i, size_t j) const
 Access operator i ∈ [i=0,...,dim()-1].
 

Private Member Functions

size_t dim () const
 Returns the matrix dimension.
 
size_t dimLowerBand () const
 Returns the dimension of the lower band.
 
size_t dimUpperBand () const
 Returns the dimension of the upper band.
 
std::vector< Scalar > l_solve (const std::vector< Scalar > &b) const
 Solves the equation Lx = b for x.
 
void lu_decompose ()
 Calculate the LU decomposition.
 
std::vector< Scalar > u_solve (const std::vector< Scalar > &b) const
 Solves the equation Ux = b for x.
 

Private Attributes

std::vector< std::vector< Scalar > > lowerBand
 lower diagonal band
 
std::vector< std::vector< Scalar > > upperBand
 upper diagonal band
 

Detailed Description

template<typename Scalar>
class NAV::CubicSpline< Scalar >::BandMatrix

Sparse matrix whose non-zero entries are confined to a diagonal band, comprising the main diagonal and zero or more diagonals on either side.

Constructor & Destructor Documentation

◆ BandMatrix()

template<typename Scalar >
NAV::CubicSpline< Scalar >::BandMatrix::BandMatrix ( size_t dim,
size_t nUpper,
size_t nLower )
inline

Constructor.

Parameters
[in]dimDimension of the matrix
[in]nUpperAmount of upper diagonals
[in]nLowerAmount of lower diagonals

Member Function Documentation

◆ lu_solve()

template<typename Scalar >
std::vector< Scalar > NAV::CubicSpline< Scalar >::BandMatrix::lu_solve ( const std::vector< Scalar > & b,
bool is_lu_decomposed = false )
inlinenodiscard

Solves the linear equations Ax = b for x by obtaining the LU decomposition A = LU and solving

  • Ly = b for y
  • Ux = y for x
The documentation for this class was generated from the following file: