constrained_ik::ConstraintResults Class Reference

This class is used to store a constraints results. More...

#include <constraint_results.h>

List of all members.

Public Member Functions
virtual void	append (const ConstraintResults &cdata)
	Append the provided result this result.
virtual bool	isEmpty ()
	Check if empty.
Public Attributes
Eigen::VectorXd	error
Eigen::MatrixXd	jacobian
bool	status
Protected Member Functions
virtual void	appendError (const Eigen::VectorXd &addError)
	This append an error vector to the current.
virtual void	appendJacobian (const Eigen::MatrixXd &addJacobian)
	This appends a Jacobian to the current.

---

Detailed Description

This class is used to store a constraints results.

Definition at line 35 of file constraint_results.h.

---

Member Function Documentation

virtual void constrained_ik::ConstraintResults::append

(

const ConstraintResults &

cdata

)

[inline, virtual]

Append the provided result this result.

Parameters:

cdata

ConstraintResults to append

Definition at line 52 of file constraint_results.h.

virtual void constrained_ik::ConstraintResults::appendError

(

const Eigen::VectorXd &

addError

)

[inline, protected, virtual]

This append an error vector to the current.

This method does a resize in-place, and may be inefficient if called many times

Parameters:

addError

error vector to be appended

Definition at line 79 of file constraint_results.h.

virtual void constrained_ik::ConstraintResults::appendJacobian

(

const Eigen::MatrixXd &

addJacobian

)

[inline, protected, virtual]

This appends a Jacobian to the current.

This method does a resize in-place, and may be inefficient if called many times

Parameters:

addJacobian

Jacobian to be appended

Definition at line 104 of file constraint_results.h.

virtual bool constrained_ik::ConstraintResults::isEmpty

(

)

[inline, virtual]

Check if empty.

Returns:

True if empty, otherwise false

Definition at line 63 of file constraint_results.h.

---

Member Data Documentation

Eigen::VectorXd constrained_ik::ConstraintResults::error

Error of the constraint

Definition at line 42 of file constraint_results.h.

Eigen::MatrixXd constrained_ik::ConstraintResults::jacobian

Jacobian of the constraint

Definition at line 44 of file constraint_results.h.

bool constrained_ik::ConstraintResults::status

Current status of the constraint, True Converged, False Not Converged

Definition at line 46 of file constraint_results.h.

---

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

• constraint_results.h