Lodestar
An integrated real-time control package in C++
ls::primitives::sets::EmptySet Class Reference

The empty set. More...

#include <EmptySet.hpp>

Inheritance diagram for ls::primitives::sets::EmptySet:
[legend]
Collaboration diagram for ls::primitives::sets::EmptySet:
[legend]

Public Types

using Base = SetExpression< EmptySet >
 
using type = EmptySet
 Base class.
 
- Public Types inherited from ls::primitives::sets::SetExpression< EmptySet >
using type = EmptySet
 

Public Member Functions

 EmptySet ()=default
 Expression type.
 
template<typename TExpression >
bool operator== (const SetExpression< TExpression > &expr) const
 Checks if this expression is equal to \expr. More...
 
template<typename TExpression >
bool operator!= (const SetExpression< TExpression > &expr) const
 Checks if this expression is not equal to \expr. More...
 
template<typename TExpression >
bool contains (const SetExpression< TExpression > &expr) const
 Returns true if this expression contains expr. More...
 
template<typename TElementType >
bool contains (const TElementType &el) const
 Returns true if this expression contains expr. More...
 
template<typename TElementType >
bool isSubset (const TElementType &el) const
 Checks if this expression is a subset of expr. More...
 
template<typename TExpression >
bool isSuperset (const SetExpression< TExpression > &expr) const
 Checks if this expression is a superset of expr. More...
 
template<typename TExpression >
SetComplement< type, TExpression > relComplement (const SetExpression< TExpression > &expr)
 ‍** More...
 
bool isEmpty () const
 Returns true if the expression is the empty set. More...
 
template<typename TExpression >
SetUnion< type, TExpression > unionize (const SetExpression< TExpression > &expr)
 Creates a union between this expression and another SetExpression. More...
 
template<typename TDerived >
double sdf (Eigen::MatrixBase< TDerived > &p) const
 Returns signed distance to p. More...
 
- Public Member Functions inherited from ls::primitives::sets::SetExpression< EmptySet >
 SetExpression (const SetEnum setEnum)
 
bool operator== (const TElementType &el) const
 
bool operator!= (const TElementType &el) const
 
bool contains (const TElementType &el) const
 
bool isSubset (const TElementType &el) const
 
bool isSuperset (const TElementType &el) const
 
bool isEmpty () const
 
SetExpression< TReturnType > relComplement (const TElementType &el) const
 
SetExpression< TReturnType > unionize (const TOtherExpr &expr)
 
double sdf (Eigen::MatrixBase< Derived > &p) const
 
SetEnum getEnum () const
 

Additional Inherited Members

- Protected Attributes inherited from ls::primitives::sets::SetExpression< EmptySet >
SetEnum sEnum_
 

Detailed Description

The empty set.

Member Function Documentation

◆ contains() [1/2]

template<typename TExpression >
bool ls::primitives::sets::EmptySet::contains ( const SetExpression< TExpression > &  expr) const
inline

Returns true if this expression contains expr.

Template Parameters
TExpressionType of the other expression.
Parameters
exprExpression to check containment of.
tolNumerical tolerance.
Returns
True if this expression contains expr, false otherwise.

◆ contains() [2/2]

template<typename TElementType >
bool ls::primitives::sets::EmptySet::contains ( const TElementType &  el) const
inline

Returns true if this expression contains expr.

Template Parameters
TElementTypeType of the other element.
Parameters
elElement to check containment of.
Returns
True if this expression contains el, false otherwise.

◆ isEmpty()

bool ls::primitives::sets::EmptySet::isEmpty ( ) const
inline

Returns true if the expression is the empty set.

Returns
True if expression is the empty set.

◆ isSubset()

template<typename TElementType >
bool ls::primitives::sets::EmptySet::isSubset ( const TElementType &  el) const
inline

Checks if this expression is a subset of expr.

Note
The empty set is always considered to be a subset of any set.
Template Parameters
TElementTypeType of the other element.
Parameters
exprElement to check inclusion on.
Returns
True.

◆ isSuperset()

template<typename TExpression >
bool ls::primitives::sets::EmptySet::isSuperset ( const SetExpression< TExpression > &  expr) const
inline

Checks if this expression is a superset of expr.

Template Parameters
TExpressionType of the other expression.
Parameters
exprExpression to check subsumption on.
Returns
True if this expression is a superset of expr, false otherwise.

◆ operator!=()

template<typename TExpression >
bool ls::primitives::sets::EmptySet::operator!= ( const SetExpression< TExpression > &  expr) const
inline

Checks if this expression is not equal to \expr.

Template Parameters
TExpressionType of the other expression.
Parameters
exprExpression to check inequality with.
Returns
True if this expression is not equal to expr, false otherwise.

◆ operator==()

template<typename TExpression >
bool ls::primitives::sets::EmptySet::operator== ( const SetExpression< TExpression > &  expr) const
inline

Checks if this expression is equal to \expr.

Template Parameters
TExpressionType of the other expression.
Parameters
exprExpression to check equality with.
Returns
True if this expression is equal to expr, false otherwise.

◆ relComplement()

template<typename TExpression >
SetComplement<type, TExpression> ls::primitives::sets::EmptySet::relComplement ( const SetExpression< TExpression > &  expr)
inline

‍**

Computes the relative complement of this expression and expr.

The syntax is as follows:

// A \ B
A.relComplement(B);
Template Parameters
TExpressionType of the other expression.
Parameters
exprExpression to take relative complement with.
Returns
Relative complement.

◆ sdf()

template<typename TDerived >
double ls::primitives::sets::EmptySet::sdf ( Eigen::MatrixBase< TDerived > &  p) const
inline

Returns signed distance to p.

Note
This always returns positive infinity, as is the convention for the Hausdorff distance to the empty set.
Template Parameters
TDerivedDerived MatrixBase class.
Parameters
pA point.
Returns
Signed distance.

◆ unionize()

template<typename TExpression >
SetUnion<type, TExpression> ls::primitives::sets::EmptySet::unionize ( const SetExpression< TExpression > &  expr)
inline

Creates a union between this expression and another SetExpression.

Template Parameters
TExpressionType of the other expression.
Parameters
exprExpression to create a union with.
Returns
Union.

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