proxsuite::nlp::python::FunctionWrap Struct Reference

Inheritance diagram for proxsuite::nlp::python::FunctionWrap:

Collaboration diagram for proxsuite::nlp::python::FunctionWrap:

Public Member Functions
VectorXs	operator() (const ConstVectorRef &x) const
	Evaluate the residual at a given point x.
	BaseFunctionTpl (const int nx, const int ndx, const int nr)
	BaseFunctionTpl (const ManifoldAbstractTpl< Scalar > &manifold, const int nr)
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)
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.
	BaseFunctionTpl (const int nx, const int ndx, const int nr)
	BaseFunctionTpl (const ManifoldAbstractTpl< Scalar > &manifold, const int nr)
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::BaseFunctionTpl< Scalar >
using	Scalar
using	Scalar
Public Types inherited from proxsuite::nlp::math_types< _Scalar >
using	Scalar = _Scalar
Public Attributes inherited from proxsuite::nlp::BaseFunctionTpl< Scalar >
	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_
int	nx_
int	ndx_
int	nr_

Detailed Description

Definition at line 9 of file function.hpp.

Member Function Documentation

operator()()

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

inlinevirtual

Evaluate the residual at a given point x.

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

Definition at line 15 of file function.hpp.

BaseFunctionTpl() [1/2]

proxsuite::nlp::BaseFunctionTpl< Scalar >::BaseFunctionTpl ( const int nx, const int ndx, const int nr )

inline

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

BaseFunctionTpl() [2/2]

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

inline

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

---

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

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