SPL::bmap< K, V, msize > Class Template Reference

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

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

Inheritance diagram for SPL::bmap< K, V, msize >:

Public Types
using	key_type = K
	key type More...
using	data_type = V
	data type More...
using	value_type = std::pair< K, V >
	value type More...
using	size_type = typename TMP::SizeType< msize >::value
	size type More...
using	hasher = std::hash< K >
	hasher type More...
using	reference = std::pair< K, V > &
	element reference type More...
using	const_reference = const std::pair< K, V > &
	element constant reference type More...
using	pointer = std::pair< K, V > *
	element pointer type More...
using	const_pointer = const std::pair< K, V > *
	element constant pointer type More...
using	iterator = bmap_iterator< K, V, msize >
	iterator type More...
using	const_iterator = const_bmap_iterator< K, V, msize >
	constant iterator type More...

Public Member Functions
	bmap ()
template<class InputIterator >
	bmap (InputIterator first, InputIterator last)
template<class K2 , class V2 >
	bmap (const std::unordered_map< K2, V2 > &o)
template<class K2 , class V2 , uint32_t msize2>
	bmap (const bmap< K2, V2, msize2 > &o)
	bmap (const bmap< K, V, msize > &ot)
template<int32_t osize>
	bmap (const bmap< K, V, osize > &ot)
	bmap (const std::unordered_map< K, V > &ot)
	bmap (const BMap &o)
	bmap (const ConstValueHandle &o)
	~bmap ()
const bmap &	operator= (const bmap< K, V, msize > &ot)
template<int32_t osize>
const bmap &	operator= (const bmap< K, V, osize > &ot)
const bmap &	operator= (const std::unordered_map< K, V > &ot)
bool	operator== (const bmap< K, V, msize > &ot) const
template<int32_t osize>
bool	operator== (const bmap< K, V, osize > &ot) const
bool	operator!= (const bmap< K, V, msize > &ot) const
template<int32_t osize>
bool	operator!= (const bmap< K, V, 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 ()
	Remove all elements. More...
bool	empty () const
iterator	find (const key_type &k)
const_iterator	find (const key_type &k) const
size_type	count (const key_type &k) const
data_type &	operator[] (const key_type &k)
data_type &	at (const key_type &k)
const data_type &	at (const key_type &k) const
bmap< K, V, msize > &	add (const K &k, const V &v)
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 key_type &k)
void	erase (iterator first, iterator last)
value_type const *	getData () const
template<int32_t osize>
void	swap (bmap< K, V, 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	getKeyMetaType () const
virtual Meta::Type	getValueMetaType () const
virtual std::pair< Meta::Type, Meta::Type >	getElementMetaType () const
virtual ValueHandle	createKey () const
virtual ValueHandle	createValue () const
virtual std::pair< ValueHandle, ValueHandle >	createElement () const
virtual int32_t	getSize () const
virtual MapIterator	findElement (const ConstValueHandle &key)
virtual ConstMapIterator	findElement (const ConstValueHandle &key) const
virtual void	insertElement (const ConstValueHandle &key, const ConstValueHandle &value)
virtual void	removeElement (const ConstValueHandle &key)
virtual void	removeAllElements ()
virtual MapIterator	getBeginIterator ()
virtual ConstMapIterator	getBeginIterator () const
virtual MapIterator	getEndIterator ()
virtual ConstMapIterator	getEndIterator () const
virtual size_t	getSerializedSize () const
Public Member Functions inherited from SPL::BMap
const BMap &	operator= (const BMap &ov)
Public Member Functions inherited from SPL::Map
virtual	~Map ()=default
const Map &	operator= (const Map &ov)
Public Member Functions inherited from SPL::Collection
virtual	~Collection ()=default
	Destructor. More...

Additional Inherited Members
Protected Member Functions inherited from SPL::Map
virtual const MapIterManager &	getIterManager () const =0

Detailed Description

template<class K, class V, int32_t msize>
class SPL::bmap< K, V, msize >

Class that represents bounded size map type.

Member Typedef Documentation

key_type

template<class K , class V , int32_t msize>

using SPL::bmap< K, V, msize >::key_type = K

key type

data_type

template<class K , class V , int32_t msize>

using SPL::bmap< K, V, msize >::data_type = V

data type

value_type

template<class K , class V , int32_t msize>

using SPL::bmap< K, V, msize >::value_type = std::pair<K, V>

value type

size_type

template<class K , class V , int32_t msize>

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

size type

hasher

template<class K , class V , int32_t msize>

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

hasher type

reference

template<class K , class V , int32_t msize>

using SPL::bmap< K, V, msize >::reference = std::pair<K, V> &

element reference type

const_reference

template<class K , class V , int32_t msize>

using SPL::bmap< K, V, msize >::const_reference = const std::pair<K, V> &

element constant reference type

pointer

template<class K , class V , int32_t msize>

using SPL::bmap< K, V, msize >::pointer = std::pair<K, V> *

element pointer type

const_pointer

template<class K , class V , int32_t msize>

using SPL::bmap< K, V, msize >::const_pointer = const std::pair<K, V> *

element constant pointer type

iterator

template<class K , class V , int32_t msize>

using SPL::bmap< K, V, msize >::iterator = bmap_iterator<K, V, msize>

iterator type

const_iterator

template<class K , class V , int32_t msize>

using SPL::bmap< K, V, msize >::const_iterator = const_bmap_iterator<K, V, msize>

constant iterator type

Constructor & Destructor Documentation

bmap() [1/9]

template<class K , class V , int32_t msize>

SPL::bmap< K, V, msize >::bmap ( )

inlineexplicit

Empty constructor

bmap() [2/9]

template<class K , class V , int32_t msize>

template<class InputIterator >

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

inline

Construct from a sequence

Parameters

first	begin iterator, inclusive
last	end iterator, exclusive

bmap() [3/9]

template<class K , class V , int32_t msize>

template<class K2 , class V2 >

SPL::bmap< K, V, msize >::bmap ( const std::unordered_map< K2, V2 > &  o )

inline

Construct bmap from an assignable map

Parameters

o	map to construct from

bmap() [4/9]

template<class K , class V , int32_t msize>

template<class K2 , class V2 , uint32_t msize2>

SPL::bmap< K, V, msize >::bmap ( const bmap< K2, V2, msize2 > &  o )

inline

Construct from an assignable bmap

Parameters

o	map to construct from

bmap() [5/9]

template<class K , class V , int32_t msize>

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

inline

Copy constructor

Parameters

ot	bounded size map to construct from

bmap() [6/9]

template<class K , class V , int32_t msize>

template<int32_t osize>

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

inline

Copy constructor

Parameters

ot	bounded size map to construct from

bmap() [7/9]

template<class K , class V , int32_t msize>

SPL::bmap< K, V, msize >::bmap ( const std::unordered_map< K, V > &  ot )

inline

Construct from an std::unordered_map

Parameters

ot	unordered map to construct from

bmap() [8/9]

template<class K , class V , int32_t msize>

SPL::bmap< K, V, msize >::bmap ( const BMap &  o )

inline

Construct from a reflective bounded size map

Parameters

o	reflective bounded size map to construct from

bmap() [9/9]

template<class K , class V , int32_t msize>

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

inline

Construct from a value handle

Parameters

o	value handle to construct from

~bmap()

template<class K , class V , int32_t msize>

SPL::bmap< K, V, msize >::~bmap ( )

inline

Destructor

Member Function Documentation

operator=() [1/3]

template<class K , class V , int32_t msize>

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

inline

Assignment operator (from another bounded size map)

Parameters

ot	bounded size map to assign from

Returns

self

operator=() [2/3]

template<class K , class V , int32_t msize>

template<int32_t osize>

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

inline

Assignment operator (from another bounded size map)

Parameters

ot	bounded size map to assign from

Returns

self

operator=() [3/3]

template<class K , class V , int32_t msize>

const bmap& SPL::bmap< K, V, msize >::operator= ( const std::unordered_map< K, V > &  ot )

inline

Assignment operator (from an std unordered_map)

Parameters

ot	std unordered_map to assign from

Returns

self

operator==() [1/2]

template<class K , class V , int32_t msize>

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

inline

Equality comparison

Parameters

ot	bounded size map to compare with

Returns

true if the contained elements are the same, false otherwise

operator==() [2/2]

template<class K , class V , int32_t msize>

template<int32_t osize>

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

inline

Equality comparison

Parameters

ot	bounded size map to compare with

Returns

true if the contained elements are the same, false otherwise

operator!=() [1/2]

template<class K , class V , int32_t msize>

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

inline

Non-equality comparison

Parameters

ot	bounded size map to compare with

Returns

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

operator!=() [2/2]

template<class K , class V , int32_t msize>

template<int32_t osize>

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

inline

Non-equality comparison

Parameters

ot	bounded size map to compare with

Returns

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

begin() [1/2]

template<class K , class V , int32_t msize>

iterator SPL::bmap< K, V, msize >::begin ( )

inline

Get a begin iterator

Returns

begin iterator

begin() [2/2]

template<class K , class V , int32_t msize>

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

inline

Get a begin const iterator

Returns

begin const iterator

end() [1/2]

template<class K , class V , int32_t msize>

iterator SPL::bmap< K, V, msize >::end ( )

inline

Get an end iterator

Returns

end iterator

end() [2/2]

template<class K , class V , int32_t msize>

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

inline

Get an end const iterator

Returns

end const iterator

max_size()

template<class K , class V , int32_t msize>

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

inline

Get the bounded size of the map

Returns

bounded size of the map

size()

template<class K , class V , int32_t msize>

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

inline

Get the number of used elements

Returns

number of used elements

hash_funct()

template<class K , class V , int32_t msize>

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

inline

Get the hash function

Returns

the hash function

clear()

template<class K , class V , int32_t msize>

void SPL::bmap< K, V, msize >::clear ( )

inline

Remove all elements.

empty()

template<class K , class V , int32_t msize>

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

inline

Check if empty

Returns

true if empty, false otherwise

find() [1/2]

template<class K , class V , int32_t msize>

iterator SPL::bmap< K, V, msize >::find ( const key_type &  k )

inline

Find an element in the map

Parameters

k	search key

Returns

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

find() [2/2]

template<class K , class V , int32_t msize>

const_iterator SPL::bmap< K, V, msize >::find ( const key_type &  k ) const

inline

Find an element in the map

Parameters

k	search key

Returns

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

count()

template<class K , class V , int32_t msize>

size_type SPL::bmap< K, V, msize >::count ( const key_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 , class V , int32_t msize>

data_type& SPL::bmap< K, V, msize >::operator[] ( const key_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

at() [1/2]

template<class K , class V , int32_t msize>

data_type& SPL::bmap< K, V, msize >::at ( const key_type &  k )

inline

Get the element with a given key, throw exception if not present

Parameters

k	search key

Returns

reference to the element

at() [2/2]

template<class K , class V , int32_t msize>

const data_type& SPL::bmap< K, V, msize >::at ( const key_type &  k ) const

inline

Get the element with a given key, throw exception if not present

Parameters

k	search key

Returns

constant reference to the element

add()

template<class K , class V , int32_t msize>

bmap<K,V,msize>& SPL::bmap< K, V, msize >::add ( const K &  k, const V &  v  )

inline

Append to list

Parameters

k	key to be added
v	value to be added

Returns

this

insert() [1/2]

template<class K , class V , int32_t msize>

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

inline

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

Parameters

x	element to insert

Returns

an 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 , class V , int32_t msize>

template<class InputIterator >

void SPL::bmap< K, V, 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 , class V , int32_t msize>

void SPL::bmap< K, V, 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 , class V , int32_t msize>

size_type SPL::bmap< K, V, msize >::erase ( const key_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 , class V , int32_t msize>

void SPL::bmap< K, V, 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 , class V , int32_t msize>

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

inline

Get the C array representation

Returns

C array representation

swap()

template<class K , class V , int32_t msize>

template<int32_t osize>

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

inline

Swap

Parameters

ot	bounded size map to swap with

serialize() [1/2]

template<class K , class V , int32_t msize>

template<class BufferType >

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

inline

Serialize (binary)

Parameters

buf	byte buffer to use

deserialize() [1/2]

template<class K , class V , int32_t msize>

template<class BufferType >

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

inline

Deserialize (binary)

Parameters

buf	byte buffer to use

serialize() [2/2]

template<class K , class V , int32_t msize>

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

virtual

Serialize (character)

Parameters

ostr	output stream

Implements SPL::Collection.

serializeWithPrecision()

template<class K , class V , int32_t msize>

void SPL::bmap< K, V, 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 , class V , int32_t msize>

void SPL::bmap< K, V, 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 , class V , int32_t msize>

void SPL::bmap< K, V, 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 , class V , int32_t msize>

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

inlinevirtual

Get hash code

Returns

hash code

Implements SPL::Collection.

normalize()

template<class K , class V , int32_t msize>

void SPL::bmap< K, V, msize >::normalize ( )

inline

Normalize the contents of the map via rehashing

getBoundedSize()

template<class K , class V , int32_t msize>

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

inlinevirtual

Get the bounded size of the map

Returns

bounded size of the map

Implements SPL::BMap.

getUsedSize()

template<class K , class V , int32_t msize>

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

inlinevirtual

Get the number of used elements

Returns

number of used elements

Implements SPL::BMap.

equals()

template<class K , class V , int32_t msize>

virtual bool SPL::bmap< K, V, 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 , class V , int32_t msize>

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

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

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

inlinevirtual

Create a clone of the collection object

Returns

clone of the collection object

Implements SPL::Collection.

getKeyMetaType()

template<class K , class V , int32_t msize>

virtual Meta::Type SPL::bmap< K, V, msize >::getKeyMetaType ( ) const

inlinevirtual

Get key type

Returns

key type of the map

Implements SPL::Map.

getValueMetaType()

template<class K , class V , int32_t msize>

virtual Meta::Type SPL::bmap< K, V, msize >::getValueMetaType ( ) const

inlinevirtual

Get value type

Returns

value type of the map

Implements SPL::Map.

getElementMetaType()

template<class K , class V , int32_t msize>

virtual std::pair<Meta::Type,Meta::Type> SPL::bmap< K, V, msize >::getElementMetaType ( ) const

inlinevirtual

Get element type

Returns

element type of this map, as a (key,value) type pair

Implements SPL::Map.

createKey()

template<class K , class V , int32_t msize>

virtual ValueHandle SPL::bmap< K, V, msize >::createKey ( ) const

inlinevirtual

Create a new key. The returned value handle is a wrapper for an 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 key

Implements SPL::Map.

createValue()

template<class K , class V , int32_t msize>

virtual ValueHandle SPL::bmap< K, V, msize >::createValue ( ) const

inlinevirtual

Create a new key. The returned value handle is a wrapper for an 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 value

Implements SPL::Map.

createElement()

template<class K , class V , int32_t msize>

virtual std::pair<ValueHandle,ValueHandle> SPL::bmap< K, V, msize >::createElement ( ) const

inlinevirtual

Create a new element. The returned value handles are wrappers for objects 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 (key and value)

Implements SPL::Map.

getSize()

template<class K , class V , int32_t msize>

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

inlinevirtual

Get the size of the map

Returns

size of the map

Implements SPL::Map.

findElement() [1/2]

template<class K , class V , int32_t msize>

virtual MapIterator SPL::bmap< K, V, msize >::findElement ( const ConstValueHandle &  key )

inlinevirtual

Find an element in the map

Parameters

key	value handle for the key

Returns

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

Implements SPL::Map.

findElement() [2/2]

template<class K , class V , int32_t msize>

virtual ConstMapIterator SPL::bmap< K, V, msize >::findElement ( const ConstValueHandle &  key ) const

inlinevirtual

Find an element in the map

Parameters

key	value handle for the key

Returns

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

Implements SPL::Map.

insertElement()

template<class K , class V , int32_t msize>

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

inlinevirtual

Insert a given key value pair

Parameters

key	value handle for the key
value	value handle for the value

Implements SPL::Map.

removeElement()

template<class K , class V , int32_t msize>

virtual void SPL::bmap< K, V, msize >::removeElement ( const ConstValueHandle &  key )

inlinevirtual

remove the element with a given key

Parameters

key	value handle for the key

Implements SPL::Map.

removeAllElements()

template<class K , class V , int32_t msize>

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

inlinevirtual

Remove all elements

Implements SPL::Map.

getBeginIterator() [1/2]

template<class K , class V , int32_t msize>

virtual MapIterator SPL::bmap< K, V, msize >::getBeginIterator ( )

inlinevirtual

Get a begin iterator

Returns

begin iterator

Implements SPL::Map.

getBeginIterator() [2/2]

template<class K , class V , int32_t msize>

virtual ConstMapIterator SPL::bmap< K, V, msize >::getBeginIterator ( ) const

inlinevirtual

Get a begin const iterator

Returns

begin const iterator

Implements SPL::Map.

getEndIterator() [1/2]

template<class K , class V , int32_t msize>

virtual MapIterator SPL::bmap< K, V, msize >::getEndIterator ( )

inlinevirtual

Get an end iterator

Returns

end iterator

Implements SPL::Map.

getEndIterator() [2/2]

template<class K , class V , int32_t msize>

virtual ConstMapIterator SPL::bmap< K, V, msize >::getEndIterator ( ) const

inlinevirtual

Get an end cost iterator

Returns

end const iterator

Implements SPL::Map.

getSerializedSize()

template<class K , class V , int32_t msize>

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

inlinevirtual

Get the size in bytes when serialized

Returns

size in bytes when serialized

Implements SPL::Collection.

---

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

• SPL/Runtime/Type/BMap.h