Complex General Band Matrix. More...

#include "matrix.hpp"

Collaboration diagram for orb5x::spclibs::ZGBMat:

Public Member Functions
bool	is_initialized () const

int	lda () const

	ZGBMat ()=default
	Construct an empty complex band-matrix descriptor.

Public Attributes
int	kl = 0
	Number of subdiagonals.

int	kmat = 0
	Caller-defined matrix identifier.

int	ku = 0
	Number of superdiagonals.

int	mrows = 0
	Number of logical rows.

int	ncols = 0
	Number of logical columns.

int	nterms = 0
	Informational count of assembled nonzero terms.

std::vector< int >	piv
	One-based LAPACK LU pivot indices.

int	rank = 0
	Algebraic matrix rank/dimension used by solves.

Kokkos::View< Complex **, Kokkos::HostSpace >	val
	Complex LAPACK general-band storage.

Detailed Description

Complex General Band Matrix.

Constructor & Destructor Documentation

◆ ZGBMat()

orb5x::spclibs::ZGBMat::ZGBMat ( )

default

Construct an empty complex band-matrix descriptor.

Member Function Documentation

◆ is_initialized()

bool orb5x::spclibs::ZGBMat::is_initialized ( ) const

inline

Returns: true when complex band storage is allocated.

References val.

Referenced by orb5x::Zbmat::has_matrix(), and orb5x::spclibs::ZPeriodicMat::is_initialized().

◆ lda()

int orb5x::spclibs::ZGBMat::lda ( ) const

inline

Returns: LAPACK general-band leading dimension 2*kl+ku+1.

References kl, and ku.

Member Data Documentation

◆ kl

int orb5x::spclibs::ZGBMat::kl = 0

Number of subdiagonals.

Referenced by lda().

◆ kmat

int orb5x::spclibs::ZGBMat::kmat = 0

Caller-defined matrix identifier.

◆ ku

int orb5x::spclibs::ZGBMat::ku = 0

Number of superdiagonals.

Referenced by lda().

◆ mrows

int orb5x::spclibs::ZGBMat::mrows = 0

Number of logical rows.

◆ ncols

int orb5x::spclibs::ZGBMat::ncols = 0

Number of logical columns.

◆ nterms

int orb5x::spclibs::ZGBMat::nterms = 0

Informational count of assembled nonzero terms.

◆ piv

std::vector<int> orb5x::spclibs::ZGBMat::piv

One-based LAPACK LU pivot indices.

◆ rank

int orb5x::spclibs::ZGBMat::rank = 0

Algebraic matrix rank/dimension used by solves.

Referenced by orb5x::Zbmat::get_rank().

◆ val

Kokkos::View<Complex**, Kokkos::HostSpace> orb5x::spclibs::ZGBMat::val

Complex LAPACK general-band storage.

Referenced by is_initialized().

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

matrix.hpp

Public Member Functions

Public Attributes