proxsuite::nlp::BaseFunctionTpl< Scalar > Struct Template Reference

Base function type. More...

#include <proxsuite-nlp/function-base.hpp>

Inheritance diagram for proxsuite::nlp::BaseFunctionTpl< Scalar >:

Collaboration diagram for proxsuite::nlp::BaseFunctionTpl< Scalar >:

Public Types
using	Scalar = _Scalar
Public Types inherited from proxsuite::nlp::math_types< _Scalar >
using	Scalar = _Scalar

Public Member Functions
	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::math_types< _Scalar >
	_Scalar

Protected Attributes
int	nx_
int	ndx_
int	nr_

Detailed Description

template<typename Scalar>
struct proxsuite::nlp::BaseFunctionTpl< Scalar >

Base function type.

Definition at line 70 of file fwd.hpp.

Member Typedef Documentation

Scalar

template<typename Scalar >

using proxsuite::nlp::BaseFunctionTpl< Scalar >::Scalar = _Scalar

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

Constructor & Destructor Documentation

BaseFunctionTpl() [1/2]

template<typename Scalar >

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]

template<typename Scalar >

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

inline

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

~BaseFunctionTpl()

template<typename Scalar >

virtual proxsuite::nlp::BaseFunctionTpl< Scalar >::~BaseFunctionTpl ( )

virtualdefault

Member Function Documentation

operator()()

template<typename Scalar >

virtual VectorXs proxsuite::nlp::BaseFunctionTpl< Scalar >::operator() ( const ConstVectorRef & x ) const

pure virtual

Evaluate the residual at a given point x.

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, proxsuite::nlp::python::FunctionWrap, and proxsuite::nlp::RigidTransformationPointActionTpl< Scalar >.

nx()

template<typename Scalar >

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

inline

Get function input vector size (representation of manifold).

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

ndx()

template<typename Scalar >

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

inline

Get input manifold's tangent space dimension.

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

nr()

template<typename Scalar >

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

inline

Get function codimension.

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

Member Data Documentation

nx_

template<typename Scalar >

int proxsuite::nlp::BaseFunctionTpl< Scalar >::nx_

protected

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

ndx_

template<typename Scalar >

int proxsuite::nlp::BaseFunctionTpl< Scalar >::ndx_

protected

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

nr_

template<typename Scalar >

int proxsuite::nlp::BaseFunctionTpl< Scalar >::nr_

protected

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

Scalar

template<typename Scalar >

proxsuite::nlp::BaseFunctionTpl< Scalar >::Scalar

Definition at line 21 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