Differentiable function, with method for the Jacobian. More...
#include <proxsuite-nlp/function-base.hpp>
Public Types | |
| using | Scalar = _Scalar |
| using | Base = BaseFunctionTpl<_Scalar> |
 Public Types inherited from proxsuite::nlp::BaseFunctionTpl< _Scalar > | |
| using | 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. | |
| virtual | ~BaseFunctionTpl ()=default |
| 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
struct proxsuite::nlp::C1FunctionTpl< Scalar >
Differentiable function, with method for the Jacobian.
Member Typedef Documentation
◆ Scalar
| using proxsuite::nlp::C1FunctionTpl< Scalar >::Scalar = _Scalar |
Definition at line 47 of file function-base.hpp.
◆ Base
| using proxsuite::nlp::C1FunctionTpl< Scalar >::Base = BaseFunctionTpl<_Scalar> |
Definition at line 48 of file function-base.hpp.
Constructor & Destructor Documentation
◆ C1FunctionTpl() [1/2]
|
inline |
Definition at line 53 of file function-base.hpp.
◆ C1FunctionTpl() [2/2]
|
inline |
Definition at line 55 of file function-base.hpp.
Member Function Documentation
◆ computeJacobian() [1/2]
|
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::CostFunctionBaseTpl< Scalar >, proxsuite::nlp::CostFunctionBaseTpl< _Scalar >, proxsuite::nlp::LinearFunctionTpl< _Scalar >, proxsuite::nlp::ManifoldDifferenceToPoint< _Scalar >, proxsuite::nlp::python::C1FunctionWrap, proxsuite::nlp::python::C2FunctionWrap, and proxsuite::nlp::RigidTransformationPointActionTpl< Scalar >.
◆ computeJacobian() [2/2]
|
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
| proxsuite::nlp::C1FunctionTpl< Scalar >::Scalar |
Definition at line 49 of file function-base.hpp.
The documentation for this struct was generated from the following files:
- include/proxsuite-nlp/function-base.hpp
- include/proxsuite-nlp/fwd.hpp
