Kokkos Node API and Local Linear Algebra Kernels Version of the Day
Public Member Functions
TSQR::MGS< LocalOrdinal, Scalar > Class Template Reference

Distributed-memory parallel implementation of Modified Gram-Schmidt. More...

#include <Tsqr_Mgs.hpp>

List of all members.

Public Member Functions

 MGS (const Teuchos::RCP< MessengerBase< Scalar > > &messenger)
 Constructor.
bool QR_produces_R_factor_with_nonnegative_diagonal () const
 Does the R factor have a nonnegative diagonal?
void mgs (const LocalOrdinal nrows_local, const LocalOrdinal ncols, Scalar A_local[], const LocalOrdinal lda_local, Scalar R[], const LocalOrdinal ldr)
 Use Modified Gram-Schmidt to orthogonalize a matrix A in place.

Detailed Description

template<class LocalOrdinal, class Scalar>
class TSQR::MGS< LocalOrdinal, Scalar >

Distributed-memory parallel implementation of Modified Gram-Schmidt.

Definition at line 69 of file Tsqr_Mgs.hpp.


Constructor & Destructor Documentation

template<class LocalOrdinal , class Scalar >
TSQR::MGS< LocalOrdinal, Scalar >::MGS ( const Teuchos::RCP< MessengerBase< Scalar > > &  messenger) [inline]

Constructor.

Parameters:
messenger[in/out] Communicator wrapper instance.

Definition at line 80 of file Tsqr_Mgs.hpp.


Member Function Documentation

template<class LocalOrdinal , class Scalar >
bool TSQR::MGS< LocalOrdinal, Scalar >::QR_produces_R_factor_with_nonnegative_diagonal ( ) const [inline]

Does the R factor have a nonnegative diagonal?

MGS implements a QR factorization (of a distributed matrix). Some, but not all, QR factorizations produce an R factor whose diagonal may include negative entries. This Boolean tells you whether MGS promises to compute an R factor whose diagonal entries are all nonnegative.

Definition at line 91 of file Tsqr_Mgs.hpp.

template<class LocalOrdinal , class Scalar >
void TSQR::MGS< LocalOrdinal, Scalar >::mgs ( const LocalOrdinal  nrows_local,
const LocalOrdinal  ncols,
Scalar  A_local[],
const LocalOrdinal  lda_local,
Scalar  R[],
const LocalOrdinal  ldr 
)

Use Modified Gram-Schmidt to orthogonalize a matrix A in place.

Definition at line 216 of file Tsqr_Mgs.hpp.


The documentation for this class was generated from the following file:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends