Constraint on the upper limits of the joint position. More...

#include <joint_position_upper_limit.hpp>

Inheritance diagram for robotoc::JointPositionUpperLimit:

Collaboration diagram for robotoc::JointPositionUpperLimit:

Public Member Functions
	JointPositionUpperLimit (const Robot &robot)
	Constructor. More...

	JointPositionUpperLimit ()
	Default constructor. More...

	~JointPositionUpperLimit ()
	Destructor. More...

	JointPositionUpperLimit (const JointPositionUpperLimit &)=default
	Default copy constructor. More...

JointPositionUpperLimit &	operator= (const JointPositionUpperLimit &)=default
	Default copy operator. More...

	JointPositionUpperLimit (JointPositionUpperLimit &&) noexcept=default
	Default move constructor. More...

JointPositionUpperLimit &	operator= (JointPositionUpperLimit &&) noexcept=default
	Default move assign operator. More...

KinematicsLevel	kinematicsLevel () const override
	Checks the kinematics level of the constraint component. More...

void	allocateExtraData (ConstraintComponentData &data) const override
	Allocates extra data in ConstraintComponentData. More...

bool	isFeasible (Robot &robot, const ContactStatus &contact_status, ConstraintComponentData &data, const SplitSolution &s) const override
	Checks whether the current solution s is feasible or not. More...

void	setSlack (Robot &robot, const ContactStatus &contact_status, ConstraintComponentData &data, const SplitSolution &s) const override
	Sets the slack variables of each constraint components. More...

void	evalConstraint (Robot &robot, const ContactStatus &contact_status, ConstraintComponentData &data, const SplitSolution &s) const override
	Computes the primal residual, residual in the complementary slackness, and the log-barrier function of the slack varible. More...

void	evalDerivatives (Robot &robot, const ContactStatus &contact_status, ConstraintComponentData &data, const SplitSolution &s, SplitKKTResidual &kkt_residual) const override
	Computes the derivatives of the priaml residual, i.e., the Jacobian of the inequality constraint, and add the product of the Jacobian and the dual variable to the KKT residual. This function is always called just after evalConstraint(). More...

void	condenseSlackAndDual (const ContactStatus &contact_status, ConstraintComponentData &data, SplitKKTMatrix &kkt_matrix, SplitKKTResidual &kkt_residual) const override
	Condenses the slack and dual variables, i.e., factorizes the condensed Hessians and KKT residuals. This function is always called just after evalDerivatives(). More...

void	expandSlackAndDual (const ContactStatus &contact_status, ConstraintComponentData &data, const SplitDirection &d) const override
	Expands the slack and dual, i.e., computes the directions of the slack and dual variables from the directions of the primal variables. More...

int	dimc () const override
	Returns the size of the constraint. More...

Public Member Functions inherited from robotoc::ConstraintComponentBase
	ConstraintComponentBase (const double barrier_param=1.0e-03, const double fraction_to_boundary_rule=0.995)
	Constructor. More...

virtual	~ConstraintComponentBase ()
	Destructor. More...

	ConstraintComponentBase (const ConstraintComponentBase &)=default
	Default copy constructor. More...

ConstraintComponentBase &	operator= (const ConstraintComponentBase &)=default
	Default copy operator. More...

	ConstraintComponentBase (ConstraintComponentBase &&) noexcept=default
	Default move constructor. More...

ConstraintComponentBase &	operator= (ConstraintComponentBase &&) noexcept=default
	Default move assign operator. More...

virtual KinematicsLevel	kinematicsLevel () const =0
	Checks the kinematics level of the constraint component. More...

virtual void	allocateExtraData (ConstraintComponentData &data) const =0
	Allocates extra data in ConstraintComponentData. More...

virtual bool	isFeasible (Robot &robot, const ContactStatus &contact_status, ConstraintComponentData &data, const SplitSolution &s) const =0
	Checks whether the current solution s is feasible or not. More...

virtual void	setSlack (Robot &robot, const ContactStatus &contact_status, ConstraintComponentData &data, const SplitSolution &s) const =0
	Sets the slack variables of each constraint components. More...

virtual void	evalConstraint (Robot &robot, const ContactStatus &contact_status, ConstraintComponentData &data, const SplitSolution &s) const =0
	Computes the primal residual, residual in the complementary slackness, and the log-barrier function of the slack varible. More...

virtual void	evalDerivatives (Robot &robot, const ContactStatus &contact_status, ConstraintComponentData &data, const SplitSolution &s, SplitKKTResidual &kkt_residual) const =0
	Computes the derivatives of the priaml residual, i.e., the Jacobian of the inequality constraint, and add the product of the Jacobian and the dual variable to the KKT residual. This function is always called just after evalConstraint(). More...

virtual void	condenseSlackAndDual (const ContactStatus &contact_status, ConstraintComponentData &data, SplitKKTMatrix &kkt_matrix, SplitKKTResidual &kkt_residual) const =0
	Condenses the slack and dual variables, i.e., factorizes the condensed Hessians and KKT residuals. This function is always called just after evalDerivatives(). More...

virtual void	expandSlackAndDual (const ContactStatus &contact_status, ConstraintComponentData &data, const SplitDirection &d) const =0
	Expands the slack and dual, i.e., computes the directions of the slack and dual variables from the directions of the primal variables. More...

virtual int	dimc () const =0
	Returns the size of the constraint. More...

void	setSlackAndDualPositive (ConstraintComponentData &data) const
	Sets the slack and dual variables positive. More...

double	maxSlackStepSize (const ConstraintComponentData &data) const
	Computes and returns the maximum step size by applying fraction-to-boundary-rule to the direction of the slack variable. More...

double	maxDualStepSize (const ConstraintComponentData &data) const
	Computes and returns the maximum step size by applying fraction-to-boundary-rule to the direction of the dual variable. More...

virtual double	getBarrierParam () const final
	Gets the barrier parameter. More...

virtual double	getFractionToBoundaryRule () const final
	Gets the margin parameter of the fraction-to-boundary-rule. More...

virtual void	setBarrierParam (const double barrier_param) final
	Sets the barrier parameter. More...

virtual void	setFractionToBoundaryRule (const double fraction_to_boundary_rule) final
	Sets the margin parameter of the fraction-to-boundary-rule. More...

template<typename Derived >
std::shared_ptr< Derived >	as_shared_ptr ()
	Gets the shared ptr of this object as the specified type. If this fails in dynamic casting, throws an exception. More...

Additional Inherited Members
Static Public Member Functions inherited from robotoc::ConstraintComponentBase
static void	updateSlack (ConstraintComponentData &data, const double step_size)
	Updates the slack variable according to the step size. More...

static void	updateDual (ConstraintComponentData &data, const double step_size)
	Updates the dual variable according to the step size. More...

Protected Member Functions inherited from robotoc::ConstraintComponentBase
void	computeComplementarySlackness (ConstraintComponentData &data) const
	Computes the residual in the complementarity slackness between the slack and dual variables. More...

void	computeComplementarySlackness (ConstraintComponentData &data, const int start, const int size) const
	Computes the residual in the complementarity slackness between the slack and dual variables. More...

template<int Size>
void	computeComplementarySlackness (ConstraintComponentData &data, const int start) const
	Computes the residual in the complementarity slackness between the slack and dual variables. More...

double	computeComplementarySlackness (const double slack, const double dual) const
	Computes the residual in the complementarity slackness between the slack and dual variables. More...

template<typename VectorType >
double	logBarrier (const Eigen::MatrixBase< VectorType > &slack) const
	Computes the log barrier function of the slack variable. More...

Static Protected Member Functions inherited from robotoc::ConstraintComponentBase
static void	computeCondensingCoeffcient (ConstraintComponentData &data)
	Computes the coefficient of the condensing. More...

static void	computeCondensingCoeffcient (ConstraintComponentData &data, const int start, const int size)
	Computes the coefficient of the condensing. More...

template<int Size>
static void	computeCondensingCoeffcient (ConstraintComponentData &data, const int start)
	Computes the coefficient of the condensing. More...

static double	computeCondensingCoeffcient (const double slack, const double dual, const double residual, const double cmpl)
	Computes the residual in the complementarity slackness between the slack and dual variables. More...

static void	computeDualDirection (ConstraintComponentData &data)
	Computes the direction of the dual variable from slack, primal residual, complementary slackness, and the direction of the slack. More...

static void	computeDualDirection (ConstraintComponentData &data, const int start, const int size)
	Computes the direction of the dual variable from slack, primal residual, complementary slackness, and the direction of the slack. More...

template<int Size>
static void	computeDualDirection (ConstraintComponentData &data, const int start)
	Computes the direction of the dual variable from slack, primal residual, complementary slackness, and the direction of the slack. More...

static double	computeDualDirection (const double slack, const double dual, const double dslack, const double cmpl)
	Computes the direction of the dual variable from slack, primal residual, complementary slackness, and the direction of the slack. More...

Detailed Description

Constraint on the upper limits of the joint position.

Constructor & Destructor Documentation

◆ JointPositionUpperLimit() [1/4]

robotoc::JointPositionUpperLimit::JointPositionUpperLimit ( const Robot & robot )

Constructor.

Parameters

[in] robot Robot model.

◆ JointPositionUpperLimit() [2/4]

robotoc::JointPositionUpperLimit::JointPositionUpperLimit ( )

Default constructor.

◆ ~JointPositionUpperLimit()

robotoc::JointPositionUpperLimit::~JointPositionUpperLimit ( )

Destructor.

◆ JointPositionUpperLimit() [3/4]

robotoc::JointPositionUpperLimit::JointPositionUpperLimit ( const JointPositionUpperLimit & )

default

Default copy constructor.

◆ JointPositionUpperLimit() [4/4]

robotoc::JointPositionUpperLimit::JointPositionUpperLimit ( JointPositionUpperLimit && )

defaultnoexcept

Default move constructor.

Member Function Documentation

◆ allocateExtraData()

void robotoc::JointPositionUpperLimit::allocateExtraData ( ConstraintComponentData & data ) const

inlineoverridevirtual

Allocates extra data in ConstraintComponentData.

Parameters

[in] data Constraint component data.

Implements robotoc::ConstraintComponentBase.

◆ condenseSlackAndDual()

void robotoc::JointPositionUpperLimit::condenseSlackAndDual	(	const ContactStatus &	contact_status,
		ConstraintComponentData &	data,
		SplitKKTMatrix &	kkt_matrix,
		SplitKKTResidual &	kkt_residual
	)		const

overridevirtual

Condenses the slack and dual variables, i.e., factorizes the
condensed Hessians and KKT residuals. This function is always called just after evalDerivatives().

Parameters

[in]	contact_status	Contact status.
[in]	data	Constraint data.
[out]	kkt_matrix	Split KKT matrix. The condensed Hessians are added to this object.
[out]	kkt_residual	Split KKT residual. The condensed residuals are added to this object.

Implements robotoc::ConstraintComponentBase.

◆ dimc()

int robotoc::JointPositionUpperLimit::dimc ( ) const

overridevirtual

Returns the size of the constraint.

Returns: Size of the constraint.

Implements robotoc::ConstraintComponentBase.

◆ evalConstraint()

void robotoc::JointPositionUpperLimit::evalConstraint	(	Robot &	robot,
		const ContactStatus &	contact_status,
		ConstraintComponentData &	data,
		const SplitSolution &	s
	)		const

overridevirtual

Computes the primal residual, residual in the complementary slackness, and the log-barrier function of the slack varible.

Parameters

[in]	robot	Robot model.
[in]	contact_status	Contact status.
[in]	data	Constraint data.
[in]	s	Split solution.

Implements robotoc::ConstraintComponentBase.

◆ evalDerivatives()

void robotoc::JointPositionUpperLimit::evalDerivatives	(	Robot &	robot,
		const ContactStatus &	contact_status,
		ConstraintComponentData &	data,
		const SplitSolution &	s,
		SplitKKTResidual &	kkt_residual
	)		const

overridevirtual

Computes the derivatives of the priaml residual, i.e., the Jacobian of the inequality constraint, and add the product of the Jacobian and the dual variable to the KKT residual. This function is always called just after evalConstraint().

Parameters

[in]	robot	Robot model.
[in]	contact_status	Contact status.
[in]	data	Constraint data.
[in]	s	Split solution.
[out]	kkt_residual	Split KKT residual.

Implements robotoc::ConstraintComponentBase.

◆ expandSlackAndDual()

void robotoc::JointPositionUpperLimit::expandSlackAndDual	(	const ContactStatus &	contact_status,
		ConstraintComponentData &	data,
		const SplitDirection &	d
	)		const

overridevirtual

Expands the slack and dual, i.e., computes the directions of the slack and dual variables from the directions of the primal variables.

Parameters

[in]	contact_status	Contact status.
[in,out]	data	Constraint data.
[in]	d	Split direction.

Implements robotoc::ConstraintComponentBase.

◆ isFeasible()

bool robotoc::JointPositionUpperLimit::isFeasible	(	Robot &	robot,
		const ContactStatus &	contact_status,
		ConstraintComponentData &	data,
		const SplitSolution &	s
	)		const

overridevirtual

Checks whether the current solution s is feasible or not.

Parameters

[in]	robot	Robot model.
[in]	contact_status	Contact status.
[in]	data	Constraint data.
[in]	s	Split solution.

Returns: true if s is feasible. false if not.

Implements robotoc::ConstraintComponentBase.

◆ kinematicsLevel()

KinematicsLevel robotoc::JointPositionUpperLimit::kinematicsLevel ( ) const

overridevirtual

Checks the kinematics level of the constraint component.

Returns: Kinematics level of the constraint component.

Implements robotoc::ConstraintComponentBase.

◆ operator=() [1/2]

JointPositionUpperLimit & robotoc::JointPositionUpperLimit::operator= ( const JointPositionUpperLimit & )

default

Default copy operator.

◆ operator=() [2/2]

JointPositionUpperLimit & robotoc::JointPositionUpperLimit::operator= ( JointPositionUpperLimit && )

defaultnoexcept

Default move assign operator.

◆ setSlack()

void robotoc::JointPositionUpperLimit::setSlack	(	Robot &	robot,
		const ContactStatus &	contact_status,
		ConstraintComponentData &	data,
		const SplitSolution &	s
	)		const

overridevirtual

Sets the slack variables of each constraint components.

Parameters

[in]	robot	Robot model.
[in]	contact_status	Contact status.
[out]	data	Constraint data.
[in]	s	Split solution.

Implements robotoc::ConstraintComponentBase.

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

/github/workspace/include/robotoc/constraints/joint_position_upper_limit.hpp

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ JointPositionUpperLimit() [1/4]

◆ JointPositionUpperLimit() [2/4]

◆ ~JointPositionUpperLimit()

◆ JointPositionUpperLimit() [3/4]

◆ JointPositionUpperLimit() [4/4]

Member Function Documentation

◆ allocateExtraData()

◆ condenseSlackAndDual()

◆ dimc()

◆ evalConstraint()

◆ evalDerivatives()

◆ expandSlackAndDual()

◆ isFeasible()

◆ kinematicsLevel()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ setSlack()