aligator::NewtonRaphson< Scalar > Struct Template Reference

Newton-Raphson procedure, e.g. to compute forward dynamics from implicit functions. More...

#include <aligator/utils/newton-raphson.hpp>

Classes
struct	Options

Public Types
using	Manifold = ManifoldAbstractTpl<Scalar>

Public Member Functions
	ALIGATOR_DYNAMIC_TYPEDEFS (Scalar)

Static Public Member Functions
template<typename Fun, typename JacFun>
static bool	run (const Manifold &space, Fun &&fun, JacFun &&jac_fun, const ConstVectorRef &xinit, VectorRef xout, VectorRef f0, VectorRef dx, MatrixRef Jf0, Scalar eps=1e-6, std::size_t max_iters=1000, Options options=Options{})

Detailed Description

template<typename Scalar>
struct aligator::NewtonRaphson< Scalar >

Newton-Raphson procedure, e.g. to compute forward dynamics from implicit functions.

Definition at line 11 of file newton-raphson.hpp.

Member Typedef Documentation

Manifold

template<typename Scalar>

using aligator::NewtonRaphson< Scalar >::Manifold = ManifoldAbstractTpl<Scalar>

Definition at line 13 of file newton-raphson.hpp.

Member Function Documentation

ALIGATOR_DYNAMIC_TYPEDEFS()

template<typename Scalar>

aligator::NewtonRaphson< Scalar >::ALIGATOR_DYNAMIC_TYPEDEFS

(

Scalar

)

run()

template<typename Scalar>

template<typename Fun, typename JacFun>

bool aligator::NewtonRaphson< Scalar >::run ( const Manifold & space, Fun && fun, JacFun && jac_fun, const ConstVectorRef & xinit, VectorRef xout, VectorRef f0, VectorRef dx, MatrixRef Jf0, Scalar eps = 1e-6, std::size_t max_iters = 1000, Options options = Options{} )

inlinestatic

Definition at line 22 of file newton-raphson.hpp.

---

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

• include/aligator/utils/newton-raphson.hpp