SPL::bset< K, msize > Class Template Reference

Class that represents bounded size set type. More...

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

Inheritance diagram for SPL::bset< K, msize >:

Public Types
using	value_type = K
	value type More...
using	size_type = typename TMP::SizeType< msize >::value
	size type More...
using	hasher = std::hash< K >
	hasher type More...
using	reference = K &
	element reference type More...
using	const_reference = const K &
	element constant reference type More...
using	pointer = K *
	element pointer type More...
using	const_pointer = const K *
	element constant pointer type More...
using	iterator = bset_iterator< K, msize >
	iterator type More...
using	const_iterator = const_bset_iterator< K, msize >
	constant iterator type More...

Public Member Functions
	bset ()
template<class InputIterator >
	bset (InputIterator first, InputIterator last)
template<class K2 >
	bset (const std::unordered_set< K2 > &o)
template<class K2 , int32_t msize2>
	bset (const bset< K2, msize2 > &o)
	bset (const bset< K, msize > &ot)
template<int32_t osize>
	bset (const bset< K, osize > &ot)
	bset (const std::unordered_set< K > &ot)
	bset (const BSet &o)
	bset (const ConstValueHandle &o)
	~bset ()
	Destructor. More...
const bset &	operator= (const bset< K, msize > &ot)
template<int32_t osize>
const bset &	operator= (const bset< K, osize > &ot)
const bset &	operator= (const std::unordered_set< K > &ot)
bool	operator== (const bset< K, msize > &ot) const
template<int32_t osize>
bool	operator== (const bset< K, osize > &ot) const
bool	operator!= (const bset< K, msize > &ot) const
template<int32_t osize>
bool	operator!= (const bset< K, osize > &ot) const
iterator	begin ()
const_iterator	begin () const
iterator	end ()
const_iterator	end () const
int32_t	max_size () const
size_type	size () const
hasher	hash_funct () const
void	clear ()
bool	empty () const
iterator	find (const value_type &k)
const_iterator	find (const value_type &k) const
size_type	count (const value_type &k) const
value_type &	operator[] (const value_type &k)
bset< K, msize > &	add (const K &k)
std::pair< iterator, bool >	insert (const value_type &x)
template<class InputIterator >
void	insert (InputIterator first, InputIterator last)
void	erase (iterator pos)
size_type	erase (const value_type &k)
void	erase (iterator first, iterator last)
value_type const *	getData () const
template<int32_t osize>
void	swap (bset< K, osize > &ot)
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
void	normalize ()
Reflective interfaces
virtual uint32_t	getBoundedSize () const
virtual uint32_t	getUsedSize () const
virtual bool	equals (const Collection &ot) const
virtual void	assignFrom (const Collection &ot)
virtual void	swapWith (Collection &ot)
virtual Collection *	clone () const
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::BSet
const BSet &	operator= (const BSet &ov)
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, int32_t msize>
class SPL::bset< K, msize >

Class that represents bounded size set type.

Member Typedef Documentation

value_type

template<class K , int32_t msize>

using SPL::bset< K, msize >::value_type = K

value type

size_type

template<class K , int32_t msize>

using SPL::bset< K, msize >::size_type = typename TMP::SizeType<msize>::value

size type

hasher

template<class K , int32_t msize>

using SPL::bset< K, msize >::hasher = std::hash<K>

hasher type

reference

template<class K , int32_t msize>

using SPL::bset< K, msize >::reference = K &

element reference type

const_reference

template<class K , int32_t msize>

using SPL::bset< K, msize >::const_reference = const K &

element constant reference type

pointer

template<class K , int32_t msize>

using SPL::bset< K, msize >::pointer = K *

element pointer type

const_pointer

template<class K , int32_t msize>

using SPL::bset< K, msize >::const_pointer = const K *

element constant pointer type

iterator

template<class K , int32_t msize>

using SPL::bset< K, msize >::iterator = bset_iterator<K, msize>

iterator type

const_iterator

template<class K , int32_t msize>

using SPL::bset< K, msize >::const_iterator = const_bset_iterator<K, msize>

constant iterator type

Constructor & Destructor Documentation

bset() [1/9]

template<class K , int32_t msize>

SPL::bset< K, msize >::bset ( )

inlineexplicit

Empty constructor

bset() [2/9]

template<class K , int32_t msize>

template<class InputIterator >

SPL::bset< K, msize >::bset ( InputIterator  first, InputIterator  last  )

inline

Construct from a sequence

Parameters

first	begin iterator, inclusive
last	end iterator, exclusive

bset() [3/9]

template<class K , int32_t msize>

template<class K2 >

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

inline

Construct from an assignable set

Parameters

o	set to construct from

bset() [4/9]

template<class K , int32_t msize>

template<class K2 , int32_t msize2>

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

inline

Construct from an assignable bset

Parameters

o	set to construct from

bset() [5/9]

template<class K , int32_t msize>

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

inline

Copy constructor

Parameters

ot	bounded size set to construct from

bset() [6/9]

template<class K , int32_t msize>

template<int32_t osize>

SPL::bset< K, msize >::bset ( const bset< K, osize > &  ot )

inline

Copy constructor

Parameters

ot	bounded size set to construct from

bset() [7/9]

template<class K , int32_t msize>

SPL::bset< K, msize >::bset ( const std::unordered_set< K > &  ot )

inline

Construct from an std::unordered_set

Parameters

ot	unordered set to construct from

bset() [8/9]

template<class K , int32_t msize>

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

inline

Construct from a reflective bounded size set

Parameters

o	reflective bounded size set to construct from

bset() [9/9]

template<class K , int32_t msize>

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

inline

Construct from a value handle

Parameters

o	value handle to construct from

~bset()

template<class K , int32_t msize>

SPL::bset< K, msize >::~bset ( )

inline

Destructor.

Member Function Documentation

operator=() [1/3]

template<class K , int32_t msize>

const bset& SPL::bset< K, msize >::operator= ( const bset< K, msize > &  ot )

inline

Assignment operator (from another bounded size set)

Parameters

ot	bounded size set to assign from

Returns

self

operator=() [2/3]

template<class K , int32_t msize>

template<int32_t osize>

const bset& SPL::bset< K, msize >::operator= ( const bset< K, osize > &  ot )

inline

Assignment operator (from another bounded size set)

Parameters

ot	bounded size set to assign from

Returns

self

operator=() [3/3]

template<class K , int32_t msize>

const bset& SPL::bset< K, msize >::operator= ( const std::unordered_set< K > &  ot )

inline

Assignment operator (from an std unordered_set)

Parameters

ot	std unordered_set to assign from

Returns

self

operator==() [1/2]

template<class K , int32_t msize>

bool SPL::bset< K, msize >::operator== ( const bset< K, msize > &  ot ) const

inline

Equality comparison

Parameters

ot	bounded size set to compare with

Returns

true if the contained elements are the same, false otherwise

operator==() [2/2]

template<class K , int32_t msize>

template<int32_t osize>

bool SPL::bset< K, msize >::operator== ( const bset< K, osize > &  ot ) const

inline

Equality comparison

Parameters

ot	bounded size set to compare with

Returns

true if the contained elements are the same, false otherwise

operator!=() [1/2]

template<class K , int32_t msize>

bool SPL::bset< K, msize >::operator!= ( const bset< K, msize > &  ot ) const

inline

Non-equality comparison

Parameters

ot	bounded size set to compare with

Returns

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

operator!=() [2/2]

template<class K , int32_t msize>

template<int32_t osize>

bool SPL::bset< K, msize >::operator!= ( const bset< K, osize > &  ot ) const

inline

Non-equality comparison

Parameters

ot	bounded size set to compare with

Returns

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

begin() [1/2]

template<class K , int32_t msize>

iterator SPL::bset< K, msize >::begin ( )

inline

Get a begin iterator

Returns

begin iterator

begin() [2/2]

template<class K , int32_t msize>

const_iterator SPL::bset< K, msize >::begin ( ) const

inline

Get a begin const iterator

Returns

begin const iterator

end() [1/2]

template<class K , int32_t msize>

iterator SPL::bset< K, msize >::end ( )

inline

Get an end iterator

Returns

end iterator

end() [2/2]

template<class K , int32_t msize>

const_iterator SPL::bset< K, msize >::end ( ) const

inline

Get an end const iterator

Returns

end const iterator

max_size()

template<class K , int32_t msize>

int32_t SPL::bset< K, msize >::max_size ( ) const

inline

Get the bounded size of the set

Returns

bounded size of the set

size()

template<class K , int32_t msize>

size_type SPL::bset< K, msize >::size ( ) const

inline

Get the number of used elements

Returns

number of used elements

hash_funct()

template<class K , int32_t msize>

hasher SPL::bset< K, msize >::hash_funct ( ) const

inline

Get the hash function

Returns

the hash function

clear()

template<class K , int32_t msize>

void SPL::bset< K, msize >::clear ( )

inline

Remove all elements

empty()

template<class K , int32_t msize>

bool SPL::bset< K, msize >::empty ( ) const

inline

Check if empty

Returns

true if empty, false otherwise

find() [1/2]

template<class K , int32_t msize>

iterator SPL::bset< K, msize >::find ( const value_type &  k )

inline

Find an element in the set

Parameters

k	search key

Returns

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

find() [2/2]

template<class K , int32_t msize>

const_iterator SPL::bset< K, msize >::find ( const value_type &  k ) const

inline

Find an element in the set

Parameters

k	search key

Returns

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

count()

template<class K , int32_t msize>

size_type SPL::bset< K, msize >::count ( const value_type &  k ) const

inline

Count the number of elements with a given key

Parameters

k	search key

Returns

the number of elements with the given key

operator[]()

template<class K , int32_t msize>

value_type& SPL::bset< K, msize >::operator[] ( const value_type &  k )

inline

Get the element with a given key, create it if it does not exist

Parameters

k	search key

Returns

reference to the element

add()

template<class K , int32_t msize>

bset<K,msize>& SPL::bset< K, msize >::add ( const K &  k )

inline

Insert into set

Parameters

k	Key to be added

Returns

*this

insert() [1/2]

template<class K , int32_t msize>

std::pair<iterator, bool> SPL::bset< K, msize >::insert ( const value_type &  x )

inline

Insert a given element. If there is no space left in the bounded set, one of the existing items is replaced.

Parameters

x	element to insert

Returns

a iterator-bool pair, where the iterator points to the inserted element and the bool is true if no existing element was replaced, and false otherwise

insert() [2/2]

template<class K , int32_t msize>

template<class InputIterator >

void SPL::bset< K, msize >::insert ( InputIterator  first, InputIterator  last  )

inline

Insert a given sequence of elements

Parameters

first	begin iterator for the insert sequence, inclusive
last	end iterator for the insert sequence, exclusive

erase() [1/3]

template<class K , int32_t msize>

void SPL::bset< K, msize >::erase ( iterator  pos )

inline

Remove an element at a given position

Parameters

pos	iterator pointing to the element

erase() [2/3]

template<class K , int32_t msize>

size_type SPL::bset< K, msize >::erase ( const value_type &  k )

inline

Remove elements with a given key

Parameters

k	search key

Returns

the number of elements removed

erase() [3/3]

template<class K , int32_t msize>

void SPL::bset< K, msize >::erase ( iterator  first, iterator  last  )

inline

Remove a sequence of elements

Parameters

first	begin iterator for the remove sequence, inclusive
last	end iterator for the remove sequence, exclusive

getData()

template<class K , int32_t msize>

value_type const* SPL::bset< K, msize >::getData ( ) const

inline

Get the C array representation

Returns

C array representation

swap()

template<class K , int32_t msize>

template<int32_t osize>

void SPL::bset< K, msize >::swap ( bset< K, osize > &  ot )

inline

Swap

Parameters

ot	bounded size set to swap with

serialize() [1/2]

template<class K , int32_t msize>

template<class BufferType >

void SPL::bset< K, msize >::serialize ( ByteBuffer< BufferType > &  buf ) const

inline

Serialize (binary)

Parameters

buf	byte buffer to use

deserialize() [1/2]

template<class K , int32_t msize>

template<class BufferType >

void SPL::bset< K, msize >::deserialize ( ByteBuffer< BufferType > &  buf )

inline

Deserialize (binary)

Parameters

buf	byte buffer to use

serialize() [2/2]

template<class K , int32_t msize>

void SPL::bset< K, msize >::serialize ( std::ostream &  ostr ) const

virtual

Serialize (character)

Parameters

ostr	output stream

Implements SPL::Collection.

serializeWithPrecision()

template<class K , int32_t msize>

void SPL::bset< K, msize >::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 , int32_t msize>

void SPL::bset< K, msize >::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 , int32_t msize>

void SPL::bset< K, msize >::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 , int32_t msize>

size_t SPL::bset< K, msize >::hashCode ( ) const

inlinevirtual

Get hash code

Returns

hash code

Implements SPL::Collection.

normalize()

template<class K , int32_t msize>

void SPL::bset< K, msize >::normalize ( )

inline

Normalize the contents of the set via rehashing

getBoundedSize()

template<class K , int32_t msize>

virtual uint32_t SPL::bset< K, msize >::getBoundedSize ( ) const

inlinevirtual

Get the bounded size of the set

Returns

bounded size of the set

Implements SPL::BSet.

getUsedSize()

template<class K , int32_t msize>

virtual uint32_t SPL::bset< K, msize >::getUsedSize ( ) const

inlinevirtual

Get the number of used elements

Returns

number of used elements

Implements SPL::BSet.

equals()

template<class K , int32_t msize>

virtual bool SPL::bset< K, msize >::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.

assignFrom()

template<class K , int32_t msize>

virtual void SPL::bset< K, msize >::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 , int32_t msize>

virtual void SPL::bset< K, msize >::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.

clone()

template<class K , int32_t msize>

virtual Collection* SPL::bset< K, msize >::clone ( ) const

inlinevirtual

Create a clone of the collection object

Returns

clone of the collection object

Implements SPL::Collection.

getElementMetaType()

template<class K , int32_t msize>

virtual Meta::Type SPL::bset< K, msize >::getElementMetaType ( ) const

inlinevirtual

Get element type

Returns

element type of this set

Implements SPL::Set.

createElement()

template<class K , int32_t msize>

virtual ValueHandle SPL::bset< K, msize >::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 , int32_t msize>

virtual int32_t SPL::bset< K, msize >::getSize ( ) const

inlinevirtual

Get the size of the set

Returns

size of the set

Implements SPL::Set.

findElement() [1/2]

template<class K , int32_t msize>

virtual SetIterator SPL::bset< K, msize >::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 , int32_t msize>

virtual ConstSetIterator SPL::bset< K, msize >::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 , int32_t msize>

virtual void SPL::bset< K, msize >::insertElement ( const ConstValueHandle &  key )

inlinevirtual

Insert an element

Parameters

key	value handle for the element

Implements SPL::Set.

removeElement()

template<class K , int32_t msize>

virtual void SPL::bset< K, msize >::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 , int32_t msize>

virtual void SPL::bset< K, msize >::removeAllElements ( )

inlinevirtual

Remove all elements

Implements SPL::Set.

getBeginIterator() [1/2]

template<class K , int32_t msize>

virtual SetIterator SPL::bset< K, msize >::getBeginIterator ( )

inlinevirtual

Get a begin iterator

Returns

begin iterator

Implements SPL::Set.

getBeginIterator() [2/2]

template<class K , int32_t msize>

virtual ConstSetIterator SPL::bset< K, msize >::getBeginIterator ( ) const

inlinevirtual

Get a begin const iterator

Returns

begin const iterator

Implements SPL::Set.

getEndIterator() [1/2]

template<class K , int32_t msize>

virtual SetIterator SPL::bset< K, msize >::getEndIterator ( )

inlinevirtual

Get an end iterator

Returns

end iterator

Implements SPL::Set.

getEndIterator() [2/2]

template<class K , int32_t msize>

virtual ConstSetIterator SPL::bset< K, msize >::getEndIterator ( ) const

inlinevirtual

Get an end cost iterator

Returns

end const iterator

Implements SPL::Set.

getSerializedSize()

template<class K , int32_t msize>

virtual size_t SPL::bset< K, msize >::getSerializedSize ( ) const

inlinevirtual

Get the size in bytes when serialized

Returns

size in bytes when serialized

Implements SPL::Collection.

getIterManager()

template<class K , int32_t msize>

const SetIterManager& SPL::bset< K, msize >::getIterManager ( ) const

inlineprotectedvirtual

Implements SPL::Set.

---

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

• SPL/Runtime/Type/BSet.h