Kokkos::CisMatrix< OrdinalType, ScalarType > Class Template Reference

Kokkos::CisMatrix: Kokkos compressed index sparse matrix base class. More...

#include <Kokkos_CisMatrix.hpp>

Inheritance diagram for Kokkos::CisMatrix< OrdinalType, ScalarType >:

Inheritance graph
[legend]
List of all members.

Public Member Functions

Constructors/Destructor
virtual ~CisMatrix ()
 CisMatrix Destructor.
Matrix entry access methods
virtual int getIndices (OrdinalType i, OrdinalType &numEntries, OrdinalType *&indices) const =0
 Returns number of entries in ith row/column, and pointer to an array of these indices.
virtual int getValues (OrdinalType i, ScalarType *&values) const =0
 Returns a pointer to an array of values for the ith row/column.
Matrix Attribute access methods
virtual bool getIsRowOriented () const =0
 Returns true if the compressed index matrix should be interpreted as a row matrix.
virtual bool getIsUpperTriangular () const =0
 Returns true if the compressed index matrix has no entries below the diagonal.
virtual bool getIsLowerTriangular () const =0
 Returns true if the compressed index matrix has no entries above the diagonal.
virtual bool getHasImplicitUnitDiagonal () const =0
 Returns true if the compressed index matrix has no diagonal entries, but should be treated as unit diagonal.
virtual OrdinalType getNumRows () const =0
 Number of rows.
virtual OrdinalType getNumCols () const =0
 Number of columns.
virtual OrdinalType getNumEntries () const =0
 Number of matrix entries.

Detailed Description

template<typename OrdinalType, typename ScalarType>
class Kokkos::CisMatrix< OrdinalType, ScalarType >

Kokkos::CisMatrix: Kokkos compressed index sparse matrix base class.

The Kokkos::CisMatrix specifies the interface that any sparse matrix interfacing to the Kokkos Operators classes must implement.

At this time, the primary function provided by Kokkos::CisMatrix is access to matrix indices and values.


Member Function Documentation

template<typename OrdinalType, typename ScalarType>
virtual int Kokkos::CisMatrix< OrdinalType, ScalarType >::getIndices ( OrdinalType  i,
OrdinalType &  numEntries,
OrdinalType *&  indices 
) const [pure virtual]

Returns number of entries in ith row/column, and pointer to an array of these indices.

Extract the number of entries and a pointer to the indices in the ith row/column of the matrix. Note that the indices are not copied by this method. Memory allocation is handled by the matrix object itself.

Parameters:
i (In) The row (if getIsRowOriented() is true) or column that should be returned.
numEntries (Out) The number of entries in the ith row/column.
indices (Out) A pointer to the list of indices in the ith row/column.
Returns:
Integer error code, set to 0 if successful.

Implemented in Kokkos::HbMatrix< OrdinalType, ScalarType >, and Kokkos::OskiMatrix< OrdinalType, ScalarType >.

template<typename OrdinalType, typename ScalarType>
virtual int Kokkos::CisMatrix< OrdinalType, ScalarType >::getValues ( OrdinalType  i,
ScalarType *&  values 
) const [pure virtual]

Returns a pointer to an array of values for the ith row/column.

Extract the values in the ith row/column of the matrix. Note that the values are not copied by this method. Memory allocation is handled by the matrix object itself.

Parameters:
i (In) The row (if getIsRowOriented() is true) or column that should be returned.
numEntries (Out) The number of entries in the ith row/column.
indices (Out) A pointer to the list of indices in the ith row/column.
Returns:
Integer error code, set to 0 if successful.

Implemented in Kokkos::HbMatrix< OrdinalType, ScalarType >, and Kokkos::OskiMatrix< OrdinalType, ScalarType >.


The documentation for this class was generated from the following file:
Generated on Wed May 12 21:42:02 2010 for Kokkos by  doxygen 1.4.7