/usr/include/roboptim/core/numeric-quadratic-function.hh is in libroboptim-core-dev 2.0-7.
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 | // Copyright (C) 2009 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_NUMERIC_QUADRATIC_FUNCTION_HH
# define ROBOPTIM_CORE_NUMERIC_QUADRATIC_FUNCTION_HH
# include <roboptim/core/sys.hh>
# include <roboptim/core/debug.hh>
# include <roboptim/core/quadratic-function.hh>
namespace roboptim
{
/// \addtogroup roboptim_function
/// @{
/// \brief Build a quadratic function from a matrix and a vector.
///
/// Implement a quadratic function using the general formula:
/// \f[f(x) = \frac{1}{2} x^t A x + b^t x\f]
/// where \f$A\f$ and \f$B\f$ are set when the class is instantiated.
///
/// \note A is a symmetric matrix.
class ROBOPTIM_DLLAPI NumericQuadraticFunction : public QuadraticFunction
{
public:
/// \brief Symmetric matrix type.
typedef matrix_t symmetric_t;
/// \brief Build a quadratic function from a matrix and a vector.
///
/// See class documentation for A and b definition.
/// \param A A symmetric matrix
/// \param b b vector
NumericQuadraticFunction (const symmetric_t& A, const vector_t& b)
throw ();
~NumericQuadraticFunction () throw ();
/// \brief Display the function on the specified output stream.
///
/// \param o output stream used for display
/// \return output stream
virtual std::ostream& print (std::ostream&) const throw ();
protected:
void impl_compute (result_t& , const argument_t&) const throw ();
void impl_gradient (gradient_t&, const argument_t&, size_type = 0)
const throw ();
void impl_hessian (hessian_t& hessian,
const argument_t& argument,
size_type functionId = 0) const throw ();
private:
/// \brief A matrix.
symmetric_t a_;
/// \brief B vector.
vector_t b_;
/// \brief buffer to avoid allocating during computation.
mutable vector_t buffer_;
};
/// Example shows numeric quadratic function use.
/// \example numeric-quadratic-function.cc
/// @}
} // end of namespace roboptim
#endif //! ROBOPTIM_CORE_QUADRATIC_FUNCTION_HH
|