#include <contact-solver-base.hpp>

Inheritance diagram for pinocchio::ContactSolverBaseTpl< _Scalar >:

Public Types
typedef _Scalar	Scalar

Public Member Functions
	ContactSolverBaseTpl (const int problem_size)

Scalar	getAbsoluteConvergenceResidual () const
	Returns the value of the absolute residual value corresponding to the contact complementary conditions. More...

Scalar	getAbsolutePrecision () const
	Get the absolute precision requested. More...

int	getIterationCount () const
	Get the number of iterations achieved by the solver. More...

int	getMaxIterations () const
	Get the maximum number of iterations allowed. More...

int	getProblemSize () const
	Returns the size of the problem. More...

Scalar	getRelativeConvergenceResidual () const
	Returns the value of the relative residual value corresponding to the difference between two successive iterates (infinity norms). More...

Scalar	getRelativePrecision () const
	Get the relative precision requested. More...

void	setAbsolutePrecision (const Scalar absolute_precision)
	Set the absolute precision for the problem. More...

void	setMaxIterations (const int max_it)
	Set the maximum number of iterations. More...

void	setRelativePrecision (const Scalar relative_precision)
	Set the relative precision for the problem. More...

Protected Attributes
Scalar	absolute_precision
	Desired absolute precision. More...

Scalar	absolute_residual
	Absolule convergence residual value. More...

int	it
	Number of iterations needed to achieve convergence. More...

int	max_it
	More...

int	problem_size
	Size of the problem. More...

Scalar	relative_precision
	Desired relative precision. More...

Scalar	relative_residual
	Relative convergence residual value. More...

Detailed Description

template<typename _Scalar>
struct pinocchio::ContactSolverBaseTpl< _Scalar >

Definition at line 19 of file algorithm/contact-solver-base.hpp.

Member Typedef Documentation

◆ Scalar

template<typename _Scalar >

typedef _Scalar pinocchio::ContactSolverBaseTpl< _Scalar >::Scalar

Definition at line 21 of file algorithm/contact-solver-base.hpp.

Constructor & Destructor Documentation

◆ ContactSolverBaseTpl()

template<typename _Scalar >

pinocchio::ContactSolverBaseTpl< _Scalar >::ContactSolverBaseTpl ( const int problem_size )

inlineexplicit

Definition at line 28 of file algorithm/contact-solver-base.hpp.

Member Function Documentation

◆ getAbsoluteConvergenceResidual()

template<typename _Scalar >

Scalar pinocchio::ContactSolverBaseTpl< _Scalar >::getAbsoluteConvergenceResidual ( ) const

inline

Returns the value of the absolute residual value corresponding to the contact complementary conditions.

Definition at line 94 of file algorithm/contact-solver-base.hpp.

◆ getAbsolutePrecision()

template<typename _Scalar >

Scalar pinocchio::ContactSolverBaseTpl< _Scalar >::getAbsolutePrecision ( ) const

inline

Get the absolute precision requested.

Definition at line 74 of file algorithm/contact-solver-base.hpp.

◆ getIterationCount()

template<typename _Scalar >

int pinocchio::ContactSolverBaseTpl< _Scalar >::getIterationCount ( ) const

inline

Get the number of iterations achieved by the solver.

Definition at line 49 of file algorithm/contact-solver-base.hpp.

◆ getMaxIterations()

template<typename _Scalar >

int pinocchio::ContactSolverBaseTpl< _Scalar >::getMaxIterations ( ) const

inline

Get the maximum number of iterations allowed.

Definition at line 61 of file algorithm/contact-solver-base.hpp.

◆ getProblemSize()

template<typename _Scalar >

int pinocchio::ContactSolverBaseTpl< _Scalar >::getProblemSize ( ) const

inline

Returns the size of the problem.

Definition at line 43 of file algorithm/contact-solver-base.hpp.

◆ getRelativeConvergenceResidual()

template<typename _Scalar >

Scalar pinocchio::ContactSolverBaseTpl< _Scalar >::getRelativeConvergenceResidual ( ) const

inline

Returns the value of the relative residual value corresponding to the difference between two successive iterates (infinity norms).

Definition at line 100 of file algorithm/contact-solver-base.hpp.

◆ getRelativePrecision()

template<typename _Scalar >

Scalar pinocchio::ContactSolverBaseTpl< _Scalar >::getRelativePrecision ( ) const

inline

Get the relative precision requested.

Definition at line 87 of file algorithm/contact-solver-base.hpp.

◆ setAbsolutePrecision()

template<typename _Scalar >

void pinocchio::ContactSolverBaseTpl< _Scalar >::setAbsolutePrecision ( const Scalar absolute_precision )

inline

Set the absolute precision for the problem.

Definition at line 67 of file algorithm/contact-solver-base.hpp.

◆ setMaxIterations()

template<typename _Scalar >

void pinocchio::ContactSolverBaseTpl< _Scalar >::setMaxIterations ( const int max_it )

inline

Set the maximum number of iterations.

Definition at line 55 of file algorithm/contact-solver-base.hpp.

◆ setRelativePrecision()

template<typename _Scalar >

void pinocchio::ContactSolverBaseTpl< _Scalar >::setRelativePrecision ( const Scalar relative_precision )

inline

Set the relative precision for the problem.

Definition at line 80 of file algorithm/contact-solver-base.hpp.

Member Data Documentation

◆ absolute_precision

template<typename _Scalar >

Scalar pinocchio::ContactSolverBaseTpl< _Scalar >::absolute_precision

protected

Desired absolute precision.

Definition at line 120 of file algorithm/contact-solver-base.hpp.

◆ absolute_residual

template<typename _Scalar >

Scalar pinocchio::ContactSolverBaseTpl< _Scalar >::absolute_residual

protected

Absolule convergence residual value.

Definition at line 124 of file algorithm/contact-solver-base.hpp.

◆ it

template<typename _Scalar >

int pinocchio::ContactSolverBaseTpl< _Scalar >::it

protected

Number of iterations needed to achieve convergence.

Definition at line 118 of file algorithm/contact-solver-base.hpp.

◆ max_it

template<typename _Scalar >

int pinocchio::ContactSolverBaseTpl< _Scalar >::max_it

protected

Maximum number of iterations.

Definition at line 116 of file algorithm/contact-solver-base.hpp.

◆ problem_size

template<typename _Scalar >

int pinocchio::ContactSolverBaseTpl< _Scalar >::problem_size

protected

Size of the problem.

Definition at line 114 of file algorithm/contact-solver-base.hpp.

◆ relative_precision

template<typename _Scalar >

Scalar pinocchio::ContactSolverBaseTpl< _Scalar >::relative_precision

protected

Desired relative precision.

Definition at line 122 of file algorithm/contact-solver-base.hpp.

◆ relative_residual

template<typename _Scalar >

Scalar pinocchio::ContactSolverBaseTpl< _Scalar >::relative_residual

protected

Relative convergence residual value.

Definition at line 126 of file algorithm/contact-solver-base.hpp.

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

algorithm/contact-solver-base.hpp

Public Types

Public Member Functions

Protected Attributes

Detailed Description

template<typename _Scalar> struct pinocchio::ContactSolverBaseTpl< _Scalar >

Member Typedef Documentation

◆ Scalar

Constructor & Destructor Documentation

◆ ContactSolverBaseTpl()

Member Function Documentation

◆ getAbsoluteConvergenceResidual()

◆ getAbsolutePrecision()

◆ getIterationCount()

◆ getMaxIterations()

◆ getProblemSize()

◆ getRelativeConvergenceResidual()

◆ getRelativePrecision()

◆ setAbsolutePrecision()

◆ setMaxIterations()

◆ setRelativePrecision()

Member Data Documentation

◆ absolute_precision

◆ absolute_residual

◆ it

◆ max_it

◆ problem_size

◆ relative_precision

◆ relative_residual

template<typename _Scalar>
struct pinocchio::ContactSolverBaseTpl< _Scalar >