FunctionalForm::Variables Class Reference

Represent a set of Variable instances. More...

#include <drake/core/functional_form.h>

Public Types
typedef unspecified_bidirectional_const_iterator< Variable >	const_iterator
	Type used to iterate through the set. More...

Public Member Functions
	Variables ()=default
	Construct an empty set. More...
	Variables (std::initializer_list< Variable > init)
	Construct a set from an initializer list. More...
	Variables (Variables &&)=default
	Move-construct a set from an rvalue. More...
	Variables (Variables const &)=default
	Copy-construct a set from an lvalue. More...
Variables &	operator= (Variables &&)=default
	Move-assign a set from an rvalue. More...
Variables &	operator= (Variables const &)=default
	Copy-assign a set from an lvalue. More...
const_iterator	begin () const
	Return an iterator at the beginning of the set. More...
const_iterator	end () const
	Return an iterator at the end of the set. More...
bool	empty () const
	Return true if the set is empty and false otherwise. More...
std::size_t	size () const
	Return the size of the set. More...

Static Public Member Functions
static Variables	Union (Variables const &l, Variables const &r)
	Return the union of two sets. More...

Friends
DRAKECORE_EXPORT bool	operator== (Variables const &lhs, Variables const &rhs)
	Return true if lhs and rhs represent the same set. More...
DRAKECORE_EXPORT bool	operator!= (Variables const &lhs, Variables const &rhs)
	Return false if lhs and rhs represent the same set. More...

Detailed Description

Represent a set of Variable instances.

The set contains a list of Variable instances ordered according to the Variable Ordering without duplicates. The contained set is immutable.

Member Typedef Documentation

typedef unspecified_bidirectional_const_iterator<Variable> const_iterator

Type used to iterate through the set.

The iterator dereferences to const Variable and supports bidirectional iteration but is otherwise of an unspecified type.

Constructor & Destructor Documentation

Variables ( )

default

Construct an empty set.

Here is the caller graph for this function:

Variables

(

std::initializer_list< Variable >

init

)

Construct a set from an initializer list.

Here is the call graph for this function:

Variables ( Variables &&  )

default

Move-construct a set from an rvalue.

Variables ( Variables const &  )

default

Copy-construct a set from an lvalue.

Member Function Documentation

FunctionalForm::Variables::const_iterator begin

(

)

const

Return an iterator at the beginning of the set.

bool empty

(

)

const

Return true if the set is empty and false otherwise.

Here is the caller graph for this function:

FunctionalForm::Variables::const_iterator end

(

)

const

Return an iterator at the end of the set.

Variables& operator= ( Variables &&  )

default

Move-assign a set from an rvalue.

Variables& operator= ( Variables const &  )

default

Copy-assign a set from an lvalue.

std::size_t size

(

)

const

Return the size of the set.

FunctionalForm::Variables Union ( Variables const &  l, Variables const &  r  )

static

Return the union of two sets.

Here is the call graph for this function:

Here is the caller graph for this function:

Friends And Related Function Documentation

DRAKECORE_EXPORT bool operator!= ( FunctionalForm::Variables const &  lhs, FunctionalForm::Variables const &  rhs  )

friend

Return false if lhs and rhs represent the same set.

DRAKECORE_EXPORT bool operator== ( FunctionalForm::Variables const &  lhs, FunctionalForm::Variables const &  rhs  )

friend

Return true if lhs and rhs represent the same set.

---

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

• drake/core/functional_form.h
• drake/core/functional_form.cc