/usr/include/roboptim/core/filter/cached-function.hh is in libroboptim-core-dev 2.0-6.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 | // Copyright (C) 2010 by Thomas Moulard, AIST, CNRS, INRIA.
//
// This file is part of the roboptim.
//
// roboptim is free software: you can redistribute it and/or modify
// it under the terms of the GNU Lesser General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// roboptim 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 roboptim. If not, see <http://www.gnu.org/licenses/>.
#ifndef ROBOPTIM_CORE_FILTER_CACHED_FUNCTION_HH
# define ROBOPTIM_CORE_FILTER_CACHED_FUNCTION_HH
# include <roboptim/core/sys.hh>
# include <roboptim/core/debug.hh>
# include <map>
# include <boost/shared_ptr.hpp>
# include <roboptim/core/n-times-derivable-function.hh>
namespace roboptim
{
/// \addtogroup roboptim_filter
/// @{
namespace detail
{
struct ltvector
{
bool operator()(const Function::vector_t& v1,
const Function::vector_t& v2) const
{
Function::size_type it1 = 0;
Function::size_type it2 = 0;
while (it1 != v1.size () && it2 != v2.size ())
{
if (fabs (v1(it1) - v2(it2)) < Function::epsilon ())
++it1, ++it2;
else if (v1(it1) - v2(it2) < - Function::epsilon ())
return true;
else return false;
}
return false;
}
};
} // end of namespace detail.
/// \brief Store previous function computation.
///
/// When an expensive function is called several times at the same
/// point (exactly!), the cached function prevents useless
/// computation by caching the function result.
///
/// This filter is experimental in this release.
template <typename T>
class CachedFunction : public T
{
public:
/// \brief Import value type.
typedef typename DifferentiableFunction::value_type value_type;
/// \brief Import size type.
typedef typename DifferentiableFunction::size_type size_type;
/// \brief Import vector type.
typedef typename DifferentiableFunction::vector_t vector_t;
/// \brief Import result type.
typedef typename DifferentiableFunction::result_t result_t;
/// \brief Import argument type.
typedef typename DifferentiableFunction::argument_t argument_t;
/// \brief Import gradient type.
typedef typename DifferentiableFunction::gradient_t gradient_t;
/// \brief Import hessian type.
typedef typename TwiceDifferentiableFunction::hessian_t hessian_t;
/// \brief Import jacobian type.
typedef typename DifferentiableFunction::jacobian_t jacobian_t;
/// \brief Import interval type.
typedef typename DifferentiableFunction::interval_t interval_t;
typedef std::map<Function::vector_t, Function::vector_t, detail::ltvector>
functionCache_t;
typedef std::map<Function::vector_t, hessian_t, detail::ltvector>
hessianCache_t;
explicit CachedFunction (boost::shared_ptr<const T> fct) throw ();
~CachedFunction () throw ();
void reset () throw ();
protected:
virtual void impl_compute (result_t& result, const argument_t& argument)
const throw ();
virtual void impl_gradient (gradient_t& gradient,
const argument_t& argument,
size_type functionId = 0)
const throw ();
virtual void impl_hessian (hessian_t& hessian,
const argument_t& argument,
size_type functionId = 0) const throw ();
virtual void impl_derivative (gradient_t& derivative,
double argument,
size_type order = 1) const throw ();
private:
boost::shared_ptr<const T> function_;
mutable std::vector<functionCache_t> cache_;
mutable std::vector<functionCache_t> gradientCache_;
mutable std::vector<hessianCache_t> hessianCache_;
};
/// @}
} // end of namespace roboptim
# include <roboptim/core/filter/cached-function.hxx>
#endif //! ROBOPTIM_CORE_FILTER_CACHED_FUNCTION_HH
|