Kokkos Node API and Local Linear Algebra Kernels Version of the Day
Protected Member Functions
Kokkos::CrsGraphHostCompute< Ordinal, Node, LocalMatOps > Class Template Reference

A default host-compute compressed-row sparse graph. More...

#include <Kokkos_CrsGraph.hpp>

Inheritance diagram for Kokkos::CrsGraphHostCompute< Ordinal, Node, LocalMatOps >:
Inheritance graph
[legend]

List of all members.

Public Member Functions

Constructors/Destructor
 CrsGraphHostCompute (size_t numRows, const RCP< Node > &node)
 Default CrsGraphHostCompute constuctor.
virtual ~CrsGraphHostCompute ()
 CrsGraphHostCompute Destructor.
Accessor routines.
RCP< Node > getNode () const
 Node accessor.
Data entry and accessor methods.
size_t getNumRows () const
 Return the number of rows in the graph.
size_t getNumEntries () const
 Return the number of entries in the graph.
bool isEmpty () const
 Indicates that the graph is filled, but empty.
bool isFinalized () const
 Indicatest that the graph has been finalized.
bool is1DStructure () const
 Indicate that the structure is 1D. It will never be the case that both is1DStructure() and is2DStructure() return true.
bool is2DStructure () const
 Indicate that the structure is 2D. It will never be the case that both is1DStructure() and is2DStructure() return true.
bool isOptimized () const
 Indicate that the stucture is optimized.
void set1DStructure (ArrayRCP< Ordinal > inds, ArrayRCP< size_t > rowBegs, ArrayRCP< size_t > rowEnds)
 Submit the indices and offset for 1D storage.
void set2DStructure (ArrayRCP< ArrayRCP< Ordinal > > inds, ArrayRCP< size_t > numEntriesPerRow)
 Submit the indices for 2D storage.
void get1DStructure (ArrayRCP< Ordinal > &inds, ArrayRCP< size_t > &rowBegs, ArrayRCP< size_t > &rowEnds)
 Retrieve the structure for 1D storage.
void get2DStructure (ArrayRCP< ArrayRCP< Ordinal > > &inds, ArrayRCP< size_t > &numEntriesPerRow)
 Retrieve the structure for 2D storage.
void finalize (bool OptimizeStorage)
 Instruct the graph to perform any necessary manipulation, including (optionally) optimizing the storage of the graph data.
template<class Scalar >
void finalize (bool OptimizeStorage, ArrayRCP< ArrayRCP< Scalar > > &values2D, ArrayRCP< Scalar > &values1D)
virtual void clear ()
 Release data associated with this graph.

Protected Member Functions

 CrsGraphHostCompute (const CrsGraphHostCompute &sources)
 Copy constructor (protected and not implemented)

Detailed Description

template<class Ordinal, class Node, class LocalMatOps>
class Kokkos::CrsGraphHostCompute< Ordinal, Node, LocalMatOps >

A default host-compute compressed-row sparse graph.

Definition at line 54 of file Kokkos_CrsGraph.hpp.


Constructor & Destructor Documentation

template<class Ordinal , class Node, class LocalMatOps >
Kokkos::CrsGraphHostCompute< Ordinal, Node, LocalMatOps >::CrsGraphHostCompute ( size_t  numRows,
const RCP< Node > &  node 
)

Default CrsGraphHostCompute constuctor.

Definition at line 183 of file Kokkos_CrsGraph.hpp.

template<class Ordinal , class Node , class LocalMatOps >
Kokkos::CrsGraphHostCompute< Ordinal, Node, LocalMatOps >::~CrsGraphHostCompute ( ) [virtual]

CrsGraphHostCompute Destructor.

Definition at line 192 of file Kokkos_CrsGraph.hpp.

template<class Ordinal, class Node, class LocalMatOps>
Kokkos::CrsGraphHostCompute< Ordinal, Node, LocalMatOps >::CrsGraphHostCompute ( const CrsGraphHostCompute< Ordinal, Node, LocalMatOps > &  sources) [protected]

Copy constructor (protected and not implemented)


Member Function Documentation

template<class Ordinal , class Node , class LocalMatOps >
RCP< Node > Kokkos::CrsGraphHostCompute< Ordinal, Node, LocalMatOps >::getNode ( ) const

Node accessor.

Definition at line 213 of file Kokkos_CrsGraph.hpp.

template<class Ordinal , class Node , class LocalMatOps >
size_t Kokkos::CrsGraphHostCompute< Ordinal, Node, LocalMatOps >::getNumRows ( ) const

Return the number of rows in the graph.

Definition at line 219 of file Kokkos_CrsGraph.hpp.

template<class Ordinal , class Node , class LocalMatOps >
size_t Kokkos::CrsGraphHostCompute< Ordinal, Node, LocalMatOps >::getNumEntries ( ) const

Return the number of entries in the graph.

Definition at line 225 of file Kokkos_CrsGraph.hpp.

template<class Ordinal , class Node , class LocalMatOps >
bool Kokkos::CrsGraphHostCompute< Ordinal, Node, LocalMatOps >::isEmpty ( ) const

Indicates that the graph is filled, but empty.

Definition at line 231 of file Kokkos_CrsGraph.hpp.

template<class Ordinal , class Node , class LocalMatOps >
bool Kokkos::CrsGraphHostCompute< Ordinal, Node, LocalMatOps >::isFinalized ( ) const

Indicatest that the graph has been finalized.

Definition at line 237 of file Kokkos_CrsGraph.hpp.

template<class Ordinal , class Node , class LocalMatOps >
bool Kokkos::CrsGraphHostCompute< Ordinal, Node, LocalMatOps >::is1DStructure ( ) const

Indicate that the structure is 1D. It will never be the case that both is1DStructure() and is2DStructure() return true.

Definition at line 243 of file Kokkos_CrsGraph.hpp.

template<class Ordinal , class Node , class LocalMatOps >
bool Kokkos::CrsGraphHostCompute< Ordinal, Node, LocalMatOps >::is2DStructure ( ) const

Indicate that the structure is 2D. It will never be the case that both is1DStructure() and is2DStructure() return true.

Definition at line 249 of file Kokkos_CrsGraph.hpp.

template<class Ordinal , class Node , class LocalMatOps >
bool Kokkos::CrsGraphHostCompute< Ordinal, Node, LocalMatOps >::isOptimized ( ) const

Indicate that the stucture is optimized.

Definition at line 255 of file Kokkos_CrsGraph.hpp.

template<class Ordinal, class Node , class LocalMatOps >
void Kokkos::CrsGraphHostCompute< Ordinal, Node, LocalMatOps >::set1DStructure ( ArrayRCP< Ordinal >  inds,
ArrayRCP< size_t >  rowBegs,
ArrayRCP< size_t >  rowEnds 
)

Submit the indices and offset for 1D storage.

Postcondition:
is1DStructure() == true

Definition at line 281 of file Kokkos_CrsGraph.hpp.

template<class Ordinal, class Node , class LocalMatOps >
void Kokkos::CrsGraphHostCompute< Ordinal, Node, LocalMatOps >::set2DStructure ( ArrayRCP< ArrayRCP< Ordinal > >  inds,
ArrayRCP< size_t >  numEntriesPerRow 
)

Submit the indices for 2D storage.

Postcondition:
is2DStructure() == true

Definition at line 312 of file Kokkos_CrsGraph.hpp.

template<class Ordinal, class Node , class LocalMatOps >
void Kokkos::CrsGraphHostCompute< Ordinal, Node, LocalMatOps >::get1DStructure ( ArrayRCP< Ordinal > &  inds,
ArrayRCP< size_t > &  rowBegs,
ArrayRCP< size_t > &  rowEnds 
)

Retrieve the structure for 1D storage.

If is1DStructure() == false, then

Postcondition:
inds == rowBegs == rowEnds == null

Otherwise,

Postcondition:
indices for row r are inds[r], where $r \in [b,e)$, where $b = rowBegs[r]$ and $e = rowEnds[r]$
rowBegs has getNumRows()+1 entries; the last entry is inds.size()
rowEnds has getNumRows() entries

Definition at line 261 of file Kokkos_CrsGraph.hpp.

template<class Ordinal, class Node , class LocalMatOps >
void Kokkos::CrsGraphHostCompute< Ordinal, Node, LocalMatOps >::get2DStructure ( ArrayRCP< ArrayRCP< Ordinal > > &  inds,
ArrayRCP< size_t > &  numEntriesPerRow 
)

Retrieve the structure for 2D storage.

If is2DStructure() == false, then

Postcondition:
inds == numEntriesPerRow == null

Definition at line 272 of file Kokkos_CrsGraph.hpp.

template<class Ordinal , class Node , class LocalMatOps >
void Kokkos::CrsGraphHostCompute< Ordinal, Node, LocalMatOps >::finalize ( bool  OptimizeStorage)

Instruct the graph to perform any necessary manipulation, including (optionally) optimizing the storage of the graph data.

Parameters:
[in]OptimizeStoragePermit the graph to reallocate storage on the host in order to provide optimal storage and/or performance.
Postcondition:
if OptimizeStorage == true, then is2DStructure() == true

Reimplemented in Kokkos::CrsGraphDeviceCompute< Ordinal, Node, LocalMatOps >, Kokkos::CrsGraphDeviceCompute< Ordinal, Node, DefaultDeviceSparseOps< S, Ordinal, Node > >, and Kokkos::CrsGraphDeviceCompute< Ordinal, Node, DefaultDeviceSparseOps< void, Ordinal, Node > >.

Definition at line 337 of file Kokkos_CrsGraph.hpp.

template<class Ordinal , class Node , class LocalMatOps >
template<class Scalar >
void Kokkos::CrsGraphHostCompute< Ordinal, Node, LocalMatOps >::finalize ( bool  OptimizeStorage,
ArrayRCP< ArrayRCP< Scalar > > &  values2D,
ArrayRCP< Scalar > &  values1D 
)
Parameters:
[in]OptimizeStoragePermit the graph to reallocate storage on the host in order to provide optimal storage and/or performance.
in/out]values2D 2D-structured matrix values. Required to be non-null if is2DStructure() is true. Set to null if OptimizeStorage is true.
in/out]values1D 1D-structured matrix values. Required to be non-null if is1DStructure() is true. Allocated if OptimizeStorage is true.
Postcondition:
if OptimizeStorage == true or already is2DStructure(), then is2DStructure() == true.

Definition at line 397 of file Kokkos_CrsGraph.hpp.

template<class Ordinal , class Node , class LocalMatOps >
void Kokkos::CrsGraphHostCompute< Ordinal, Node, LocalMatOps >::clear ( ) [virtual]

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