An abstract interface for graphs accessed by rows. More...
#include <Tpetra_RowGraph_decl.hpp>
Public Member Functions | |
| virtual void | pack (const Teuchos::ArrayView< const ::Tpetra::Details::DefaultTypes::local_ordinal_type > &exportLIDs, Teuchos::Array< ::Tpetra::Details::DefaultTypes::global_ordinal_type > &exports, const Teuchos::ArrayView< size_t > &numPacketsPerLID, size_t &constantNumPackets, Distributor &distor) const=0 |
| Pack the object's data for an Import or Export. More... | |
Graph query methods | |
| virtual Teuchos::RCP< const Teuchos::Comm< int > > | getComm () const =0 |
| The communicator over which this graph is distributed. More... | |
| virtual Teuchos::RCP< Node > | getNode () const =0 |
| The Kokkos Node instance with which this object was created. More... | |
| virtual Teuchos::RCP< const Map< LocalOrdinal, GlobalOrdinal, Node > > | getRowMap () const =0 |
| The Map that describes this graph's distribution of rows over processes. More... | |
| virtual Teuchos::RCP< const Map< LocalOrdinal, GlobalOrdinal, Node > > | getColMap () const =0 |
| The Map that describes this graph's distribution of columns over processes. More... | |
| virtual Teuchos::RCP< const Map< LocalOrdinal, GlobalOrdinal, Node > > | getDomainMap () const =0 |
| The Map associated with the domain of this graph. More... | |
| virtual Teuchos::RCP< const Map< LocalOrdinal, GlobalOrdinal, Node > > | getRangeMap () const =0 |
| The Map associated with the range of this graph. More... | |
| virtual Teuchos::RCP< const Import< LocalOrdinal, GlobalOrdinal, Node > > | getImporter () const =0 |
| This graph's Import object. More... | |
| virtual Teuchos::RCP< const Export< LocalOrdinal, GlobalOrdinal, Node > > | getExporter () const =0 |
| This graph's Export object. More... | |
| virtual global_size_t | getGlobalNumRows () const =0 |
| Returns the number of global rows in the graph. More... | |
| virtual global_size_t | getGlobalNumCols () const =0 |
| Returns the number of global columns in the graph. More... | |
| virtual size_t | getNodeNumRows () const =0 |
| Returns the number of rows owned on the calling node. More... | |
| virtual size_t | getNodeNumCols () const =0 |
| Returns the number of columns connected to the locally owned rows of this graph. More... | |
| virtual GlobalOrdinal | getIndexBase () const =0 |
| Returns the index base for global indices for this graph. More... | |
| virtual global_size_t | getGlobalNumEntries () const =0 |
| Returns the global number of entries in the graph. More... | |
| virtual size_t | getNodeNumEntries () const =0 |
| Returns the local number of entries in the graph. More... | |
| virtual size_t | getNumEntriesInGlobalRow (GlobalOrdinal globalRow) const =0 |
| Returns the current number of entries on this node in the specified global row. More... | |
| virtual size_t | getNumEntriesInLocalRow (LocalOrdinal localRow) const =0 |
| Returns the current number of entries on this node in the specified local row. More... | |
| virtual global_size_t TPETRA_DEPRECATED | getGlobalNumDiags () const =0 |
| Number of diagonal entries over all processes in the graph's communicator. More... | |
| virtual size_t TPETRA_DEPRECATED | getNodeNumDiags () const =0 |
| Number of diagonal entries on the calling process. More... | |
| virtual size_t | getGlobalMaxNumRowEntries () const =0 |
| Returns the maximum number of entries across all rows/columns on all nodes. More... | |
| virtual size_t | getNodeMaxNumRowEntries () const =0 |
| Returns the maximum number of entries across all rows/columns on this node. More... | |
| virtual bool | hasColMap () const =0 |
| Whether the graph has a well-defined column Map. More... | |
| virtual bool TPETRA_DEPRECATED | isLowerTriangular () const =0 |
| Whether the graph is locally lower triangular. More... | |
| virtual bool TPETRA_DEPRECATED | isUpperTriangular () const =0 |
| Whether the graph is locally upper triangular. More... | |
| virtual bool | isLocallyIndexed () const =0 |
| If graph indices are in the local range, this function returns true. Otherwise, this function returns false. */. More... | |
| virtual bool | isGloballyIndexed () const =0 |
| If graph indices are in the global range, this function returns true. Otherwise, this function returns false. */. More... | |
| virtual bool | isFillComplete () const =0 |
| Whether fillComplete() has been called (without an intervening resumeFill()). More... | |
Extraction Methods | |
| virtual void | getGlobalRowCopy (GlobalOrdinal GlobalRow, const Teuchos::ArrayView< GlobalOrdinal > &Indices, size_t &NumIndices) const =0 |
| Extract a list of entries in a specified global row of the graph. Put into pre-allocated storage. More... | |
| virtual void | getLocalRowCopy (LocalOrdinal LocalRow, const Teuchos::ArrayView< LocalOrdinal > &Indices, size_t &NumIndices) const =0 |
| Extract a list of entries in a specified local row of the graph. Put into storage allocated by calling routine. More... | |
| virtual bool | supportsRowViews () const |
| Whether this class implements getLocalRowView() and getGlobalRowView(). More... | |
| virtual void | getLocalRowView (const LocalOrdinal lclRow, Teuchos::ArrayView< const LocalOrdinal > &lclColInds) const |
| Get a constant, nonpersisting, locally indexed view of the given row of the graph. More... | |
| virtual void | getGlobalRowView (const GlobalOrdinal gblRow, Teuchos::ArrayView< const GlobalOrdinal > &gblColInds) const |
| Get a const, non-persisting view of the given global row's global column indices, as a Teuchos::ArrayView. More... | |
Implementation of Packable interface | |
| virtual void | pack (const Teuchos::ArrayView< const LocalOrdinal > &exportLIDs, Teuchos::Array< GlobalOrdinal > &exports, const Teuchos::ArrayView< size_t > &numPacketsPerLID, size_t &constantNumPackets, Distributor &distor) const |
| Pack this object's data for Import or Export. More... | |
Typedefs | |
| typedef LocalOrdinal | local_ordinal_type |
| The type of local indices in the graph. More... | |
| typedef GlobalOrdinal | global_ordinal_type |
| The type of global indices in the graph. More... | |
| typedef Node | node_type |
| The Kokkos Node type. More... | |
| virtual | ~RowGraph () |
| Destructor (virtual for memory safety of derived classes). More... | |
Detailed Description
template<class LocalOrdinal = ::Tpetra::Details::DefaultTypes::local_ordinal_type, class GlobalOrdinal = ::Tpetra::Details::DefaultTypes::global_ordinal_type, class Node = ::Tpetra::Details::DefaultTypes::node_type>
class Tpetra::Classes::RowGraph< LocalOrdinal, GlobalOrdinal, Node >
An abstract interface for graphs accessed by rows.
This class is to CrsGraph, what RowMatrix is to CrsMatrix. CrsGraph is an implementation of RowGraph.
- Template Parameters
-
LocalOrdinal The type of local indices. See the documentation of Map for requirements. GlobalOrdinal The type of global indices. See the documentation of Map for requirements. Node The Kokkos Node type. See the documentation of Map for requirements.
Definition at line 70 of file Tpetra_RowGraph_decl.hpp.
Member Typedef Documentation
◆ local_ordinal_type
| typedef LocalOrdinal Tpetra::Classes::RowGraph< LocalOrdinal, GlobalOrdinal, Node >::local_ordinal_type |
The type of local indices in the graph.
Definition at line 77 of file Tpetra_RowGraph_decl.hpp.
◆ global_ordinal_type
| typedef GlobalOrdinal Tpetra::Classes::RowGraph< LocalOrdinal, GlobalOrdinal, Node >::global_ordinal_type |
The type of global indices in the graph.
Definition at line 79 of file Tpetra_RowGraph_decl.hpp.
◆ node_type
| typedef Node Tpetra::Classes::RowGraph< LocalOrdinal, GlobalOrdinal, Node >::node_type |
The Kokkos Node type.
Definition at line 81 of file Tpetra_RowGraph_decl.hpp.
Constructor & Destructor Documentation
◆ ~RowGraph()
|
inlinevirtual |
Destructor (virtual for memory safety of derived classes).
Definition at line 85 of file Tpetra_RowGraph_decl.hpp.
Member Function Documentation
◆ getComm()
|
pure virtual |
The communicator over which this graph is distributed.
◆ getNode()
|
pure virtual |
The Kokkos Node instance with which this object was created.
◆ getRowMap()
|
pure virtual |
The Map that describes this graph's distribution of rows over processes.
◆ getColMap()
|
pure virtual |
The Map that describes this graph's distribution of columns over processes.
◆ getDomainMap()
|
pure virtual |
The Map associated with the domain of this graph.
◆ getRangeMap()
|
pure virtual |
The Map associated with the range of this graph.
◆ getImporter()
|
pure virtual |
This graph's Import object.
◆ getExporter()
|
pure virtual |
This graph's Export object.
◆ getGlobalNumRows()
|
pure virtual |
Returns the number of global rows in the graph.
◆ getGlobalNumCols()
|
pure virtual |
Returns the number of global columns in the graph.
◆ getNodeNumRows()
|
pure virtual |
Returns the number of rows owned on the calling node.
◆ getNodeNumCols()
|
pure virtual |
Returns the number of columns connected to the locally owned rows of this graph.
◆ getIndexBase()
|
pure virtual |
Returns the index base for global indices for this graph.
◆ getGlobalNumEntries()
|
pure virtual |
Returns the global number of entries in the graph.
◆ getNodeNumEntries()
|
pure virtual |
Returns the local number of entries in the graph.
◆ getNumEntriesInGlobalRow()
|
pure virtual |
Returns the current number of entries on this node in the specified global row.
Returns Teuchos::OrdinalTraits<size_t>::invalid() if the specified global row does not belong to this graph.
◆ getNumEntriesInLocalRow()
|
pure virtual |
Returns the current number of entries on this node in the specified local row.
Returns Teuchos::OrdinalTraits<size_t>::invalid() if the specified local row is not valid for this graph.
◆ getGlobalNumDiags()
|
pure virtual |
Number of diagonal entries over all processes in the graph's communicator.
- Warning
- DO NOT CALL THIS METHOD! This method is DEPRECATED and will DISAPPEAR VERY SOON per #2630.
◆ getNodeNumDiags()
|
pure virtual |
Number of diagonal entries on the calling process.
- Warning
- DO NOT CALL THIS METHOD! This method is DEPRECATED and will DISAPPEAR VERY SOON per #2630.
◆ getGlobalMaxNumRowEntries()
|
pure virtual |
Returns the maximum number of entries across all rows/columns on all nodes.
◆ getNodeMaxNumRowEntries()
|
pure virtual |
Returns the maximum number of entries across all rows/columns on this node.
◆ hasColMap()
|
pure virtual |
Whether the graph has a well-defined column Map.
◆ isLowerTriangular()
|
pure virtual |
Whether the graph is locally lower triangular.
- Warning
- DO NOT CALL THIS METHOD! This method is DEPRECATED and will DISAPPEAR VERY SOON per #2630.
- Precondition
- Subclasses reserve the right to impose preconditions on the matrix's state.
- Note
- This is entirely a local property. That means this method may return different results on different processes.
◆ isUpperTriangular()
|
pure virtual |
Whether the graph is locally upper triangular.
- Warning
- DO NOT CALL THIS METHOD! This method is DEPRECATED and will DISAPPEAR VERY SOON per #2630.
- Precondition
- Subclasses reserve the right to impose preconditions on the matrix's state.
- Note
- This is entirely a local property. That means this method may return different results on different processes.
◆ isLocallyIndexed()
|
pure virtual |
If graph indices are in the local range, this function returns true. Otherwise, this function returns false. */.
◆ isGloballyIndexed()
|
pure virtual |
If graph indices are in the global range, this function returns true. Otherwise, this function returns false. */.
◆ isFillComplete()
|
pure virtual |
Whether fillComplete() has been called (without an intervening resumeFill()).
◆ getGlobalRowCopy()
|
pure virtual |
Extract a list of entries in a specified global row of the graph. Put into pre-allocated storage.
- Parameters
-
LocalRow - (In) Global row number for which indices are desired. Indices - (Out) Global column indices corresponding to values. NumIndices - (Out) Number of indices.
Note: A std::runtime_error exception is thrown if Indices is not large enough to hold the column indices associated with row GlobalRow. If GlobalRow does not belong to this node, then Indices is unchanged and NumIndices is returned as Teuchos::OrdinalTraits<size_t>::invalid().
◆ getLocalRowCopy()
|
pure virtual |
Extract a list of entries in a specified local row of the graph. Put into storage allocated by calling routine.
- Parameters
-
LocalRow - (In) Local row number for which indices are desired. Indices - (Out) Local column indices corresponding to values. NumIndices - (Out) Number of indices.
Note: A std::runtime_error exception is thrown if Indices is not large enough to hold the column indices associated with row LocalRow. If LocalRow is not valid for this node, then Indices is unchanged and NumIndices is returned as Teuchos::OrdinalTraits<size_t>::invalid().
◆ supportsRowViews()
|
inlinevirtual |
Whether this class implements getLocalRowView() and getGlobalRowView().
If subclasses override the default (trivial) implementation of getLocalRowView() and getGlobalRowView(), then they need to override this method as well.
Reimplemented in Tpetra::Classes::CrsGraph< ::Tpetra::Details::DefaultTypes::local_ordinal_type, ::Tpetra::Details::DefaultTypes::global_ordinal_type, node_type >.
Definition at line 245 of file Tpetra_RowGraph_decl.hpp.
◆ getLocalRowView()
|
virtual |
Get a constant, nonpersisting, locally indexed view of the given row of the graph.
The returned views of the column indices are not guaranteed to persist beyond the lifetime of this. Furthermore, some RowGraph implementations allow changing the values, or the indices and values. Any such changes invalidate the returned views.
This method only gets the entries in the given row that are stored on the calling process. Note that if the graph has an overlapping row Map, it is possible that the calling process does not store all the entries in that row.
- Precondition
isLocallyIndexed () && supportsRowViews ()
- Postcondition
indices.size () == getNumEntriesInGlobalRow (LocalRow)
- Parameters
-
lclRow [in] Local index of the row. lclColInds [out] Local indices of the columns in the row. If the given row is not a valid row index on the calling process, then the result has no entries (its size is zero).
Subclasses are expected to implement this method. We would have made this method pure virtual, but that would have broken backwards compatibility, since we added the method at least one major release after introducing this class.
Reimplemented in Tpetra::Classes::CrsGraph< LocalOrdinal, GlobalOrdinal, Node >, and Tpetra::Classes::CrsGraph< ::Tpetra::Details::DefaultTypes::local_ordinal_type, ::Tpetra::Details::DefaultTypes::global_ordinal_type, node_type >.
Definition at line 109 of file Tpetra_RowGraph_def.hpp.
◆ getGlobalRowView()
|
virtual |
Get a const, non-persisting view of the given global row's global column indices, as a Teuchos::ArrayView.
- Parameters
-
gblRow [in] Global index of the row. gblColInds [out] Global column indices in the row. If the given row is not a valid row index on the calling process, then the result has no entries (its size is zero).
- Precondition
! isLocallyIndexed()
- Postcondition
gblColInds.size() == getNumEntriesInGlobalRow(gblRow)
Subclasses are expected to implement this method. We would have made this method pure virtual, but that would have broken backwards compatibility, since we added the method at least one major release after introducing this class.
Reimplemented in Tpetra::Classes::CrsGraph< LocalOrdinal, GlobalOrdinal, Node >, and Tpetra::Classes::CrsGraph< ::Tpetra::Details::DefaultTypes::local_ordinal_type, ::Tpetra::Details::DefaultTypes::global_ordinal_type, node_type >.
Definition at line 130 of file Tpetra_RowGraph_def.hpp.
◆ pack() [1/2]
|
virtual |
Pack this object's data for Import or Export.
Reimplemented in Tpetra::Classes::CrsGraph< LocalOrdinal, GlobalOrdinal, Node >, and Tpetra::Classes::CrsGraph< ::Tpetra::Details::DefaultTypes::local_ordinal_type, ::Tpetra::Details::DefaultTypes::global_ordinal_type, node_type >.
Definition at line 51 of file Tpetra_RowGraph_def.hpp.
◆ pack() [2/2]
|
pure virtualinherited |
Pack the object's data for an Import or Export.
- Parameters
-
exportLIDs [in] List of the local indices of the entries which the source object will send out. exports [out] On exit, the buffer packed with data to send. This object may resize the array if necessary. numPacketsPerLID [out] On exit, the implementation of this method must do one of two things: set numPacketsPerLID[i] to contain the number of packets to be exported for exportLIDs[i] and set constantNumPackets to zero, or set constantNumPackets to a nonzero value. If the latter, the implementation need not fill numPacketsPerLID. constantNumPackets [out] On exit, zero if numPacketsPerLIDhas variable contents (different size for each local index). If nonzero, then it is expected that the number of packets per local index is constant, and thatconstantNumPacketsis that value.distor [in] The Distributor object we are using. Implementations may ignore this object. We provide it for consistency with DistObject's packAndPrepare method.
The documentation for this class was generated from the following files:
