Drake
Drake C++ Documentation

Detailed Description

A convex set that represents the intersection of multiple sets: S = X₁ ∩ X₂ ∩ ...

∩ Xₙ = {x | x ∈ X₁, x ∈ X₂, ..., x ∈ Xₙ}

Special behavior for IsEmpty: The intersection of zero sets (i.e. when we have sets_.size() == 0) is always nonempty. This includes the zero-dimensional case, which we treat as being {0}, the unique zero-dimensional vector space.

#include <drake/geometry/optimization/intersection.h>

Public Member Functions

 Intersection ()
 Constructs a default (zero-dimensional, nonempty) set. More...
 
 Intersection (const ConvexSets &sets)
 Constructs the intersection from a vector of convex sets. More...
 
 Intersection (const ConvexSet &setA, const ConvexSet &setB)
 Constructs the intersection from a pair of convex sets. More...
 
 ~Intersection () final
 
int num_elements () const
 The number of elements (or sets) used in the intersection. More...
 
const ConvexSetelement (int i) const
 Returns a reference to the ConvexSet defining the index element in the intersection. More...
 
double CalcVolume () const
 
Implements CopyConstructible, CopyAssignable, MoveConstructible, MoveAssignable
 Intersection (const Intersection &)=default
 
Intersectionoperator= (const Intersection &)=default
 
 Intersection (Intersection &&)=default
 
Intersectionoperator= (Intersection &&)=default
 
- Public Member Functions inherited from ConvexSet
virtual ~ConvexSet ()
 
std::unique_ptr< ConvexSetClone () const
 Creates a unique deep copy of this set. More...
 
int ambient_dimension () const
 Returns the dimension of the vector space in which the elements of this set are evaluated. More...
 
bool IntersectsWith (const ConvexSet &other) const
 Returns true iff the intersection between this and other is non-empty. More...
 
bool IsBounded () const
 Returns true iff the set is bounded, e.g., there exists an element-wise finite lower and upper bound for the set. More...
 
bool IsEmpty () const
 Returns true iff the set is empty. More...
 
std::optional< Eigen::VectorXd > MaybeGetPoint () const
 If this set trivially contains exactly one point, returns the value of that point. More...
 
std::optional< Eigen::VectorXd > MaybeGetFeasiblePoint () const
 Returns a feasible point within this convex set if it is nonempty, and nullopt otherwise. More...
 
bool PointInSet (const Eigen::Ref< const Eigen::VectorXd > &x, double tol=0) const
 Returns true iff the point x is contained in the set. More...
 
std::pair< VectorX< symbolic::Variable >, std::vector< solvers::Binding< solvers::Constraint > > > AddPointInSetConstraints (solvers::MathematicalProgram *prog, const Eigen::Ref< const solvers::VectorXDecisionVariable > &vars) const
 Adds a constraint to an existing MathematicalProgram enforcing that the point defined by vars is inside the set. More...
 
std::vector< solvers::Binding< solvers::Constraint > > AddPointInNonnegativeScalingConstraints (solvers::MathematicalProgram *prog, const Eigen::Ref< const solvers::VectorXDecisionVariable > &x, const symbolic::Variable &t) const
 Let S be this convex set. More...
 
std::vector< solvers::Binding< solvers::Constraint > > AddPointInNonnegativeScalingConstraints (solvers::MathematicalProgram *prog, const Eigen::Ref< const Eigen::MatrixXd > &A, const Eigen::Ref< const Eigen::VectorXd > &b, const Eigen::Ref< const Eigen::VectorXd > &c, double d, const Eigen::Ref< const solvers::VectorXDecisionVariable > &x, const Eigen::Ref< const solvers::VectorXDecisionVariable > &t) const
 Let S be this convex set. More...
 
std::pair< std::unique_ptr< Shape >, math::RigidTransformd > ToShapeWithPose () const
 Constructs a Shape and a pose of the set in the world frame for use in the SceneGraph geometry ecosystem. More...
 
double CalcVolume () const
 Computes the exact volume for the convex set. More...
 
SampledVolume CalcVolumeViaSampling (RandomGenerator *generator, const double desired_rel_accuracy=1e-2, const int max_num_samples=1e4) const
 Calculates an estimate of the volume of the convex set using sampling and performing Monte Carlo integration. More...
 
bool has_exact_volume () const
 Returns true if the exact volume can be computed for this convex set instance. More...
 

Additional Inherited Members

- Protected Member Functions inherited from ConvexSet
 ConvexSet (int ambient_dimension, bool has_exact_volume)
 For use by derived classes to construct a ConvexSet. More...
 
template<typename Archive >
void Serialize (Archive *a)
 Implements non-virtual base class serialization. More...
 
virtual std::optional< Eigen::VectorXd > DoMaybeGetFeasiblePoint () const
 Non-virtual interface implementation for MaybeGetFeasiblePoint(). More...
 
virtual double DoCalcVolume () const
 Non-virtual interface implementation for CalcVolume(). More...
 
std::optional< symbolic::VariableHandleZeroAmbientDimensionConstraints (solvers::MathematicalProgram *prog, const ConvexSet &set, std::vector< solvers::Binding< solvers::Constraint >> *constraints) const
 Instances of subclasses such as CartesianProduct and MinkowskiSum can have constituent sets with zero ambient dimension, which much be handled in a special manner when calling methods such as DoAddPointInSetConstraints. More...
 
 ConvexSet (const ConvexSet &)=default
 
ConvexSetoperator= (const ConvexSet &)=default
 
 ConvexSet (ConvexSet &&)=default
 
ConvexSetoperator= (ConvexSet &&)=default
 

Constructor & Destructor Documentation

◆ Intersection() [1/5]

Intersection ( const Intersection )
default

◆ Intersection() [2/5]

Intersection ( Intersection &&  )
default

◆ Intersection() [3/5]

Constructs a default (zero-dimensional, nonempty) set.

◆ Intersection() [4/5]

Intersection ( const ConvexSets sets)
explicit

Constructs the intersection from a vector of convex sets.

◆ Intersection() [5/5]

Intersection ( const ConvexSet setA,
const ConvexSet setB 
)

Constructs the intersection from a pair of convex sets.

◆ ~Intersection()

~Intersection ( )
final

Member Function Documentation

◆ CalcVolume()

double CalcVolume
Exceptions
Notimplemented.

◆ element()

const ConvexSet& element ( int  i) const

Returns a reference to the ConvexSet defining the index element in the intersection.

◆ num_elements()

int num_elements ( ) const

The number of elements (or sets) used in the intersection.

◆ operator=() [1/2]

Intersection& operator= ( const Intersection )
default

◆ operator=() [2/2]

Intersection& operator= ( Intersection &&  )
default

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