Tpetra_VectorDecl.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_VECTOR_DECL_HPP
#define TPETRA_VECTOR_DECL_HPP

#include <Teuchos_Object.hpp>
#include <Teuchos_ArrayView.hpp>
#include "Tpetra_ConfigDefs.hpp"
#include "Tpetra_DistObject.hpp"
#include "Tpetra_Map.hpp"

namespace Tpetra {

#ifndef DOXYGEN_SHOULD_SKIP_THIS
  // forward declaration of VectorData, needed to prevent circular inclusions
  template<typename Ordinal, typename Scalar> class VectorData;
#endif


  template<typename Ordinal, typename Scalar>
  class Vector : public DistObject<Ordinal,Scalar> {

  public:
  


    Vector(const Map<Ordinal> &map);
  
    Vector(const Teuchos::ArrayView<const Scalar> &values, const Map<Ordinal> & map);

    Vector(const Vector<Ordinal,Scalar> &source);

    ~Vector();




    void submitEntries(const Teuchos::ArrayView<const Ordinal> &indices,
                       const Teuchos::ArrayView<const Scalar>  &values);

    void setAllToScalar(const Scalar &value);

    void setAllToRandom();





    // void extractCopy(Scalar* userArray) const;

    // void extractView(Scalar** userPointerArray) const;





    Scalar dotProduct(const Vector<Ordinal, Scalar> &x) const;

    void absoluteValue(const Vector<Ordinal,Scalar> &x);

    void reciprocal(const Vector<Ordinal,Scalar> &x);

    void scale(const Scalar &scalarThis);

    void scale(const Scalar &scalarX, const Vector<Ordinal,Scalar> &x);

    void update(const Scalar &scalarX, const Vector<Ordinal,Scalar> &x, const Scalar &scalarThis);

    void update(const Scalar &scalarX, const Vector<Ordinal,Scalar> &x, 
                const Scalar &scalarY, const Vector<Ordinal,Scalar> &y, 
                const Scalar &scalarThis);

    Scalar norm1() const;

    Scalar norm2() const;

    Scalar normInf() const;

    Scalar normWeighted(const Vector<Ordinal,Scalar> &weights) const;

    Scalar minValue() const;

    Scalar maxValue() const;

    Scalar meanValue() const;


    void elementwiseMultiply(const Scalar &scalarXY, const Vector<Ordinal,Scalar> &x, const Vector<Ordinal,Scalar> &y, 
                             const Scalar &scalarThis);


    void elementwiseReciprocalMultiply(Scalar scalarXY, const Vector<Ordinal, Scalar> &x, const Vector<Ordinal, Scalar> &y, 
                                       const Scalar &scalarThis);





    const Scalar & getSeed() const;

    void setSeed(const Scalar &seed);





    Scalar& operator[](Ordinal index);

    const Scalar & operator[](Ordinal index) const;





    Ordinal getNumMyEntries() const;

    Ordinal getNumGlobalEntries() const;




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

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




    const Map<Ordinal> & getMap() const;

    Vector<Ordinal,Scalar> & operator=(const Vector<Ordinal,Scalar> &source);




    // Returns pointer to Scalar array inside of scalarArray
    Teuchos::ArrayView<Scalar> scalarPointer();

    Teuchos::ArrayView<const Scalar> scalarPointer() const;


  private:

    Teuchos::RCP<VectorData<Ordinal,Scalar> > VectorData_;

    // four functions needed for DistObject derivation
    bool checkSizes(const DistObject<Ordinal,Scalar> & sourceObj);

    void copyAndPermute(const DistObject<Ordinal,Scalar> & sourceObj,
               Ordinal numSameIDs,
               Ordinal numPermuteIDs,
               const Teuchos::ArrayView<const Ordinal> & permuteToLIDs,
               const Teuchos::ArrayView<const Ordinal> & permuteFromLIDs);

    void packAndPrepare(const DistObject<Ordinal,Scalar> & sourceObj,
               Ordinal numExportIDs,
               const Teuchos::ArrayView<const Ordinal> & exportLIDs,
               const Teuchos::ArrayView<Scalar> & exports,
               Ordinal &packetSize,
               Distributor<Ordinal> &distor);
  
    void unpackAndCombine(Ordinal numImportIDs,
               const Teuchos::ArrayView<const Ordinal> & importLIDs,
               const Teuchos::ArrayView<const Scalar> & imports,
               Distributor<Ordinal> &distor,
               CombineMode CM);

  }; // class Vector

} // namespace Tpetra

#endif // TPETRA_VECTOR_DECL_HPP

---