VectorFunction.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_BASE_VECTOR_FUNCTION_H
#define UQ_BASE_VECTOR_FUNCTION_H

#include <queso/Environment.h>
#include <queso/DistArray.h>
#include <queso/VectorSet.h>

namespace QUESO {

class GslVector;
class GslMatrix;

template <class P_V = GslVector, class P_M = GslMatrix, class Q_V = GslVector, class Q_M = GslMatrix>
class BaseVectorFunction {
public:


  BaseVectorFunction(const char*                      prefix,
                            const VectorSet<P_V,P_M>& domainSet,
                            const VectorSet<Q_V,Q_M>& imageSet);
  virtual ~BaseVectorFunction();



  const VectorSet<P_V,P_M>& domainSet() const;

  const VectorSet<Q_V,Q_M>& imageSet () const;

  virtual void  compute  (const P_V&              domainVector,
                          const P_V*              domainDirection,
                          Q_V&                    imageVector,
                          DistArray<P_V*>* gradVectors,     // Yes, 'P_V'
                          DistArray<P_M*>* hessianMatrices, // Yes, 'P_M'
                          DistArray<P_V*>* hessianEffects) const = 0;
protected:
  const BaseEnvironment&    m_env;
        std::string                m_prefix;

  const VectorSet<P_V,P_M>& m_domainSet;

  const VectorSet<Q_V,Q_M>& m_imageSet;
};

}  // End namespace QUESO

#endif // UQ_BASE_VECTOR_FUNCTION_H