Loading...
Searching...
No Matches
proxsuite::nlp::LinearFunctionTpl< _Scalar > Struct Template Reference
Linear residuals \(r(x) = Ax + b\). More...
#include <proxsuite-nlp/modelling/residuals/linear.hpp>
Inheritance diagram for proxsuite::nlp::LinearFunctionTpl< _Scalar >:
Collaboration diagram for proxsuite::nlp::LinearFunctionTpl< _Scalar >:
Public Types | |
| using | Scalar = _Scalar |
| using | Base = C2FunctionTpl<Scalar> |
 Public Types inherited from proxsuite::nlp::C2FunctionTpl< _Scalar > | |
| using | Scalar |
| using | Base |
| Public Types inherited from proxsuite::nlp::C1FunctionTpl< _Scalar > | |
| using | Scalar |
| using | Base |
| 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 | |
| LinearFunctionTpl (const ConstMatrixRef &A, const ConstVectorRef &b) | |
| LinearFunctionTpl (const ConstMatrixRef &A) | |
| VectorXs | operator() (const ConstVectorRef &x) const |
| Evaluate the residual at a given point x. | |
| void | computeJacobian (const ConstVectorRef &, MatrixRef Jout) const |
| Jacobian matrix of the constraint function. | |
| Public Member Functions inherited from proxsuite::nlp::C2FunctionTpl< _Scalar > | |
| C2FunctionTpl (const int nx, const int ndx, const int nr) | |
| C2FunctionTpl (const ManifoldAbstractTpl< _Scalar > &manifold, const int nr) | |
| virtual void | vectorHessianProduct (const ConstVectorRef &, const ConstVectorRef &, MatrixRef Hout) const |
| Vector-hessian product. | |
| Public Member Functions inherited from proxsuite::nlp::C1FunctionTpl< _Scalar > | |
| C1FunctionTpl (const int nx, const int ndx, const int nr) | |
| C1FunctionTpl (const ManifoldAbstractTpl< _Scalar > &manifold, const int nr) | |
| 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 | ~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 | |
| MatrixXs | mat |
| VectorXs | b |
| Public Attributes inherited from proxsuite::nlp::C2FunctionTpl< _Scalar > | |
| Scalar | |
| Public Attributes inherited from proxsuite::nlp::C1FunctionTpl< _Scalar > | |
| 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::LinearFunctionTpl< _Scalar >
struct proxsuite::nlp::LinearFunctionTpl< _Scalar >
Linear residuals \(r(x) = Ax + b\).
Definition at line 14 of file linear.hpp.
Member Typedef Documentation
◆ Scalar
template<typename _Scalar >
| using proxsuite::nlp::LinearFunctionTpl< _Scalar >::Scalar = _Scalar |
Definition at line 15 of file linear.hpp.
◆ Base
template<typename _Scalar >
| using proxsuite::nlp::LinearFunctionTpl< _Scalar >::Base = C2FunctionTpl<Scalar> |
Definition at line 18 of file linear.hpp.
Constructor & Destructor Documentation
◆ LinearFunctionTpl() [1/2]
template<typename _Scalar >
|
inline |
Definition at line 24 of file linear.hpp.
◆ LinearFunctionTpl() [2/2]
template<typename _Scalar >
|
inline |
Definition at line 27 of file linear.hpp.
Member Function Documentation
◆ operator()()
template<typename _Scalar >
|
inlinevirtual |
Evaluate the residual at a given point x.
Implements proxsuite::nlp::BaseFunctionTpl< _Scalar >.
Definition at line 30 of file linear.hpp.
◆ computeJacobian()
template<typename _Scalar >
|
inlinevirtual |
Jacobian matrix of the constraint function.
Implements proxsuite::nlp::C1FunctionTpl< _Scalar >.
Definition at line 32 of file linear.hpp.
Member Data Documentation
◆ Scalar
template<typename _Scalar >
| proxsuite::nlp::LinearFunctionTpl< _Scalar >::Scalar |
Definition at line 16 of file linear.hpp.
◆ mat
template<typename _Scalar >
| MatrixXs proxsuite::nlp::LinearFunctionTpl< _Scalar >::mat |
Definition at line 21 of file linear.hpp.
◆ b
template<typename _Scalar >
| VectorXs proxsuite::nlp::LinearFunctionTpl< _Scalar >::b |
Definition at line 22 of file linear.hpp.
The documentation for this struct was generated from the following file:
- include/proxsuite-nlp/modelling/residuals/linear.hpp
