jrl::qp::internal::SelectedConstraint Class Reference

#include <jrl-qp/internal/SelectedConstraint.h>

Public Member Functions

 SelectedConstraint ()
 
 SelectedConstraint (int p, ActivationStatus status)
 
int index () const
 
ActivationStatus status () const
 

Friends

std::ostream & operator<< (std::ostream &os, const SelectedConstraint &sc)
 

Detailed Description

Helper class to represent the selection of a violated constraint

This is simply an (index, status) pair.

Constructor & Destructor Documentation

◆ SelectedConstraint() [1/2]

jrl::qp::internal::SelectedConstraint::SelectedConstraint ( )
inline

Default constructor.

◆ SelectedConstraint() [2/2]

jrl::qp::internal::SelectedConstraint::SelectedConstraint ( int  p,
ActivationStatus  status 
)
inline

Usual constructor

Parameters
pIndex of the selected constraint
statusActivation status of the selected constraint

Member Function Documentation

◆ index()

int jrl::qp::internal::SelectedConstraint::index ( ) const
inline

Underlying index of the constraint.

◆ status()

ActivationStatus jrl::qp::internal::SelectedConstraint::status ( ) const
inline

Activation status of the corresponding constraint.

Friends And Related Function Documentation

◆ operator<<

std::ostream& operator<< ( std::ostream &  os,
const SelectedConstraint sc 
)
friend

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