Python bindings. More...

Classes
struct	C1FunctionWrap

struct	C2FunctionWrap

struct	CallbackWrapper

struct	CostWrapper

struct	FunctionWrap

struct	LDLTVisitor

struct	OwningNonOwningHolder

struct	PolymorphicVisitor

struct	PolymorphicVisitor< xyz::polymorphic< Base, A > >

struct	PolymorphicWrapper

Typedefs
using	PolymorphicManifold = polymorphic<Manifold>

using	CartesianProduct = CartesianProductTpl<Scalar>

using	L1Penalty = NonsmoothPenaltyL1Tpl<Scalar>

using	ConstraintSetProduct = ConstraintSetProductTpl<Scalar>

using	BoxConstraint = BoxConstraintTpl<Scalar>

using	PolyManifold = polymorphic<Manifold>

using	Manifold

using	Scalar

using	C2Function

using	Constraint

using	ConstraintSet

using	Scalar

using	Cost

using	Manifold

using	Scalar

using	C1Function

using	C2Function

using	Function

using	Manifold

using	Scalar

using	Manifold

using	Scalar

using	Cost

using	Scalar

using	C2Function

using	Manifold

using	Scalar

Functions
void	expose_finite_differences ()
	Expose finite difference helpers.

void	exposeAutodiff ()

void	exposeCallbacks ()

std::vector< VectorXs >	copy_vec_constref (const std::vector< ConstVectorRef > &x)

void	exposeCartesianProduct ()

template<typename T>
auto	exposeSpecificConstraintSet (const char name, const char docstring)

template<typename ConstraintType>
context::Constraint	make_constraint (const shared_ptr< context::C2Function > &f)

void	exposeConstraints ()

void	exposeQuadraticCosts ()
	Expose specific cost functions.

void	exposeCost ()

void	exposeFunctionOps ()

void	exposeFunctionTypes ()

void	exposeLdltRoutines ()

void	exposeManifoldBase ()

template<typename M>
bp::class_< TangentBundleTpl< M >, bp::bases< Manifold > >	exposeTangentBundle (const char name, const char docstring)
	Expose the tangent bundle of a manifold type `M`.

template<typename M, class Init>
bp::class_< TangentBundleTpl< M >, bp::bases< Manifold > >	exposeTangentBundle (const char name, const char docstring, Init init)
	Expose the tangent bundle with an additional constructor.

void	exposeManifolds ()

void	exposeProblem ()

void	exposeResiduals ()
	Expose some residual functions.

void	exposeResults ()

void	exposeSolver ()

void	exposeWorkspace ()

bp::arg	operator""_a (const char *argname, std::size_t)
	User-defined literal for bp::arg.

template<class Poly>
void	register_polymorphic_to_python ()
	Expose a polymorphic value type, e.g. xyz::polymorphic<T, A>.

template<typename T, class Init>
auto	expose_function (const char name, const char docstring, Init init)
	Expose a differentiable residual (subclass of C2FunctionTpl).

std::string	get_scope_name (bp::scope scope)

bp::object	get_namespace (const std::string &name)
	Create or retrieve a Python scope (that is, a class or module namespace).

void	exposeContainerTypes ()
	Expose some useful container types.

Detailed Description

Python bindings.

Typedef Documentation

◆ PolymorphicManifold

using proxsuite::nlp::python::PolymorphicManifold = polymorphic<Manifold>

Definition at line 12 of file expose-cartesian-product.cpp.

◆ CartesianProduct

typedef CartesianProductTpl< Scalar > proxsuite::nlp::python::CartesianProduct = CartesianProductTpl<Scalar>

Definition at line 16 of file expose-cartesian-product.cpp.

◆ L1Penalty

using proxsuite::nlp::python::L1Penalty = NonsmoothPenaltyL1Tpl<Scalar>

Definition at line 20 of file expose-constraint.cpp.

◆ ConstraintSetProduct

using proxsuite::nlp::python::ConstraintSetProduct = ConstraintSetProductTpl<Scalar>

Definition at line 21 of file expose-constraint.cpp.

◆ BoxConstraint

using proxsuite::nlp::python::BoxConstraint = BoxConstraintTpl<Scalar>

Definition at line 22 of file expose-constraint.cpp.

◆ PolyManifold

using proxsuite::nlp::python::PolyManifold = polymorphic<Manifold>

Definition at line 25 of file expose-manifold.cpp.

◆ Manifold [1/5]

using proxsuite::nlp::context::Manifold

Definition at line 26 of file context.hpp.

◆ Scalar [1/7]

proxsuite::nlp::context::Scalar

Definition at line 9 of file context.hpp.

◆ C2Function [1/3]

using proxsuite::nlp::context::C2Function

Definition at line 24 of file context.hpp.

◆ Constraint

using proxsuite::nlp::context::Constraint

Definition at line 19 of file context.hpp.

◆ ConstraintSet

using proxsuite::nlp::context::ConstraintSet

Definition at line 20 of file context.hpp.

◆ Scalar [2/7]

proxsuite::nlp::context::Scalar

Definition at line 9 of file context.hpp.

◆ Cost [1/2]

using proxsuite::nlp::context::Cost

Definition at line 18 of file context.hpp.

◆ Manifold [2/5]

using proxsuite::nlp::context::Manifold

Definition at line 26 of file context.hpp.

◆ Scalar [3/7]

proxsuite::nlp::context::Scalar

Definition at line 9 of file context.hpp.

◆ C1Function

using proxsuite::nlp::context::C1Function

Definition at line 23 of file context.hpp.

◆ C2Function [2/3]

using proxsuite::nlp::context::C2Function

Definition at line 24 of file context.hpp.

◆ Function

using proxsuite::nlp::context::Function

Definition at line 22 of file context.hpp.

◆ Manifold [3/5]

using proxsuite::nlp::context::Manifold

Definition at line 26 of file context.hpp.

◆ Scalar [4/7]

proxsuite::nlp::context::Scalar

Definition at line 9 of file context.hpp.

◆ Manifold [4/5]

using proxsuite::nlp::context::Manifold

Definition at line 26 of file context.hpp.

◆ Scalar [5/7]

proxsuite::nlp::context::Scalar

Definition at line 9 of file context.hpp.

◆ Cost [2/2]

using proxsuite::nlp::context::Cost

Definition at line 18 of file context.hpp.

◆ Scalar [6/7]

proxsuite::nlp::context::Scalar

Definition at line 9 of file context.hpp.

◆ C2Function [3/3]

using proxsuite::nlp::context::C2Function

Definition at line 24 of file context.hpp.

◆ Manifold [5/5]

using proxsuite::nlp::context::Manifold

Definition at line 26 of file context.hpp.

◆ Scalar [7/7]

proxsuite::nlp::context::Scalar

Definition at line 9 of file context.hpp.

Function Documentation

◆ expose_finite_differences()

void proxsuite::nlp::python::expose_finite_differences ( )

Expose finite difference helpers.

Definition at line 11 of file expose-autodiff.cpp.

◆ exposeAutodiff()

void proxsuite::nlp::python::exposeAutodiff ( )

Definition at line 40 of file expose-autodiff.cpp.

◆ exposeCallbacks()

void proxsuite::nlp::python::exposeCallbacks ( )

Definition at line 17 of file expose-callbacks.cpp.

◆ copy_vec_constref()

std::vector< VectorXs > proxsuite::nlp::python::copy_vec_constref ( const std::vector< ConstVectorRef > & x )

Definition at line 18 of file expose-cartesian-product.cpp.

◆ exposeCartesianProduct()

void proxsuite::nlp::python::exposeCartesianProduct ( )

Definition at line 25 of file expose-cartesian-product.cpp.

◆ exposeSpecificConstraintSet()

template<typename T>

auto proxsuite::nlp::python::exposeSpecificConstraintSet	(	const char *	name,
		const char *	docstring )

Definition at line 25 of file expose-constraint.cpp.

◆ make_constraint()

template<typename ConstraintType>

context::Constraint proxsuite::nlp::python::make_constraint ( const shared_ptr< context::C2Function > & f )

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

◆ exposeConstraints()

void proxsuite::nlp::python::exposeConstraints ( )

Todo: Expose properly using pure_virtual, to allow overriding from Python

Definition at line 38 of file expose-constraint.cpp.

◆ exposeQuadraticCosts()

void proxsuite::nlp::python::exposeQuadraticCosts ( )

Expose specific cost functions.

Definition at line 17 of file expose-quadratic-costs.cpp.

◆ exposeCost()

void proxsuite::nlp::python::exposeCost ( )

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

◆ exposeFunctionOps()

void proxsuite::nlp::python::exposeFunctionOps ( )

Definition at line 66 of file expose-function.cpp.

◆ exposeFunctionTypes()

void proxsuite::nlp::python::exposeFunctionTypes ( )

Definition at line 17 of file expose-function.cpp.

◆ exposeLdltRoutines()

void proxsuite::nlp::python::exposeLdltRoutines ( )

Definition at line 43 of file expose-ldlt.cpp.

◆ exposeManifoldBase()

void proxsuite::nlp::python::exposeManifoldBase ( )

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

◆ exposeTangentBundle() [1/2]

template<typename M>

bp::class_< TangentBundleTpl< M >, bp::bases< Manifold > > proxsuite::nlp::python::exposeTangentBundle	(	const char *	name,
		const char *	docstring )

Expose the tangent bundle of a manifold type M.

Definition at line 122 of file expose-manifold.cpp.

◆ exposeTangentBundle() [2/2]

template<typename M, class Init>

bp::class_< TangentBundleTpl< M >, bp::bases< Manifold > > proxsuite::nlp::python::exposeTangentBundle	(	const char *	name,
		const char *	docstring,
		Init	init )

Expose the tangent bundle with an additional constructor.

Definition at line 136 of file expose-manifold.cpp.

◆ exposeManifolds()

void proxsuite::nlp::python::exposeManifolds ( )

Definition at line 230 of file expose-manifold.cpp.

◆ exposeProblem()

void proxsuite::nlp::python::exposeProblem ( )

Definition at line 9 of file expose-problem.cpp.

◆ exposeResiduals()

void proxsuite::nlp::python::exposeResiduals ( )

Expose some residual functions.

Expose defined residuals for modelling.

Definition at line 19 of file expose-residual.cpp.

◆ exposeResults()

void proxsuite::nlp::python::exposeResults ( )

Definition at line 8 of file expose-results.cpp.

◆ exposeSolver()

void proxsuite::nlp::python::exposeSolver ( )

Definition at line 10 of file expose-solver.cpp.

◆ exposeWorkspace()

void proxsuite::nlp::python::exposeWorkspace ( )

Definition at line 8 of file expose-workspace.cpp.

◆ operator""_a()

bp::arg proxsuite::nlp::python::operator""_a	(	const char *	argname,
		std::size_t	)

inline

User-defined literal for bp::arg.

Definition at line 14 of file fwd.hpp.

◆ register_polymorphic_to_python()

template<class Poly>

void proxsuite::nlp::python::register_polymorphic_to_python ( )

inline

Expose a polymorphic value type, e.g. xyz::polymorphic<T, A>.

Just an alias for bp::register_ptr_to_python<>().

Definition at line 25 of file polymorphic.hpp.

◆ expose_function()

template<typename T, class Init>

auto proxsuite::nlp::python::expose_function	(	const char *	name,
		const char *	docstring,
		Init	init )

Expose a differentiable residual (subclass of C2FunctionTpl).

Definition at line 9 of file residuals.hpp.

◆ get_scope_name()

std::string proxsuite::nlp::python::get_scope_name ( bp::scope scope )

inline

Definition at line 10 of file namespace.hpp.

◆ get_namespace()

bp::object proxsuite::nlp::python::get_namespace ( const std::string & name )

inline

Create or retrieve a Python scope (that is, a class or module namespace).

Returns: The submodule with the input name.

Definition at line 20 of file namespace.hpp.

◆ exposeContainerTypes()

void proxsuite::nlp::python::exposeContainerTypes ( )

Expose some useful container types.

Definition at line 13 of file module.cpp.

Classes

Typedefs

Functions

Detailed Description

Typedef Documentation

◆ PolymorphicManifold

◆ CartesianProduct

◆ L1Penalty

◆ ConstraintSetProduct

◆ BoxConstraint

◆ PolyManifold

◆ Manifold [1/5]

◆ Scalar [1/7]

◆ C2Function [1/3]

◆ Constraint

◆ ConstraintSet

◆ Scalar [2/7]

◆ Cost [1/2]

◆ Manifold [2/5]

◆ Scalar [3/7]

◆ C1Function

◆ C2Function [2/3]

◆ Function

◆ Manifold [3/5]

◆ Scalar [4/7]

◆ Manifold [4/5]

◆ Scalar [5/7]

◆ Cost [2/2]

◆ Scalar [6/7]

◆ C2Function [3/3]

◆ Manifold [5/5]

◆ Scalar [7/7]

Function Documentation

◆ expose_finite_differences()

◆ exposeAutodiff()

◆ exposeCallbacks()

◆ copy_vec_constref()

◆ exposeCartesianProduct()

◆ exposeSpecificConstraintSet()

◆ make_constraint()

◆ exposeConstraints()

◆ exposeQuadraticCosts()

◆ exposeCost()

◆ exposeFunctionOps()

◆ exposeFunctionTypes()

◆ exposeLdltRoutines()

◆ exposeManifoldBase()

◆ exposeTangentBundle() [1/2]

◆ exposeTangentBundle() [2/2]

◆ exposeManifolds()

◆ exposeProblem()

◆ exposeResiduals()

◆ exposeResults()

◆ exposeSolver()

◆ exposeWorkspace()

◆ operator""_a()

◆ register_polymorphic_to_python()

◆ expose_function()

◆ get_scope_name()

◆ get_namespace()

◆ exposeContainerTypes()