#include <Tpetra_MapDecl.hpp>
Inheritance diagram for Tpetra::Map< Ordinal >:
Public Member Functions | |
Constructor/Destructor Methods | |
| Map (Ordinal numGlobalEntries, Ordinal indexBase, const Platform< Ordinal > &platform, bool local=false) | |
| Map constructor with Tpetra-defined contiguous uniform distribution. The entries are distributed among nodes so that the subsets of global entries are non-overlapping and contiguous and as evenly distributed across the nodes as possible. | |
| Map (Ordinal numGlobalEntries, Ordinal numMyEntries, Ordinal indexBase, const Platform< Ordinal > &platform) | |
| Map constructor with a user-defined contiguous distribution. The entries are distributed among the nodes so that the subsets of global entries are non-overlapping and contiguous. | |
| Map (Ordinal numGlobalEntries, const Teuchos::ArrayView< const Ordinal > &entryList, Ordinal indexBase, const Platform< Ordinal > &platform) | |
| Map constructor with user-defined non-contiguous (arbitrary) distribution. | |
| Map (const Map< Ordinal > &Map) | |
| Map copy constructor. | |
| ~Map () | |
| Map destructor. | |
Map Attribute Methods | |
| Ordinal | getNumGlobalEntries () const |
| Returns the number of entries in this Map. | |
| Ordinal | getNumMyEntries () const |
| Returns the number of entries belonging to the calling image. | |
| Ordinal | getIndexBase () const |
| Returns the index base for this Map. | |
| Ordinal | getMinLocalIndex () const |
| Returns minimum local index. | |
| Ordinal | getMaxLocalIndex () const |
| Returns maximum local index. | |
| Ordinal | getMinGlobalIndex () const |
| Returns minimum global index owned by this image. | |
| Ordinal | getMaxGlobalIndex () const |
| Returns maximum global index owned by this image. | |
| Ordinal | getMinAllGlobalIndex () const |
| Return the minimum global index over all images. | |
| Ordinal | getMaxAllGlobalIndex () const |
| Return the maximum global index over all images. | |
| Ordinal | getLocalIndex (Ordinal globalIndex) const |
| Return the local index for a given global index. | |
| Ordinal | getGlobalIndex (Ordinal localIndex) const |
| Return the global index for a given local index. | |
| bool | getRemoteIndexList (const Teuchos::ArrayView< const Ordinal > &GIDList, const Teuchos::ArrayView< Ordinal > &imageIDList, const Teuchos::ArrayView< Ordinal > &LIDList) const |
| Returns the node IDs and corresponding local indices for a given list of global indices. | |
| bool | getRemoteIndexList (const Teuchos::ArrayView< const Ordinal > &GIDList, const Teuchos::ArrayView< Ordinal > &imageIDList) const |
| Returns the node IDs for a given list of global indices. | |
| Teuchos::ArrayView< const Ordinal > | getMyGlobalEntries () const |
| Return a list of the global entries owned by this image. | |
| bool | isMyLocalIndex (Ordinal localIndex) const |
| Returns true if the local index value passed in is found on the calling image, returns false if it doesn't. | |
| bool | isMyGlobalIndex (Ordinal globalIndex) const |
| Returns true if the global index value passed in is found the calling image, returns false if it doesn't. | |
| bool | isContiguous () const |
| Returns true if this Map is distributed contiguously, returns false otherwise. | |
| bool | isDistributed () const |
| Returns true if this Map is distributed across more than one image, returns false otherwise. | |
Boolean Tests | |
| bool | isCompatible (const Map< Ordinal > &map) const |
Returns true if map is compatible with this Map. | |
| bool | isSameAs (const Map< Ordinal > &map) const |
Returns true if map is identical to this Map. | |
| bool | operator== (const Map< Ordinal > &map) const |
Returns true if map is identical to this Map. Implemented in isSameAs(). | |
| bool | operator!= (const Map< Ordinal > &map) const |
Returns true if map is not identical to this Map. Implemented in isSameAs(). | |
| Map< Ordinal > & | operator= (const Map< Ordinal > &Source) |
| Assignment operator. | |
| Teuchos::RCP< const Platform< Ordinal > > | getPlatform () const |
| Get the Platform object for this Map. | |
| Teuchos::RCP< const Teuchos::Comm< Ordinal > > | getComm () const |
| Get the Comm object for this Map. | |
| void | print (std::ostream &os) const |
| Prints the Map object to the output stream. | |
| Tpetra::Map< Ordinal >::Map | ( | Ordinal | numGlobalEntries, | |
| Ordinal | indexBase, | |||
| const Platform< Ordinal > & | platform, | |||
| bool | local = false | |||
| ) |
Map constructor with Tpetra-defined contiguous uniform distribution. The entries are distributed among nodes so that the subsets of global entries are non-overlapping and contiguous and as evenly distributed across the nodes as possible.
| Tpetra::Map< Ordinal >::Map | ( | Ordinal | numGlobalEntries, | |
| Ordinal | numMyEntries, | |||
| Ordinal | indexBase, | |||
| const Platform< Ordinal > & | platform | |||
| ) |
Map constructor with a user-defined contiguous distribution. The entries are distributed among the nodes so that the subsets of global entries are non-overlapping and contiguous.
If numGlobalEntries == -1, it will be computed via a global communication. Otherwise, it must be equal to the sum of the local entries across all nodes. This will only be verified if Trilinos was compiled with --enable-teuchos-debug. If this verification fails, a std::invalid_argument exception will be thrown.
| Tpetra::Map< Ordinal >::Map | ( | Ordinal | numGlobalEntries, | |
| const Teuchos::ArrayView< const Ordinal > & | entryList, | |||
| Ordinal | indexBase, | |||
| const Platform< Ordinal > & | platform | |||
| ) |
Map constructor with user-defined non-contiguous (arbitrary) distribution.
| Tpetra::Map< Ordinal >::Map | ( | const Map< Ordinal > & | Map | ) |
Map copy constructor.
| Tpetra::Map< Ordinal >::~Map | ( | ) |
Map destructor.
| Ordinal Tpetra::Map< Ordinal >::getNumGlobalEntries | ( | ) | const |
Returns the number of entries in this Map.
| Ordinal Tpetra::Map< Ordinal >::getNumMyEntries | ( | ) | const |
Returns the number of entries belonging to the calling image.
| Ordinal Tpetra::Map< Ordinal >::getIndexBase | ( | ) | const |
Returns the index base for this Map.
| Ordinal Tpetra::Map< Ordinal >::getMinLocalIndex | ( | ) | const |
Returns minimum local index.
| Ordinal Tpetra::Map< Ordinal >::getMaxLocalIndex | ( | ) | const |
Returns maximum local index.
| Ordinal Tpetra::Map< Ordinal >::getMinGlobalIndex | ( | ) | const |
Returns minimum global index owned by this image.
| Ordinal Tpetra::Map< Ordinal >::getMaxGlobalIndex | ( | ) | const |
Returns maximum global index owned by this image.
| Ordinal Tpetra::Map< Ordinal >::getMinAllGlobalIndex | ( | ) | const |
Return the minimum global index over all images.
| Ordinal Tpetra::Map< Ordinal >::getMaxAllGlobalIndex | ( | ) | const |
Return the maximum global index over all images.
| Ordinal Tpetra::Map< Ordinal >::getLocalIndex | ( | Ordinal | globalIndex | ) | const |
Return the local index for a given global index.
| Ordinal Tpetra::Map< Ordinal >::getGlobalIndex | ( | Ordinal | localIndex | ) | const |
Return the global index for a given local index.
| bool Tpetra::Map< Ordinal >::getRemoteIndexList | ( | const Teuchos::ArrayView< const Ordinal > & | GIDList, | |
| const Teuchos::ArrayView< Ordinal > & | imageIDList, | |||
| const Teuchos::ArrayView< Ordinal > & | LIDList | |||
| ) | const |
Returns the node IDs and corresponding local indices for a given list of global indices.
true signifies at least one specified global entry was not present in the directory. | bool Tpetra::Map< Ordinal >::getRemoteIndexList | ( | const Teuchos::ArrayView< const Ordinal > & | GIDList, | |
| const Teuchos::ArrayView< Ordinal > & | imageIDList | |||
| ) | const |
Returns the node IDs for a given list of global indices.
true signifies at least one specified global entry was not present in the directory. | Teuchos::ArrayView< const Ordinal > Tpetra::Map< Ordinal >::getMyGlobalEntries | ( | ) | const |
Return a list of the global entries owned by this image.
| bool Tpetra::Map< Ordinal >::isMyLocalIndex | ( | Ordinal | localIndex | ) | const |
Returns true if the local index value passed in is found on the calling image, returns false if it doesn't.
| bool Tpetra::Map< Ordinal >::isMyGlobalIndex | ( | Ordinal | globalIndex | ) | const |
Returns true if the global index value passed in is found the calling image, returns false if it doesn't.
| bool Tpetra::Map< Ordinal >::isContiguous | ( | ) | const |
Returns true if this Map is distributed contiguously, returns false otherwise.
| bool Tpetra::Map< Ordinal >::isDistributed | ( | ) | const |
Returns true if this Map is distributed across more than one image, returns false otherwise.
| bool Tpetra::Map< Ordinal >::isCompatible | ( | const Map< Ordinal > & | map | ) | const |
Returns true if map is compatible with this Map.
| bool Tpetra::Map< Ordinal >::isSameAs | ( | const Map< Ordinal > & | map | ) | const |
Returns true if map is identical to this Map.
| bool Tpetra::Map< Ordinal >::operator== | ( | const Map< Ordinal > & | map | ) | const |
Returns true if map is identical to this Map. Implemented in isSameAs().
| bool Tpetra::Map< Ordinal >::operator!= | ( | const Map< Ordinal > & | map | ) | const |
Returns true if map is not identical to this Map. Implemented in isSameAs().
| Map< Ordinal > & Tpetra::Map< Ordinal >::operator= | ( | const Map< Ordinal > & | Source | ) |
Assignment operator.
| Teuchos::RCP< const Platform< Ordinal > > Tpetra::Map< Ordinal >::getPlatform | ( | ) | const |
| Teuchos::RCP< const Teuchos::Comm< Ordinal > > Tpetra::Map< Ordinal >::getComm | ( | ) | const |
Get the Comm object for this Map.
| void Tpetra::Map< Ordinal >::print | ( | std::ostream & | os | ) | const [virtual] |
Prints the Map object to the output stream.
An << operator is inherited from Teuchos::Object, which uses the print method.
Reimplemented from Teuchos::Object.
1.4.7