function.hh

Go to the documentation of this file.

// -*- tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 2 -*-
// vi: set et ts=4 sw=2 sts=2:
// SPDX-FileCopyrightInfo: Copyright (C) DUNE Project contributors, see file LICENSE.md in module root
// SPDX-License-Identifier: LicenseRef-GPL-2.0-only-with-DUNE-exception
#ifndef DUNE_FUNCTION_HH_SILENCE_DEPRECATION
#warning This file is deprecated after Dune 2.7!  Use C++ function objects and std::function stuff instead!
#else // !DUNE_FUNCTION_HH_SILENCE_DEPRECATION
#undef DUNE_FUNCTION_HH_SILENCE_DEPRECATION
#endif // !DUNE_FUNCTION_HH_SILENCE_DEPRECATION
 
#ifndef DUNE_FUNCTION_HH
#define DUNE_FUNCTION_HH
 
#include <utility>
 
#include <dune/common/deprecated.hh>
#include "typetraits.hh"
 
namespace Dune {
 
  template <class Domain, class Range>
  class
  [[deprecated("Dune::Function is deprecated after Dune 2.7.  Use C++ "
               "function objects instead!")]]
  Function
  {
    typedef typename std::remove_cv<typename std::remove_reference< Domain >::type >::type RawDomainType;
    typedef typename std::remove_cv<typename std::remove_reference< Range >::type >::type RawRangeType;
 
  public:
 
    typedef RawRangeType RangeType;
 
    typedef RawDomainType DomainType;
 
    struct Traits
    {
      typedef RawDomainType DomainType;
      typedef RawRangeType RangeType;
    };
 
    void evaluate(const typename Traits::DomainType& x, typename Traits::RangeType& y) const;
  }; // end of Function class
 
 
 
  DUNE_NO_DEPRECATED_BEGIN
  template <class DomainType, class RangeType>
  class
  [[deprecated("Dune::VirtualFunction is deprecated after Dune 2.7.  Use C++ "
               "function objects and std::function instead!")]]
  VirtualFunction : public Function<const DomainType&, RangeType&>
  {
  public:
    typedef typename Function<const DomainType&, RangeType&>::Traits Traits;
 
    virtual ~VirtualFunction() {}
    virtual void evaluate(const typename Traits::DomainType& x, typename Traits::RangeType& y) const = 0;
  }; // end of VirtualFunction class
  DUNE_NO_DEPRECATED_END
 
  namespace Impl {
 
  DUNE_NO_DEPRECATED_BEGIN
  template<typename Domain, typename Range, typename F>
  class LambdaVirtualFunction final
    : public VirtualFunction<Domain, Range>
  {
  public:
    LambdaVirtualFunction(F&& f)
      : f_(std::move(f))
      {}
 
    LambdaVirtualFunction(const F& f)
      : f_(f)
      {}
 
    void evaluate(const Domain& x, Range& y) const override
      {
        y = f_(x);
      }
 
  private:
    const F f_;
  };
  DUNE_NO_DEPRECATED_END
 
  } /* namespace Impl */
 
  template<typename Domain, typename Range, typename F>
  [[deprecated("Dune::LambdaVirtualFunction is deprecated after Dune 2.7.  "
               "Use std::function instead!")]]
  Impl::LambdaVirtualFunction< Domain, Range, std::decay_t<F> >
  makeVirtualFunction(F&& f)
  {
    return {std::forward<F>(f)};
  }
 
} // end namespace
 
#endif