Vector.h

Go to the documentation of this file.

//-----------------------------------------------------------------------bl-
//--------------------------------------------------------------------------
//
// QUESO - a library to support the Quantification of Uncertainty
// for Estimation, Simulation and Optimization
//
// Copyright (C) 2008-2015 The PECOS Development Team
//
// This library is free software; you can redistribute it and/or
// modify it under the terms of the Version 2.1 GNU Lesser General
// Public License as published by the Free Software Foundation.
//
// 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. 51 Franklin Street, Fifth Floor,
// Boston, MA  02110-1301  USA
//
//-----------------------------------------------------------------------el-

#ifndef UQ_VECTOR_H
#define UQ_VECTOR_H

#include <queso/Environment.h>
#include <queso/Map.h>
#include <iostream>
#include <queso/Defines.h>

namespace QUESO {

class Vector
{
public:


  Vector();

  Vector(const BaseEnvironment& env, const Map& map);

  Vector(const Vector& rhs);

  virtual ~Vector();



  Vector& operator=(const Vector& rhs);

  Vector& operator*=(double a);

  Vector& operator/=(double a);

  Vector& operator+=(const Vector& rhs);

  Vector& operator-=(const Vector& rhs);


    const BaseEnvironment& env                 ()           const;
    const Map&             map                 ()           const;
          unsigned int            numOfProcsForStorage()           const;


  virtual unsigned int            sizeLocal           () const = 0;

  virtual unsigned int            sizeGlobal          () const = 0;


  virtual void                    cwSet               (double value) = 0;

  virtual void                    cwSetGaussian       (double mean, double stdDev) = 0;

  virtual void                    cwInvert            () = 0;



  virtual void                    sort                () = 0;

  virtual void                    print               (std::ostream& os) const = 0;

          void                    setPrintHorizontally(bool value) const; // Yes, 'const'

          bool                    getPrintHorizontally()           const;

          void                    setPrintScientific  (bool value) const; // Yes, 'const'

          bool                    getPrintScientific  ()           const;


protected:

  virtual void                    copy                (const Vector& src);

  const BaseEnvironment& m_env;

#ifdef QUESO_CLASSES_INSTANTIATE_NEW_MAPS

  const Map              m_map;
#else

  const Map&             m_map;
#endif

  mutable bool                  m_printHorizontally;

  mutable bool                  m_printScientific;
};

}  // End namespace QUESO

#endif // UQ_VECTOR_H