proxsuite::nlp::C1FunctionTpl< _Scalar > Struct Template Reference

Differentiable function, with method for the Jacobian. More...

#include <proxsuite-nlp/function-base.hpp>

Inheritance diagram for proxsuite::nlp::C1FunctionTpl< _Scalar >:

Collaboration diagram for proxsuite::nlp::C1FunctionTpl< _Scalar >:

Public Types
using	Scalar = _Scalar
using	Base = BaseFunctionTpl<_Scalar>
Public Types inherited from proxsuite::nlp::BaseFunctionTpl< _Scalar >
using	Scalar = _Scalar
Public Types inherited from proxsuite::nlp::math_types< _Scalar >
using	Scalar = _Scalar

Public Member Functions
	C1FunctionTpl (const int nx, const int ndx, const int nr)
	C1FunctionTpl (const ManifoldAbstractTpl< Scalar > &manifold, const int nr)
virtual void	computeJacobian (const ConstVectorRef &x, MatrixRef Jout) const =0
	Jacobian matrix of the constraint function.
MatrixXs	computeJacobian (const ConstVectorRef &x) const
	Jacobian matrix of the constraint function.
Public Member Functions inherited from proxsuite::nlp::BaseFunctionTpl< _Scalar >
	BaseFunctionTpl (const int nx, const int ndx, const int nr)
	BaseFunctionTpl (const ManifoldAbstractTpl< Scalar > &manifold, const int nr)
virtual VectorXs	operator() (const ConstVectorRef &x) const =0
	Evaluate the residual at a given point x.
int	nx () const
	Get function input vector size (representation of manifold).
int	ndx () const
	Get input manifold's tangent space dimension.
int	nr () const
	Get function codimension.

Public Attributes
	Scalar
Public Attributes inherited from proxsuite::nlp::BaseFunctionTpl< _Scalar >
	Scalar
Public Attributes inherited from proxsuite::nlp::math_types< _Scalar >
	_Scalar

Additional Inherited Members
Protected Attributes inherited from proxsuite::nlp::BaseFunctionTpl< _Scalar >
int	nx_
int	ndx_
int	nr_

Detailed Description

template<typename _Scalar>
struct proxsuite::nlp::C1FunctionTpl< _Scalar >

Differentiable function, with method for the Jacobian.

Definition at line 45 of file function-base.hpp.

Member Typedef Documentation

Scalar

template<typename _Scalar>

using proxsuite::nlp::C1FunctionTpl< _Scalar >::Scalar = _Scalar

Definition at line 47 of file function-base.hpp.

Base

template<typename _Scalar>

using proxsuite::nlp::C1FunctionTpl< _Scalar >::Base = BaseFunctionTpl<_Scalar>

Definition at line 48 of file function-base.hpp.

Constructor & Destructor Documentation

C1FunctionTpl() [1/2]

template<typename _Scalar>

proxsuite::nlp::C1FunctionTpl< _Scalar >::C1FunctionTpl ( const int nx, const int ndx, const int nr )

inline

Definition at line 53 of file function-base.hpp.

C1FunctionTpl() [2/2]

template<typename _Scalar>

proxsuite::nlp::C1FunctionTpl< _Scalar >::C1FunctionTpl ( const ManifoldAbstractTpl< Scalar > & manifold, const int nr )

inline

Definition at line 55 of file function-base.hpp.

Member Function Documentation

computeJacobian() [1/2]

template<typename _Scalar>

virtual void proxsuite::nlp::C1FunctionTpl< _Scalar >::computeJacobian ( const ConstVectorRef & x, MatrixRef Jout ) const

pure virtual

Jacobian matrix of the constraint function.

Implemented in proxsuite::nlp::autodiff::finite_difference_wrapper< _Scalar, TOC1 >, proxsuite::nlp::autodiff::finite_difference_wrapper< _Scalar, TOC2 >, proxsuite::nlp::ComposeFunctionTpl< _Scalar >, proxsuite::nlp::ComposeFunctionTpl< Scalar >, proxsuite::nlp::ComposeFunctionTpl< Scalar >, proxsuite::nlp::CostFunctionBaseTpl< _Scalar >, proxsuite::nlp::CostFunctionBaseTpl< Scalar >, proxsuite::nlp::CostFunctionBaseTpl< Scalar >, proxsuite::nlp::LinearFunctionTpl< _Scalar >, proxsuite::nlp::ManifoldDifferenceToPoint< _Scalar >, proxsuite::nlp::ManifoldDifferenceToPoint< Scalar >, proxsuite::nlp::ManifoldDifferenceToPoint< Scalar >, proxsuite::nlp::python::C1FunctionWrap, proxsuite::nlp::python::C2FunctionWrap, and proxsuite::nlp::RigidTransformationPointActionTpl< Scalar >.

computeJacobian() [2/2]

template<typename _Scalar>

MatrixXs proxsuite::nlp::C1FunctionTpl< _Scalar >::computeJacobian ( const ConstVectorRef & x ) const

inline

Jacobian matrix of the constraint function.

Allocated version of the computeJacobian() method.

Definition at line 66 of file function-base.hpp.

Member Data Documentation

Scalar

template<typename _Scalar>

proxsuite::nlp::C1FunctionTpl< _Scalar >::Scalar

Definition at line 49 of file function-base.hpp.

---

The documentation for this struct was generated from the following file:

• include/proxsuite-nlp/function-base.hpp