proxsuite::nlp::python::C2FunctionWrap Struct Reference

#include </home/runner/work/proxsuite-nlp/proxsuite-nlp/bindings/python/include/proxsuite-nlp/python/function.hpp>

Inheritance diagram for proxsuite::nlp::python::C2FunctionWrap:

Collaboration diagram for proxsuite::nlp::python::C2FunctionWrap:

Public Member Functions
VectorXs	operator() (const ConstVectorRef &x) const
	Evaluate the residual at a given point x.
void	computeJacobian (const ConstVectorRef &x, MatrixRef Jout) const
	Jacobian matrix of the constraint function.
void	vectorHessianProduct (const ConstVectorRef &x, const ConstVectorRef &v, MatrixRef Hout) const
	Vector-hessian product.
MatrixXs	getVHP (const ConstVectorRef &x, const ConstVectorRef &v) const
void	default_vhp (const ConstVectorRef &x, const ConstVectorRef &v, MatrixRef Hout) const
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)
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.

Additional Inherited Members
Public Types inherited from proxsuite::nlp::C2FunctionTpl< Scalar >
using	Scalar = _Scalar
using	Base = C1FunctionTpl<_Scalar>
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 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
Protected Attributes inherited from proxsuite::nlp::BaseFunctionTpl< _Scalar >
int	nx_
int	ndx_
int	nr_

Detailed Description

Definition at line 37 of file function.hpp.

Member Function Documentation

operator()()

VectorXs proxsuite::nlp::python::C2FunctionWrap::operator() ( const ConstVectorRef & x ) const

inlinevirtual

Evaluate the residual at a given point x.

Implements proxsuite::nlp::BaseFunctionTpl< _Scalar >.

Definition at line 42 of file function.hpp.

computeJacobian()

void proxsuite::nlp::python::C2FunctionWrap::computeJacobian ( const ConstVectorRef & x, MatrixRef Jout ) const

inlinevirtual

Jacobian matrix of the constraint function.

Implements proxsuite::nlp::C1FunctionTpl< _Scalar >.

Definition at line 47 of file function.hpp.

vectorHessianProduct()

void proxsuite::nlp::python::C2FunctionWrap::vectorHessianProduct ( const ConstVectorRef & , const ConstVectorRef & , MatrixRef Hout ) const

inlinevirtual

Vector-hessian product.

Reimplemented from proxsuite::nlp::C2FunctionTpl< Scalar >.

Definition at line 52 of file function.hpp.

getVHP()

MatrixXs proxsuite::nlp::python::C2FunctionWrap::getVHP ( const ConstVectorRef & x, const ConstVectorRef & v ) const

inline

Definition at line 62 of file function.hpp.

default_vhp()

void proxsuite::nlp::python::C2FunctionWrap::default_vhp ( const ConstVectorRef & x, const ConstVectorRef & v, MatrixRef Hout ) const

inline

Definition at line 69 of file function.hpp.

---

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

• bindings/python/include/proxsuite-nlp/python/function.hpp