proxsuite::nlp::python::CostWrapper Struct Reference

Inheritance diagram for proxsuite::nlp::python::CostWrapper:

Collaboration diagram for proxsuite::nlp::python::CostWrapper:

Public Member Functions
Scalar	call (const ConstVectorRef &x) const
	Evaluate the cost function.
void	computeGradient (const ConstVectorRef &x, VectorRef out) const
void	computeHessian (const ConstVectorRef &x, MatrixRef out) const
Public Member Functions inherited from proxsuite::nlp::CostFunctionBaseTpl< Scalar >
	CostFunctionBaseTpl (const int nx, const int ndx)
	CostFunctionBaseTpl (const ManifoldAbstractTpl< Scalar > &manifold)
VectorXs	computeGradient (const ConstVectorRef &x) const
MatrixXs	computeHessian (const ConstVectorRef &x) const
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.
	CostFunctionBaseTpl (const int nx, const int ndx)
	CostFunctionBaseTpl (const ManifoldAbstractTpl< Scalar > &manifold)
VectorXs	computeGradient (const ConstVectorRef &x) const
MatrixXs	computeHessian (const ConstVectorRef &x) const
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.
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)
	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.
	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)
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.

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

Additional Inherited Members
Public Types inherited from proxsuite::nlp::CostFunctionBaseTpl< Scalar >
using	Scalar
using	Base
using	Scalar
using	Base
Public Types inherited from proxsuite::nlp::C2FunctionTpl< Scalar >
using	Scalar
using	Base
using	Scalar
using	Base
Public Types inherited from proxsuite::nlp::C1FunctionTpl< Scalar >
using	Scalar
using	Base
using	Scalar
using	Base
Public Types inherited from proxsuite::nlp::BaseFunctionTpl< Scalar >
using	Scalar
using	Scalar
Public Types inherited from proxsuite::nlp::math_types< _Scalar >
using	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 22 of file expose-cost.cpp.

Member Function Documentation

call()

Scalar proxsuite::nlp::python::CostWrapper::call ( const ConstVectorRef & x ) const

inlinevirtual

Evaluate the cost function.

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

Definition at line 27 of file expose-cost.cpp.

computeGradient()

void proxsuite::nlp::python::CostWrapper::computeGradient ( const ConstVectorRef & x, VectorRef out ) const

inlinevirtual

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

Definition at line 28 of file expose-cost.cpp.

computeHessian()

void proxsuite::nlp::python::CostWrapper::computeHessian ( const ConstVectorRef & x, MatrixRef out ) const

inlinevirtual

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

Definition at line 31 of file expose-cost.cpp.

Member Data Documentation

Scalar

proxsuite::nlp::python::CostWrapper::Scalar

Definition at line 23 of file expose-cost.cpp.

---

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

• bindings/python/expose-cost.cpp