cvx::Constraint Class Reference

Public Types
enum	Type { Equality, Positive, Box, SecondOrderCone }

Public Member Functions
Type	getType () const

Public Attributes
friend	OptimizationProblem

Friends
std::ostream &	operator<< (std::ostream &os, const Constraint &constraint)
Constraint	equalTo (const Scalar &lhs, const Scalar &rhs)
	Create an equality constraint: lhs == rhs. More...
Constraint	lessThan (const Scalar &lhs, const Scalar &rhs)
	Create a less than or equal constraint: lhs <= rhs. More...
Constraint	greaterThan (const Scalar &lhs, const Scalar &rhs)
	Create a greater than or equal constraint: lhs >= rhs. More...
Constraint	box (const Scalar &lower, const Scalar &middle, const Scalar &upper)
	Create a box constraint: lower <= middle <= upper. More...

Friends And Related Function Documentation

box

Constraint box ( const Scalar &  lower, const Scalar &  middle, const Scalar &  upper  )

friend

Create a box constraint: lower <= middle <= upper.

Parameters

lower	The lower bound
middle	The middle term
upper	The upper bound

Returns

Constraint The constraint to pass to addConstraint()

equalTo

Constraint equalTo ( const Scalar &  lhs, const Scalar &  rhs  )

friend

Create an equality constraint: lhs == rhs.

Parameters

lhs	The left hand side
rhs	The right hand side

Returns

Constraint The constraint to pass to addConstraint()

greaterThan

Constraint greaterThan ( const Scalar &  lhs, const Scalar &  rhs  )

friend

Create a greater than or equal constraint: lhs >= rhs.

Parameters

lhs	The left hand side
rhs	The right hand side

Returns

Constraint The constraint to pass to addConstraint()

lessThan

Constraint lessThan ( const Scalar &  lhs, const Scalar &  rhs  )

friend

Create a less than or equal constraint: lhs <= rhs.

Parameters

lhs	The left hand side
rhs	The right hand side

Returns

Constraint The constraint to pass to addConstraint()

---

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

• include/constraint.hpp