VectorSpace.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-2017 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_SPACE_H
#define UQ_VECTOR_SPACE_H

#include <queso/DistArray.h>
#include <queso/Map.h>
#include <queso/VectorSet.h>
#include <cmath>

namespace QUESO {

class GslVector;
class GslMatrix;

template <class V = GslVector, class M = GslMatrix>
class VectorSpace : public VectorSet<V,M>
{
public:



  VectorSpace(const BaseEnvironment&   env,
                     const char*                     prefix,
                     unsigned int                    dimGlobalValue,
                     const std::vector<std::string>* componentsNamesVec);

  ~VectorSpace();



  const BaseEnvironment&  env                     () const;

  const Map&              map                     () const;

  unsigned int                   numOfProcsForStorage    () const;


  unsigned int                   dimLocal                () const;
  unsigned int                   dimGlobal               () const;
  unsigned int                   globalIdOfFirstComponent() const;


  const V&                       zeroVector              () const;

  V*                             newVector               () const; // See template specialization

  V*                             newVector               (double value) const; // See template specialization

  V*                             newVector               (const V& v) const;

  M*                             newMatrix               () const; // See template specialization

  M*                             newDiagMatrix           (const V& v) const;

  M*                             newDiagMatrix           (double diagValue) const; // See template specialization


  M*                             newProposalMatrix       (const V* varVec, const V* auxVec) const;


  const VectorSpace<V,M>&       vectorSpace             () const; //

  bool                           contains                (const V& vec) const;

  void                           centroid                (V& vec) const;

  void                           moments                 (M& vec) const;

  const DistArray<std::string>* componentsNamesArray    () const;

  const std::vector<std::string>*      componentsNamesVec      () const;

  const std::string&                   localComponentName      (unsigned int localComponentId) const;


  void                           printComponentsNames    (std::ostream& os, bool printHorizontally) const;

  void                           print                   (std::ostream& os) const;
protected:
  Map*                    newMap                  (); // See template specialization

  using VectorSet<V,M>::m_env;
  using VectorSet<V,M>::m_prefix;
  using VectorSet<V,M>::m_volume;

  unsigned int                   m_dimGlobal;

  const Map*              m_map;

  unsigned int                   m_dimLocal;

  DistArray<std::string>* m_componentsNamesArray;

  DistArray<std::string>* m_componentsNamesVec;

  std::string                    m_emptyComponentName;

  V*                             m_zeroVector;

private:
  VectorSpace();

  VectorSpace(const VectorSpace<V,M>&  aux);
};

}  // End namespace QUESO

#endif // UQ_VECTOR_SPACE_H