n-times-derivable-function.hh File Reference

#include <roboptim/core/sys.hh>
#include <roboptim/core/debug.hh>
#include <boost/static_assert.hpp>
#include <roboptim/core/fwd.hh>
#include <roboptim/core/twice-differentiable-function.hh>
#include <roboptim/core/n-times-derivable-function.hxx>

Include dependency graph for n-times-derivable-function.hh:

This graph shows which files directly or indirectly include this file:

Classes
class	roboptim::NTimesDerivableFunction< DerivabilityOrder >
	Define a function, derivable n times ( ). More...

Namespaces
namespace	roboptim
	defined(EIGEN_RUNTIME_NO_MALLOC) && !defined(ROBOPTIM_DO_NOT_CHECK_ALLOCATION)

Macros
#define	ROBOPTIM_NTIMES_DERIVABLE_FUNCTION_FWD_TYPEDEFS(PARENT)
#define	ROBOPTIM_NTIMES_DERIVABLE_FUNCTION_FWD_TYPEDEFS_(PARENT)

Functions
	roboptim::ROBOPTIM_GENERATE_TRAITS_REFS_T (derivative, traits_t)
	Explicit specialization for the stop case of NTimesDerivable class.
virtual size_type	roboptim::derivabilityOrderMax () const
	Returns the maximum derivability order (relevant for N>2 only).
virtual	roboptim::~NTimesDerivableFunction ()
size_type	roboptim::derivativeSize () const
	Return the size of the derivative vector.
bool	roboptim::isValidDerivative (const_derivative_ref derivative) const
	Check if a derivative is valid (check sizes).
result_t	roboptim::operator() (value_type argument) const
	Evaluate the function at a specified point.
void	roboptim::operator() (result_ref result, value_type argument) const
	Evaluate the function at a specified point.
derivative_t	roboptim::derivative (value_type argument, size_type order=1) const
	Compute the derivative of the function.
void	roboptim::derivative (derivative_ref derivative, value_type argument, size_type order=1) const
	Compute the derivative of the function.
virtual std::ostream &	roboptim::print (std::ostream &o) const
	Display the function on the specified output stream.
	roboptim::NTimesDerivableFunction (size_type outputSize=1, std::string name=std::string())
	Concrete class constructor should call this constructor.
void	roboptim::impl_compute (result_ref result, const_argument_ref argument) const
	Function evaluation.
virtual void	roboptim::impl_compute (result_ref result, value_type t) const =0
	Function evaluation.
void	roboptim::impl_gradient (gradient_ref gradient, const_argument_ref argument, size_type functionId=0) const
	Gradient evaluation.
virtual void	roboptim::impl_derivative (derivative_ref derivative, value_type argument, size_type order=1) const =0
	Derivative evaluation.
void	roboptim::impl_hessian (hessian_ref hessian, const_argument_ref argument, size_type functionId=0) const
	Hessian evaluation.

Variables
static const size_type	roboptim::derivabilityOrder = 2
	Function derivability order.

Macro Definition Documentation

ROBOPTIM_NTIMES_DERIVABLE_FUNCTION_FWD_TYPEDEFS

#define ROBOPTIM_NTIMES_DERIVABLE_FUNCTION_FWD_TYPEDEFS

(

PARENT

)

Value:

  ROBOPTIM_TWICE_DIFFERENTIABLE_FUNCTION_FWD_TYPEDEFS(PARENT);    \
  ROBOPTIM_GENERATE_FWD_REFS (derivative)

ROBOPTIM_NTIMES_DERIVABLE_FUNCTION_FWD_TYPEDEFS_

#define ROBOPTIM_NTIMES_DERIVABLE_FUNCTION_FWD_TYPEDEFS_

(

PARENT

)

Value:

  ROBOPTIM_TWICE_DIFFERENTIABLE_FUNCTION_FWD_TYPEDEFS_(PARENT);   \
  ROBOPTIM_GENERATE_FWD_REFS_ (derivative)