Drake
RotatedLorentzConeConstraint Class Reference

Constraining that the linear expression \( z=Ax+b \) lies within rotated Lorentz cone. More...

#include <solvers/constraint.h>

Inheritance diagram for RotatedLorentzConeConstraint:
[legend]
Collaboration diagram for RotatedLorentzConeConstraint:
[legend]

Public Member Functions

 RotatedLorentzConeConstraint (const Eigen::Ref< const Eigen::MatrixXd > &A, const Eigen::Ref< const Eigen::VectorXd > &b)
 
const Eigen::MatrixXd & A () const
 Getter for A. More...
 
const Eigen::VectorXd & b () const
 Getter for b. More...
 
 ~RotatedLorentzConeConstraint () override
 
Does not allow copy, move, or assignment
 RotatedLorentzConeConstraint (const RotatedLorentzConeConstraint &)=delete
 
RotatedLorentzConeConstraintoperator= (const RotatedLorentzConeConstraint &)=delete
 
 RotatedLorentzConeConstraint (RotatedLorentzConeConstraint &&)=delete
 
RotatedLorentzConeConstraintoperator= (RotatedLorentzConeConstraint &&)=delete
 
- Public Member Functions inherited from Constraint
template<typename DerivedLB , typename DerivedUB >
 Constraint (int num_constraints, int num_vars, const Eigen::MatrixBase< DerivedLB > &lb, const Eigen::MatrixBase< DerivedUB > &ub, const std::string &description="")
 Constructs a constraint which has num_constraints rows, with an input num_vars x 1 vector. More...
 
 Constraint (int num_constraints, int num_vars)
 Constructs a constraint which has num_constraints rows, with an input num_vars x 1 vector, with no bounds. More...
 
bool CheckSatisfied (const Eigen::Ref< const Eigen::VectorXd > &x, double tol=1E-6) const
 Return whether this constraint is satisfied by the given value, x. More...
 
bool CheckSatisfied (const Eigen::Ref< const AutoDiffVecXd > &x, double tol=1E-6) const
 
const Eigen::VectorXd & lower_bound () const
 
const Eigen::VectorXd & upper_bound () const
 
size_t num_constraints () const
 Number of rows in the output constraint. More...
 
template<typename Derived >
void UpdateLowerBound (const Eigen::MatrixBase< Derived > &new_lb)
 Updates the lower bound. More...
 
template<typename Derived >
void UpdateUpperBound (const Eigen::MatrixBase< Derived > &new_ub)
 Updates the upper bound. More...
 
template<typename DerivedL , typename DerivedU >
void set_bounds (const Eigen::MatrixBase< DerivedL > &lower_bound, const Eigen::MatrixBase< DerivedU > &upper_bound)
 Set the upper and lower bounds of the constraint. More...
 
 Constraint (const Constraint &)=delete
 
Constraintoperator= (const Constraint &)=delete
 
 Constraint (Constraint &&)=delete
 
Constraintoperator= (Constraint &&)=delete
 
- Public Member Functions inherited from EvaluatorBase
virtual ~EvaluatorBase ()
 
void Eval (const Eigen::Ref< const Eigen::VectorXd > &x, Eigen::VectorXd &y) const
 Evaluates the expression with a scalar type of double. More...
 
void Eval (const Eigen::Ref< const AutoDiffVecXd > &x, AutoDiffVecXd &y) const
 Evaluates the expression with a scalar type of AutoDiffXd. More...
 
void set_description (const std::string &description)
 Set a human-friendly description for the evaluator. More...
 
const std::string & get_description () const
 Getter for a human-friendly description for the evaluator. More...
 
int num_vars () const
 Getter for the number of variables, namely the number of rows in x, as used in Eval(x, y). More...
 
int num_outputs () const
 Getter for the number of outputs, namely the number of rows in y, as used in Eval(x, y). More...
 
 EvaluatorBase (const EvaluatorBase &)=delete
 
EvaluatorBaseoperator= (const EvaluatorBase &)=delete
 
 EvaluatorBase (EvaluatorBase &&)=delete
 
EvaluatorBaseoperator= (EvaluatorBase &&)=delete
 

Additional Inherited Members

- Protected Member Functions inherited from Constraint
virtual bool DoCheckSatisfied (const Eigen::Ref< const Eigen::VectorXd > &x, const double tol) const
 
virtual bool DoCheckSatisfied (const Eigen::Ref< const AutoDiffVecXd > &x, const double tol) const
 
- Protected Member Functions inherited from EvaluatorBase
 EvaluatorBase (int num_outputs, int num_vars, const std::string &description="")
 Constructs a evaluator. More...
 

Detailed Description

Constraining that the linear expression \( z=Ax+b \) lies within rotated Lorentz cone.

A vector \( z \in\mathbb{R}^n \) lies within rotated Lorentz cone, if

\[ z_0 \ge 0\\ z_1 \ge 0\\ z_0 z_1 \ge z_2^2 + z_3^2 + ... + z_{n-1}^2 \]

where \( A\in\mathbb{R}^{n\times m}, b\in\mathbb{R}^n\) are given matrices.

For more information and visualization, please refer to https://inst.eecs.berkeley.edu/~ee127a/book/login/l_socp_soc.html

Constructor & Destructor Documentation

RotatedLorentzConeConstraint ( const Eigen::Ref< const Eigen::MatrixXd > &  A,
const Eigen::Ref< const Eigen::VectorXd > &  b 
)
inline
~RotatedLorentzConeConstraint ( )
inlineoverride

Here is the call graph for this function:

Member Function Documentation

const Eigen::MatrixXd& A ( ) const
inline

Getter for A.

const Eigen::VectorXd& b ( ) const
inline

Getter for b.


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