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

#include <Tsqr_MatView.hpp>

Inheritance diagram for TSQR::ConstMatView< Ordinal, Scalar >:
Inheritance graph
[legend]

List of all members.

Public Member Functions

 ConstMatView (const Ordinal num_rows, const Ordinal num_cols, const Scalar *const A, const Ordinal leading_dim)
ConstMatView rowBlock (const Ordinal firstRow, const Ordinal lastRow) const
ConstMatView split_top (const Ordinal nrows_top, const bool b_contiguous_blocks=false)
ConstMatView split_bottom (const Ordinal nrows_bottom, const bool b_contiguous_blocks=false)

Detailed Description

template<class Ordinal, class Scalar>
class TSQR::ConstMatView< Ordinal, Scalar >

A read-only view of a column-oriented matrix.

Note:
Implicit promotion of a MatView to a ConstMatView is forbidden, because it violates the expectation that ConstMatView points to a matrix that doesn't change during the computation.

Definition at line 410 of file Tsqr_MatView.hpp.


Constructor & Destructor Documentation

template<class Ordinal, class Scalar>
TSQR::ConstMatView< Ordinal, Scalar >::ConstMatView ( const Ordinal  num_rows,
const Ordinal  num_cols,
const Scalar *const  A,
const Ordinal  leading_dim 
) [inline]
Note:
g++ with -Wall wants A_ to be initialized after lda_, otherwise it emits a compiler warning.

Definition at line 420 of file Tsqr_MatView.hpp.


Member Function Documentation

template<class Ordinal, class Scalar>
ConstMatView TSQR::ConstMatView< Ordinal, Scalar >::rowBlock ( const Ordinal  firstRow,
const Ordinal  lastRow 
) const [inline]

Return a "row block" (submatrix of consecutive rows in the inclusive range [firstRow,lastRow]).

Definition at line 483 of file Tsqr_MatView.hpp.

template<class Ordinal, class Scalar>
ConstMatView TSQR::ConstMatView< Ordinal, Scalar >::split_top ( const Ordinal  nrows_top,
const bool  b_contiguous_blocks = false 
) [inline]

Split off and return the top block. Modify *this to be the "rest" of the matrix.

Note:
Only use this method to split off a single cache block. It breaks if you try to use it otherwise.
Parameters:
nrows_top[in] Number of rows in the top block (which this method returns)
b_contiguous_blocks[in] Whether or not the entries of the top block are stored contiguously in *this. The default is no (false).
Returns:
The top block of nrows_top rows. Data is a shallow copy of the data in *this.

Definition at line 509 of file Tsqr_MatView.hpp.

template<class Ordinal, class Scalar>
ConstMatView TSQR::ConstMatView< Ordinal, Scalar >::split_bottom ( const Ordinal  nrows_bottom,
const bool  b_contiguous_blocks = false 
) [inline]

Split off and return the bottom block. Modify *this to be the "rest" of the matrix.

Definition at line 546 of file Tsqr_MatView.hpp.


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