Tpetra_MapDecl.hpp

// @HEADER
// ***********************************************************************
// 
//          Tpetra: Templated Linear Algebra Services Package
//                 Copyright (2004) Sandia Corporation
// 
// Under terms of Contract DE-AC04-94AL85000, there is a non-exclusive
// license for use of this work by or on behalf of the U.S. Government.
// 
// This library is free software; you can redistribute it and/or modify
// it under the terms of the GNU Lesser General Public License as
// published by the Free Software Foundation; either version 2.1 of the
// License, or (at your option) any later version.
//  
// This library is distributed in the hope that it will be useful, but
// WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
// Lesser General Public License for more details.
//  
// You should have received a copy of the GNU Lesser General Public
// License along with this library; if not, write to the Free Software
// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
// USA
// Questions? Contact Michael A. Heroux (maherou@sandia.gov) 
// 
// ***********************************************************************
// @HEADER

#ifndef TPETRA_MAP_DECL_HPP
#define TPETRA_MAP_DECL_HPP

#include <Teuchos_RCP.hpp>
#include <Teuchos_Object.hpp>
#include "Tpetra_Platform.hpp"

namespace Tpetra {

  template<typename Ordinal> class MapData;


  template<typename Ordinal>
  class Map : public Teuchos::Object {

  public:



    Map(Ordinal numGlobalEntries, Ordinal indexBase, const Platform<Ordinal> &platform, bool local=false);

    Map(Ordinal numGlobalEntries, Ordinal numMyEntries, Ordinal indexBase, 
        const Platform<Ordinal> &platform);

    Map(Ordinal numGlobalEntries, const Teuchos::ArrayView<const Ordinal> &entryList, 
        Ordinal indexBase, const Platform<Ordinal> &platform);

    Map(const Map<Ordinal> &Map);

    ~Map();





    Ordinal getNumGlobalEntries() const;

    Ordinal getNumMyEntries() const;

    Ordinal getIndexBase() const;

    Ordinal getMinLocalIndex() const;

    Ordinal getMaxLocalIndex() const;

    Ordinal getMinGlobalIndex() const;

    Ordinal getMaxGlobalIndex() const;

    Ordinal getMinAllGlobalIndex() const;

    Ordinal getMaxAllGlobalIndex() const;

    Ordinal getLocalIndex(Ordinal globalIndex) const;

    Ordinal getGlobalIndex(Ordinal localIndex) const;


    bool getRemoteIndexList(const Teuchos::ArrayView<const Ordinal> & GIDList, 
                            const Teuchos::ArrayView<Ordinal> & imageIDList, 
                            const Teuchos::ArrayView<Ordinal> & LIDList) const;


    bool getRemoteIndexList(const Teuchos::ArrayView<const Ordinal> & GIDList, 
                            const Teuchos::ArrayView<Ordinal> & imageIDList) const;

    Teuchos::ArrayView<const Ordinal> getMyGlobalEntries() const;

    bool isMyLocalIndex(Ordinal localIndex) const;

    bool isMyGlobalIndex(Ordinal globalIndex) const;

    bool isContiguous() const;

    bool isDistributed() const;




    bool isCompatible (const Map< Ordinal> &map) const;

    bool isSameAs (const Map<Ordinal> &map) const;

    bool operator== (const Map< Ordinal > &map) const;

    bool operator!= (const Map< Ordinal > &map) const;



    Map<Ordinal>& operator = (const Map<Ordinal> & Source);

    Teuchos::RCP< const Platform<Ordinal> > getPlatform() const;

    Teuchos::RCP<const Teuchos::Comm<Ordinal> > getComm() const;




    void print(std::ostream& os) const;



  private:

    Teuchos::RCP< MapData<Ordinal> > MapData_;

    // setup the directory
    void directorySetup();

  }; // Map class

} // Tpetra namespace

#endif // TPETRA_MAP_DECL_HPP

---