VectorSet.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_SET_H
#define UQ_VECTOR_SET_H

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

namespace QUESO {

class GslVector;
class GslMatrix;

template <class V, class M>
class VectorSpace;

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


  VectorSet(const BaseEnvironment& env, const char* prefix, double volume);

  virtual ~VectorSet();


  const BaseEnvironment&  env        ()                 const;

  const std::string&             prefix     ()                 const;


  double                   volume     ()                 const;

  virtual const VectorSpace<V,M>& vectorSpace()                 const = 0;

  virtual       bool                     contains   (const V& vec)     const = 0;

  virtual       void                     centroid   (V& vec)     const = 0;

  virtual       void                     moments    (M& mat)     const = 0;


  virtual       void                     print      (std::ostream& os) const;
  friend std::ostream & operator<<(std::ostream & os,
      const VectorSet<V, M> & obj) {
    obj.print(os);
    return os;
  }

protected:
  const BaseEnvironment& m_env;
        std::string             m_prefix;
        double                  m_volume;

private:

  VectorSet();
};

}  // End namespace QUESO

#endif // UQ_VECTOR_SET_H