OFUnorderedSet< T > Class Template Reference

This template class provides a data structure and operations for administrating an unordered set of elements of an arbitrary type. More...

Inheritance diagram for OFUnorderedSet< T >:

List of all members.

Public Member Functions
	OFUnorderedSet ()
	Default constructor.
	OFUnorderedSet (const OFUnorderedSet< T > &src)
	Copy constructor.
virtual	~OFUnorderedSet ()
	Destructor.
const OFUnorderedSet< T > &	operator= (const OFUnorderedSet< T > &src)
	operator=.
virtual OFBool	operator== (const OFUnorderedSet< T > &other) const
	Determines if two sets are identical.
virtual OFBool	operator!= (const OFUnorderedSet< T > &other) const
	Determines if two sets are not identical.
virtual void	Insert (const T &item)
	Inserts a new item into the set.
virtual void	Insert (const OFUnorderedSet< T > &other)
	Inserts all items of another set into this set.
virtual void	Remove (const T &item)
	Removes one item from the set.
virtual void	RemoveByIndex (unsigned int index)
	Removes one item from the set.
virtual T *	Find (const T &item) const
	Tries to find a given object in the set.
virtual OFBool	Contains (const T &item) const
	Determines if a certain item is contained in the set.
virtual OFBool	IsSupersetOf (const OFUnorderedSet< T > &other) const
	Determines if this is an actual superset of other, i.e.
virtual OFBool	IsSubsetOf (const OFUnorderedSet< T > &other) const
	Determines if this is an actual subset of other, i.e.
OFUnorderedSet< T >	Union (const OFUnorderedSet< T > &other) const
	Determines the union of the two sets this and other, i.e.
OFUnorderedSet< T >	Intersection (const OFUnorderedSet< T > &other) const
	Determines the intersection of the two sets this and other, i.e.
OFUnorderedSet< T >	Difference (const OFUnorderedSet< T > &other) const
	Determines the difference this - other, i.e.
OFUnorderedSet< T >	SymmetricDifference (const OFUnorderedSet< T > &other) const
	Determines the symmetric difference of this and other, i.e.

---

Detailed Description

template<class T>
class OFUnorderedSet< T >

This template class provides a data structure and operations for administrating an unordered set of elements of an arbitrary type.

Note the following properties of this class:

• an element which is inserted into the set will be copied
• the datatype of the set's elements has to support operator== so that it is possible to find a certain element
• it is allowed to insert identical elements into the set
• if a user requires to remove a certain element and if there are several elements which are identical to this element, only one element will be removed from the set
• after removing an element of a set, the indeces of the set's elements might have changed; hence, looping over all elements of a set must be restarted if an element was removed from the set within the loop
• the order of the elements is arbitrary, but it will not be changed unless an element is removed from the set

---

Constructor & Destructor Documentation

template<class T >

OFUnorderedSet< T >::OFUnorderedSet

(

const OFUnorderedSet< T > &

src

)

[inline]

Copy constructor.

Parameters:

src	Source object of which this will be a copy.

---

Member Function Documentation

template<class T >

virtual OFBool OFUnorderedSet< T >::Contains

(

const T &

item

)

const [inline, virtual]

Determines if a certain item is contained in the set.

Parameters:

item	- Item which shall be looked for.

Returns:

OFTrue, if item is contained in the set, OFFalse otherwise.

Implements OFSet< T >.

template<class T >

OFUnorderedSet<T> OFUnorderedSet< T >::Difference

(

const OFUnorderedSet< T > &

other

)

const [inline]

Determines the difference this - other, i.e.

the set containing all the items found in this but not in other, and returns the resulting new set.

Parameters:

other

Second parameter for difference.

Returns:

New set.

template<class T >

virtual T* OFUnorderedSet< T >::Find

(

const T &

item

)

const [inline, virtual]

Tries to find a given object in the set.

In case the specified object could be found, a pointer to the corresponding element within the set is returned; in case the specified object could not be found, NULL will be returned.

Parameters:

item	Search pattern.

Returns:

Pointer to the corresponding element within the set or NULL.

Implements OFSet< T >.

template<class T >

virtual void OFUnorderedSet< T >::Insert

(

const T &

item

)

[inline, virtual]

Inserts a new item into the set.

Parameters:

item	Item which shall be inserted into the set.

Implements OFSet< T >.

template<class T >

virtual void OFUnorderedSet< T >::Insert

(

const OFUnorderedSet< T > &

other

)

[inline, virtual]

Inserts all items of another set into this set.

Parameters:

other

set whose items shall be inserted into the set.

template<class T >

OFUnorderedSet<T> OFUnorderedSet< T >::Intersection

(

const OFUnorderedSet< T > &

other

)

const [inline]

Determines the intersection of the two sets this and other, i.e.

the set containing all items which can be found in both this and other, and returns the resulting new set.

Parameters:

other

Second parameter for intersection.

Returns:

New set.

template<class T >

virtual OFBool OFUnorderedSet< T >::IsSubsetOf

(

const OFUnorderedSet< T > &

other

)

const [inline, virtual]

Determines if this is an actual subset of other, i.e.

if this is completely contained in other and other furthermore has additional elements.

Parameters:

other

- Set which shall be compared with this.

Returns:

OFTrue if this is a subset of other, OFFalse otherwise.

template<class T >

virtual OFBool OFUnorderedSet< T >::IsSupersetOf

(

const OFUnorderedSet< T > &

other

)

const [inline, virtual]

Determines if this is an actual superset of other, i.e.

if this completely contains other and furthermore has additional elements.

Parameters:

other

- Set which shall be compared with this.

Returns:

OFTrue if this is a superset of other, OFFalse otherwise.

template<class T >

virtual OFBool OFUnorderedSet< T >::operator!=

(

const OFUnorderedSet< T > &

other

)

const [inline, virtual]

Determines if two sets are not identical.

Parameters:

other

Set which shall be compared with this.

Returns:

OFTrue if sets are not identical, OFFalse otherwise.

template<class T >

const OFUnorderedSet<T>& OFUnorderedSet< T >::operator=

(

const OFUnorderedSet< T > &

src

)

[inline]

operator=.

Parameters:

src	Source object whose values will be assigned to this.

Returns:

Reference to this.

template<class T >

virtual OFBool OFUnorderedSet< T >::operator==

(

const OFUnorderedSet< T > &

other

)

const [inline, virtual]

Determines if two sets are identical.

Parameters:

other

Set which shall be compared with this.

Returns:

OFTrue if sets are identical, OFFalse otherwise.

template<class T >

virtual void OFUnorderedSet< T >::Remove

(

const T &

item

)

[inline, virtual]

Removes one item from the set.

Parameters:

item	Item which shall be removed from the set.

Implements OFSet< T >.

template<class T >

virtual void OFUnorderedSet< T >::RemoveByIndex

(

unsigned int

index

)

[inline, virtual]

Removes one item from the set.

Parameters:

index

Index of the item which shall be removed from the set.

Implements OFSet< T >.

template<class T >

OFUnorderedSet<T> OFUnorderedSet< T >::SymmetricDifference

(

const OFUnorderedSet< T > &

other

)

const [inline]

Determines the symmetric difference of this and other, i.e.

the set containing all the items which can be found either in this or in other but not in the intersection of this and other, and returns the resulting new set.

Parameters:

other

Second parameter for symmetric difference.

Returns:

New set.

template<class T >

OFUnorderedSet<T> OFUnorderedSet< T >::Union

(

const OFUnorderedSet< T > &

other

)

const [inline]

Determines the union of the two sets this and other, i.e.

the set containing all items which can be found either in this or in other, and returns the resulting new set.

Parameters:

other

Second parameter for union.

Returns:

New set.

---

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

• ofstd/include/dcmtk/ofstd/ofuoset.h