SPL::set< K > Class Template Reference

Class that represents a set type (extends from std::unordered_set).
More...

#include <SPL/Runtime/Type/Set.h>

Inheritance diagram for SPL::set< K >:

Public Member Functions
	set ()
	set (const std::unordered_set< K > &x)
	set (const set< K > &x)
template<int32_t msize>
	set (const bset< K, msize > &x)
template<class InputIterator >
	set (InputIterator first, InputIterator last)
	set (const Set &o)
	set (const ConstValueHandle &o)
template<class K2 >
	set (const set< K2 > &o)
template<class K2 , int32_t msize>
	set (const bset< K2, msize > &o)
virtual	~set ()=default
set< K > &	add (const K &k)
const set< K > &	operator= (const set< K > &o)
const set< K > &	operator= (const std::unordered_set< K > &o)
bool	operator== (const set< K > &o) const
bool	operator!= (const set< K > &o) const
template<class BufferType >
void	serialize (ByteBuffer< BufferType > &buf) const
template<class BufferType >
void	deserialize (ByteBuffer< BufferType > &buf)
void	serialize (std::ostream &ostr) const
void	serializeWithPrecision (std::ostream &ostr) const
void	deserialize (std::istream &istr, bool withSuffix=false)
void	deserializeWithNanAndInfs (std::istream &istr, bool withSuffix=false)
size_t	hashCode () const
Reflective interfaces
virtual bool	equals (const Collection &ot) const
virtual Collection *	clone () const
virtual void	assignFrom (const Collection &ot)
virtual void	swapWith (Collection &ot)
virtual Meta::Type	getElementMetaType () const
virtual ValueHandle	createElement () const
virtual int32_t	getSize () const
virtual SetIterator	findElement (const ConstValueHandle &key)
virtual ConstSetIterator	findElement (const ConstValueHandle &key) const
virtual void	insertElement (const ConstValueHandle &key)
virtual void	removeElement (const ConstValueHandle &key)
virtual void	removeAllElements ()
virtual SetIterator	getBeginIterator ()
virtual ConstSetIterator	getBeginIterator () const
virtual SetIterator	getEndIterator ()
virtual ConstSetIterator	getEndIterator () const
virtual size_t	getSerializedSize () const
Public Member Functions inherited from SPL::Set
virtual	~Set ()=default
const Set &	operator= (const Set &ov)
Public Member Functions inherited from SPL::Collection
virtual	~Collection ()=default
	Destructor. More...

Protected Member Functions
const SetIterManager &	getIterManager () const

Detailed Description

template<class K>
class SPL::set< K >

Class that represents a set type (extends from std::unordered_set).

Constructor & Destructor Documentation

set() [1/9]

template<class K >

SPL::set< K >::set ( )

inlineexplicit

Default constructor

set() [2/9]

template<class K >

SPL::set< K >::set ( const std::unordered_set< K > &  x )

inline

Construct from a unordered_set

Parameters

x	unordered_set to use

set() [3/9]

template<class K >

SPL::set< K >::set ( const set< K > &  x )

inline

Copy constructor

Parameters

x	set to construct from

set() [4/9]

template<class K >

template<int32_t msize>

SPL::set< K >::set ( const bset< K, msize > &  x )

inline

Construct from a bounded set

Parameters

x	bounded set to construct from

set() [5/9]

template<class K >

template<class InputIterator >

SPL::set< K >::set ( InputIterator  first, InputIterator  last  )

inline

Construct from a sequence

Parameters

first	begin iterator, inclusive
last	end iterator, exclusive

set() [6/9]

template<class K >

SPL::set< K >::set ( const Set &  o )

inline

Construct from a reflective set

Parameters

o	reflective set to construct from

set() [7/9]

template<class K >

SPL::set< K >::set ( const ConstValueHandle &  o )

inline

Construct from a value handle

Parameters

o	value handle to construct from

set() [8/9]

template<class K >

template<class K2 >

SPL::set< K >::set ( const set< K2 > &  o )

inline

Construct from an assignable set

Parameters

o	set to construct from

set() [9/9]

template<class K >

template<class K2 , int32_t msize>

SPL::set< K >::set ( const bset< K2, msize > &  o )

inline

Construct from an assignable bset

Parameters

o	set to construct from

~set()

template<class K >

virtual SPL::set< K >::~set ( )

virtualdefault

Destructor

Member Function Documentation

add()

template<class K >

set<K>& SPL::set< K >::add ( const K &  k )

inline

Insert into set

Parameters

k	Key to be added

Returns

*this

operator=() [1/2]

template<class K >

const set<K>& SPL::set< K >::operator= ( const set< K > &  o )

inline

Assignment operator (from another set)

Parameters

o	set to assign from

Returns

self

operator=() [2/2]

template<class K >

const set<K>& SPL::set< K >::operator= ( const std::unordered_set< K > &  o )

inline

Assignment operator (from a unordered_set)

Parameters

o	unordered_set to assign from

Returns

self

operator==()

template<class K >

bool SPL::set< K >::operator== ( const set< K > &  o ) const

inline

Equality comparison

Parameters

o	set to compare with

Returns

true if the contained elements are the same, false otherwise

operator!=()

template<class K >

bool SPL::set< K >::operator!= ( const set< K > &  o ) const

inline

Non-equality comparison

Parameters

o	set to compare with

Returns

true if the contained elements are not the same, false otherwise

serialize() [1/2]

template<class K >

template<class BufferType >

void SPL::set< K >::serialize ( ByteBuffer< BufferType > &  buf ) const

inline

Serialize (binary)

Parameters

buf	byte buffer to use

deserialize() [1/2]

template<class K >

template<class BufferType >

void SPL::set< K >::deserialize ( ByteBuffer< BufferType > &  buf )

inline

Deserialize (binary)

Parameters

buf	byte buffer to use

serialize() [2/2]

template<class K >

void SPL::set< K >::serialize ( std::ostream &  ostr ) const

virtual

Serialize (character)

Parameters

ostr	output stream

Implements SPL::Collection.

serializeWithPrecision()

template<class K >

void SPL::set< K >::serializeWithPrecision ( std::ostream &  ostr ) const

virtual

Serialize (character), with maximum precision for floats

Parameters

ostr	output stream

Implements SPL::Collection.

deserialize() [2/2]

template<class K >

void SPL::set< K >::deserialize ( std::istream &  istr, bool  withSuffix = false  )

virtual

Deserialize (character)

Parameters

istr	input stream
withSuffix	if true then consume suffix, otherwise (false) assume no suffix is present

Implements SPL::Collection.

deserializeWithNanAndInfs()

template<class K >

void SPL::set< K >::deserializeWithNanAndInfs	(	std::istream &	istr,
		bool	withSuffix = false
	)

Deserialize with Inf and Nan (character)

Parameters

istr	input stream
withSuffix	if true then consume suffix, otherwise (false) assume no suffix is present

hashCode()

template<class K >

size_t SPL::set< K >::hashCode ( ) const

inlinevirtual

Get hash code

Returns

hash code

Implements SPL::Collection.

equals()

template<class K >

virtual bool SPL::set< K >::equals ( const Collection &  ot ) const

inlinevirtual

Compare with another collection

Parameters

ot	other collection to compare to

Returns

true if equal, false otherwise

Implements SPL::Collection.

clone()

template<class K >

virtual Collection* SPL::set< K >::clone ( ) const

inlinevirtual

Create a clone of the collection object

Returns

clone of the collection object

Implements SPL::Collection.

assignFrom()

template<class K >

virtual void SPL::set< K >::assignFrom ( const Collection &  ot )

inlinevirtual

Assign this collection using another collection

Parameters

ot	other collection to assign from

Exceptions

SPLRuntimeTypeMismatchException

if the types do not match

Implements SPL::Collection.

swapWith()

template<class K >

virtual void SPL::set< K >::swapWith ( Collection &  ot )

inlinevirtual

Swap this collection with another collection

Parameters

ot	other collection to swap with

Exceptions

SPLRuntimeTypeMismatchException

if the types do not match

Implements SPL::Collection.

getElementMetaType()

template<class K >

virtual Meta::Type SPL::set< K >::getElementMetaType ( ) const

inlinevirtual

Get element type

Returns

element type of this set

Implements SPL::Set.

createElement()

template<class K >

virtual ValueHandle SPL::set< K >::createElement ( ) const

inlinevirtual

Create a new element. The returned value handle is a wrapper for the object allocated on the heap. As a result, the caller is responsible for cleaning up the memory by calling ValueHandle::deleteValue()

Returns

value handle for the new element

Implements SPL::Set.

getSize()

template<class K >

virtual int32_t SPL::set< K >::getSize ( ) const

inlinevirtual

Get the size of the set

Returns

size of the set

Implements SPL::Set.

findElement() [1/2]

template<class K >

virtual SetIterator SPL::set< K >::findElement ( const ConstValueHandle &  key )

inlinevirtual

Find an element in the set

Parameters

key	value handle for the element

Returns

an iterator for the element if found, the end iterator otherwise

Implements SPL::Set.

findElement() [2/2]

template<class K >

virtual ConstSetIterator SPL::set< K >::findElement ( const ConstValueHandle &  key ) const

inlinevirtual

Find an element in the set

Parameters

key	value handle for the element

Returns

an iterator for the element if found, the end iterator otherwise

Implements SPL::Set.

insertElement()

template<class K >

virtual void SPL::set< K >::insertElement ( const ConstValueHandle &  key )

inlinevirtual

Insert an element

Parameters

key	value handle for the element

Implements SPL::Set.

removeElement()

template<class K >

virtual void SPL::set< K >::removeElement ( const ConstValueHandle &  key )

inlinevirtual

remove the element with the given value

Parameters

key	value handle for the element

Implements SPL::Set.

removeAllElements()

template<class K >

virtual void SPL::set< K >::removeAllElements ( )

inlinevirtual

Remove all elements

Implements SPL::Set.

getBeginIterator() [1/2]

template<class K >

virtual SetIterator SPL::set< K >::getBeginIterator ( )

inlinevirtual

Get a begin iterator

Returns

begin iterator

Implements SPL::Set.

getBeginIterator() [2/2]

template<class K >

virtual ConstSetIterator SPL::set< K >::getBeginIterator ( ) const

inlinevirtual

Get a begin const iterator

Returns

begin const iterator

Implements SPL::Set.

getEndIterator() [1/2]

template<class K >

virtual SetIterator SPL::set< K >::getEndIterator ( )

inlinevirtual

Get an end iterator

Returns

end iterator

Implements SPL::Set.

getEndIterator() [2/2]

template<class K >

virtual ConstSetIterator SPL::set< K >::getEndIterator ( ) const

inlinevirtual

Get an end cost iterator

Returns

end const iterator

Implements SPL::Set.

getSerializedSize()

template<class K >

virtual size_t SPL::set< K >::getSerializedSize ( ) const

inlinevirtual

Get the size in bytes when serialized

Returns

size in bytes when serialized

Implements SPL::Collection.

getIterManager()

template<class K >

const SetIterManager& SPL::set< K >::getIterManager ( ) const

inlineprotectedvirtual

Implements SPL::Set.

---

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

• SPL/Runtime/Type/BSet.h
• SPL/Runtime/Type/Set.h