#include <evo/maphash.h>

Inheritance diagram for MapHash< TKey, TValue, THash, TSize >:

Detailed Description

template<class TKey, class TValue, class THash = CompareHash<TKey>, class TSize = SizeT>
class evo::MapHash< TKey, TValue, THash, TSize >

Map implemented as a hash table.

Template Parameters

TKey	Map key type
TValue	Map value type
THash	Hash type to use – default: CompareHash
TSize	Size type to use for size values (must be unsigned integer) – default: `SizeT`

Features

Similar to STL unordered_map, implemented with a hash table
Values are always unique (no duplicate keys)
Items are each stored as a Pair
This uses PtrList internally
- No memory allocated by new empty map
- Sharing makes copying efficient

C++11:

Range-based for loop – see STL Compatibility
MapHash<int,int> map;
for (auto& item : map.asconst()) {
item.key();
item.value();
}
Initialization lists
MapHash<int,int> map = {{3, 300}, {1, 100}, {2, 200}};
MapHash<String,String> strmap = {{"key1", "foo"}, {"key2", "bar"}};
Move semantics

Comparison/Hash

This type is used for both hashing and comparing keys. You can leave the default comparison/hash type (CompareHash) or specify an alternative.

CompareHash

See: Primitives & Containers

Iterators

Map::Iter – Read-Only Iterator (IteratorBi)
Map::IterM – Mutable Iterator (IteratorBi)

Caution: Modifying or resizing a map will shift or invalidate existing iterators using it.

Constructor

MapHash()
MapHash(const MapBaseType&)
MapHash(const ThisType&)
MapHash(const std::initializer_list<InitPair>&) [C++11]
MapHash(ThisType&&) [C++11]

Read Access

asconst()
size()
- null(), empty()
- capacity()
- shared()
- ordered()
contains(const Key&) const
cbegin(), cend()
- begin() const, end() const
find()
- iter()
operator==()
- operator!=()

Modifiers

Helpers

Example

This example works with any Map type.

Example using a map of numbers

#include <evo/string.h>
#include <evo/maphash.h>
#include <evo/io.h>
using namespace evo;
static Console& c = con();
int main() {
    typedef MapHash<int,int> MyMap;
    // Create map with numeric keys and values
    MyMap map;
    map.add(2, 20);
    map[1] = 10;
    // Add more values from delimited string
    map.addsplit("3=30,4=40");
    // Join map as delimited string and print it
    String str;
    str.joinmap(map);
    c.out << str << NL;
    // Check if map contains key
    bool has1 = map.contains(1);        // true
    bool has5 = map.contains(5);        // false
    // Check if map contains key and value
    bool has1_10 = map.contains(1, 10); // true
    bool has1_20 = map.contains(1, 20); // false
    bool has5_50 = map.contains(5, 50); // false
    // Find and modify value
    int* value = map.findM(1);
    if (value != NULL)
        *value = 100;
    // Iterate and print keys and values
    for (MyMap::Iter iter(map); iter; ++iter)
        c.out << iter->key() << "=" << iter->value() << NL;
    return 0;
}

Output:

2=20,3=30,1=10,4=40
2=20
3=30
1=100
4=40

Note: Item ordering will vary

Public Types
typedef void	EvoContainerType

typedef THash	Hash
	Hashing type – default: CompareHash. More...

typedef Pair< Key, Value >	Item
	Item type (key/value pair) More...

typedef IteratorBi< ThisType >::Const	Iter
	Iterator (const) - IteratorBi. More...

typedef IteratorBi< ThisType >	IterM
	Iterator (mutable) - IteratorBi. More...

typedef TKey	Key
	Key type. More...

using	KeyPass = typename DataCopy< TKey >::PassType
	Key type for passing through InitPair (C++11) More...

typedef Map< TKey, TValue, TSize >	MapBaseType
	Map base type More...

typedef TSize	Size
	Size type for size values (must be unsigned integer) – default: SizeT. More...

typedef MapHash< TKey, TValue, THash, TSize >	ThisType
	This type. More...

typedef TValue	Value
	Value type. More...

using	ValuePass = typename DataCopy< TValue >::PassType
	Value type for passing through InitPair (C++11) More...

Public Member Functions
	MapHash ()
	Constructor. More...

	MapHash (const MapBaseType &src)
	Copy constructor. More...

	MapHash (const ThisType &src)
	Copy constructor. More...

	MapHash (const std::initializer_list< InitPair > &init)
	< Used with initializer_list constructor (C++11) More...

	MapHash (ThisType &&src)
	Move constructor (C++11). More...

virtual MapBaseType &	add (const MapBaseType &map, bool update=true)=0
	Add items from given map. More...

Item &	add (const Key &key, const Value &value, bool update=true)
	Add or update using given key and value. More...

Item &	add (const Item &item, bool update=true)
	Add or update using given item. More...

ThisType &	add (const MapBaseType &map, bool update=true)

template<class T >
Size	addsplit (const T &str, char delim=',', char kvdelim='=')
	Split delimited string into map key/value items. More...

const ThisType &	asconst () const
	Explicitly use a const reference to this. More...

IterM	begin ()
	Get iterator at first item (mutable). More...

Iter	begin () const
	Get iterator at first item (const). More...

Size	capacity () const
	Get map capacity. More...

ThisType &	capacity (Size size)
	Set hash map size (capacity). More...

ThisType &	capacitymin (Size min)
	Set map capacity to at least given minimum. More...

Iter	cbegin () const
	Get iterator at first item (const). More...

Iter	cend () const
	Get iterator at end (const). More...

ThisType &	clear ()
	Clear by removing all items. More...

virtual MapBaseType &	compact ()
	Reduce capacity to fit current size (modifier). More...

bool	contains (const Key &key) const
	Get whether map contains the given key. More...

bool	empty () const
	Get whether map is empty (size is 0). More...

IterM	end ()
	Get iterator at end. More...

Iter	end () const
	Get iterator at end (const). More...

const Value *	find (const Key &key) const
	Find (lookup) value for given key (const). More...

Value *	findM (const Key &key)
	Find (lookup) value for given key (mutable). More...

Value &	get (const Key &key, bool *created=NULL)
	Get item value for key (mutable). More...

Item &	getitem (const Key &key, bool *created=NULL)
	Get map item for key (mutable). More...

Iter	iter (const Key &key) const
	Find (lookup) iterator for given key (const). More...

IterM	iterM (const Key &key)
	Find (lookup) iterator for given key (mutable). More...

bool	null () const
	Get whether map is null. More...

bool	operator!= (const MapBaseType &map) const
	Inequality operator. More...

ThisType &	operator= (ThisType &&src)
	Move assignment operator (C++11). More...

ThisType &	operator= (const MapBaseType &src)
	Assignment operator. More...

ThisType &	operator= (const ThisType &src)
	Assignment operator. More...

bool	operator== (const MapBaseType &map) const
	Equality operator. More...

Value &	operator[] (const Key &key)
	Get item value for key (mutable). More...

bool	ordered () const
	Get whether map is ordered. More...

bool	remove (const Key &key)
	Find and remove item with given key. More...

bool	remove (typename MapBaseType::IterM &iter, IteratorDir dir=iterNONE)
	Remove item using given iterator. More...

bool	remove (IterM &iter, IteratorDir dir=iterNONE)
	Remove item using given iterator. More...

ThisType &	reserve (Size size)
	Reserve space for new items. More...

void	resize (Size size)
	Set hash map size (capacity) directly. More...

ThisType &	set ()
	Set as null and empty. More...

ThisType &	set (const MapBaseType &src)

ThisType &	set (const ThisType &src)
	Set as copy of given map. More...

ThisType &	setempty ()
	Set as empty but not null. More...

bool	shared () const
	Get whether shared. More...

Size	size () const
	Get map size (number of items). More...

ThisType &	unshare ()
	Make data unique by allocating new buffer, if needed (modifier). More...

Protected Member Functions
const Item *	getiter (IterKey &iterkey, const Key &key) const
	Used by base class to get data to initialize iterator. More...

Protected Attributes
bool	ordered_
	Whether map is ordered (items are kept in order by key) More...

Size	size_
	Map size (number of items, automatically updated by concrete set members) More...

Member Typedef Documentation

◆ EvoContainerType

typedef void EvoContainerType

◆ Hash

typedef THash Hash

Hashing type – default: CompareHash.

◆ Item

typedef Pair<Key,Value> Item

inherited

Item type (key/value pair)

◆ Iter

typedef IteratorBi<ThisType>::Const Iter

Iterator (const) - IteratorBi.

◆ IterM

typedef IteratorBi<ThisType> IterM

Iterator (mutable) - IteratorBi.

◆ Key

typedef TKey Key

inherited

Key type.

◆ KeyPass

using KeyPass = typename DataCopy<TKey>::PassType

inherited

Key type for passing through InitPair (C++11)

◆ MapBaseType

typedef Map<TKey,TValue,TSize> MapBaseType

inherited

Map base type

◆ Size

typedef TSize Size

inherited

Size type for size values (must be unsigned integer) – default: SizeT.

◆ ThisType

typedef MapHash<TKey,TValue,THash,TSize> ThisType

This type.

◆ Value

typedef TValue Value

inherited

Value type.

◆ ValuePass

using ValuePass = typename DataCopy<TValue>::PassType

inherited

Value type for passing through InitPair (C++11)

Constructor & Destructor Documentation

◆ MapHash() [1/5]

MapHash ( )

inline

Constructor.

◆ MapHash() [2/5]

MapHash ( const MapBaseType & src )

inline

Copy constructor.

Parameters

src	Source to copy

◆ MapHash() [3/5]

MapHash ( const ThisType & src )

inline

Copy constructor.

Parameters

src	Source to copy

◆ MapHash() [4/5]

MapHash ( const std::initializer_list< InitPair > & init )

inline

< Used with initializer_list constructor (C++11)

Sequence constructor (C++11).

Parameters

init	Initializer list, passed as comma-separated values in braces `{ }`

◆ MapHash() [5/5]

MapHash ( ThisType && src )

inline

Move constructor (C++11).

Parameters

src	Source to move

Member Function Documentation

◆ add() [1/4]

virtual MapBaseType& add	(	const MapBaseType &	map,
		bool	update = `true`
	)

pure virtualinherited

Add items from given map.

Parameters

map	Map to add items from
update	Whether to update value for existing items

Returns: This

Implemented in MapList< TKey, TValue, TCompare, TSize >, MapList< String, CommandInfo >, MapList< SigNumType, Handler >, and MapList< String, OptionInfoShPtr >.

◆ add() [2/4]

Item& add	(	const Key &	key,
		const Value &	value,
		bool	update = `true`
	)

inlinevirtual

Add or update using given key and value.

Parameters

key	Key to find/add (copied)
value	Value to add/update (copied)
update	Whether to update value for existing item

Returns: Item added/updated

Implements Map< TKey, TValue, TSize >.

◆ add() [3/4]

Item& add	(	const Item &	item,
		bool	update = `true`
	)

inlinevirtual

Add or update using given item.

Parameters

item	Item to use for add/update (copied)
update	Whether to update value for existing item

Returns: Item added/updated

Implements Map< TKey, TValue, TSize >.

◆ add() [4/4]

ThisType& add	(	const MapBaseType &	map,
		bool	update = `true`
	)

inline

◆ addsplit()

Size addsplit	(	const T &	str,
		char	delim = `','`,
		char	kvdelim = `'='`
	)

inlineinherited

Split delimited string into map key/value items.

This parses/tokenizes str and adds each item to map, using convert() for conversion to map key and value types
Map key and value types must be convertible from String via convert()
See joinmap() to join map back into string

Template Parameters

T	String type to parse – inferred from str parameter

Parameters

str	String to parse
delim	Item delimiter to use
kvdelim	Key/Value delimiter to use

Returns: Number of items added to map

◆ asconst()

const ThisType& asconst ( ) const

inline

Explicitly use a const reference to this.

This is useful to force using this as const without casting

Returns: This

◆ begin() [1/2]

IterM begin ( )

inline

Get iterator at first item (mutable).

This allows compatibility with range-based for loops and other libraries, otherwise use container Iter directly
cbegin() is more efficient, since this effectively calls unshare() to make items mutable

Returns: Iterator at first item, or at end position if empty

See also: IterM, end(), cbegin(), cend()

◆ begin() [2/2]

Iter begin ( ) const

inline

Get iterator at first item (const).

This allows compatibility with range-based for loops and other libraries, otherwise use container Iter directly

Returns: Iterator at first item, or at end position if empty

See also: end() const, cbegin()

◆ capacity() [1/2]

Size capacity ( ) const

inlinevirtual

Get map capacity.

Returns: Current capacity

Implements Map< TKey, TValue, TSize >.

◆ capacity() [2/2]

ThisType& capacity ( Size size )

inlinevirtual

Set hash map size (capacity).

Use to suggest a new capacity before adding a batch of items
This will set hash size to nearest power of 2 that can fit both current items and given size
Caution: This will invalidate iterators on this map

Parameters

size	New suggested capacity

Returns: This

Implements Map< TKey, TValue, TSize >.

◆ capacitymin()

ThisType& capacitymin ( Size min )

inlinevirtual

Set map capacity to at least given minimum.

Parameters

min	Minimum capacity

Returns: This

Implements Map< TKey, TValue, TSize >.

◆ cbegin()

Iter cbegin ( ) const

inline

Get iterator at first item (const).

This allows compatibility with range-based for loops and other libraries, otherwise use container Iter directly

Returns: Iterator at first item, or at end position if empty

See also: Iter, cend(), begin(), end()

◆ cend()

Iter cend ( ) const

inline

Get iterator at end (const).

This allows compatibility with range-based for loops and other libraries, otherwise use container Iter directly
This really just creates an empty iterator

Returns: Iterator at end position

See also: Iter, cbegin(), begin(), end()

◆ clear()

ThisType& clear ( )

inlinevirtual

Clear by removing all items.

Does not set as null – null status is unchanged

Returns: This

Implements Map< TKey, TValue, TSize >.

◆ compact()

virtual MapBaseType& compact ( )

inlinevirtualinherited

Reduce capacity to fit current size (modifier).

Call to save memory when done adding items
This is just a suggestion – some implementations may ignore it

Returns: This

Reimplemented in MapList< TKey, TValue, TCompare, TSize >, MapList< String, CommandInfo >, MapList< SigNumType, Handler >, and MapList< String, OptionInfoShPtr >.

◆ contains()

bool contains ( const Key & key ) const

inlinevirtual

Get whether map contains the given key.

See also: map_contains()

Parameters

key	Key to look for

Returns: Whether key was found

Implements Map< TKey, TValue, TSize >.

◆ empty()

bool empty ( ) const

inlineinherited

Get whether map is empty (size is 0).

Returns: Whether empty

◆ end() [1/2]

IterM end ( )

inline

Get iterator at end.

This allows compatibility with range-based for loops and other libraries, otherwise use container Iter directly
This really just creates an empty iterator

Returns: Iterator at end position

See also: IterM, begin(), cbegin(), cend()

◆ end() [2/2]

Iter end ( ) const

inline

Get iterator at end (const).

This allows compatibility with range-based for loops and other libraries, otherwise use container Iter directly
This really just creates an empty iterator

Returns: Iterator at end position

See also: begin() const, cend()

◆ find()

const Value* find ( const Key & key ) const

inlinevirtual

Find (lookup) value for given key (const).

Parameters

key	Key to find

Returns: Found value const pointer, NULL if not found

Implements Map< TKey, TValue, TSize >.

◆ findM()

Value* findM ( const Key & key )

inlinevirtual

Find (lookup) value for given key (mutable).

Parameters

key	Key to find

Returns: Found value pointer, NULL if not found

Implements Map< TKey, TValue, TSize >.

◆ get()

Value& get	(	const Key &	key,
		bool *	created = `NULL`
	)

inline

Get item value for key (mutable).

Item is created with default value if not found

Parameters

key	Key to use
created	Stores whether new item was created, if not NULL

Returns: Value reference for key

◆ getitem()

Item& getitem	(	const Key &	key,
		bool *	created = `NULL`
	)

inlinevirtual

Get map item for key (mutable).

Item is created with default value if not found.

Parameters

key	Key to use
created	Stores whether new item was created, if not NULL

Returns: Value reference for key

Implements Map< TKey, TValue, TSize >.

◆ getiter()

const Item* getiter	(	IterKey &	iterkey,
		const Key &	key
	)		const

inlineprotectedvirtual

Used by base class to get data to initialize iterator.

Parameters

iterkey	Set to iterator data, if item found
key	Key to find

Returns: Item pointer, NULL if not found

Implements Map< TKey, TValue, TSize >.

◆ iter()

Iter iter ( const Key & key ) const

inline

Find (lookup) iterator for given key (const).

Parameters

key	Key to find

Returns: Iterator, at end position if not key not found

◆ iterM()

IterM iterM ( const Key & key )

inline

Find (lookup) iterator for given key (mutable).

Parameters

key	Key to find

Returns: Iterator, at end position if not key not found

◆ null()

bool null ( ) const

inlinevirtual

Get whether map is null.

Returns: Whether null

Implements Map< TKey, TValue, TSize >.

◆ operator!=()

bool operator!= ( const MapBaseType & map ) const

inlineinherited

Inequality operator.

Parameters

map	Map to compre

Returns: Whether maps are not equal (don't have same keys and values)

◆ operator=() [1/3]

ThisType& operator= ( ThisType && src )

inline

Move assignment operator (C++11).

Parameters

src	Source to move

Returns: This

◆ operator=() [2/3]

ThisType& operator= ( const MapBaseType & src )

inline

Assignment operator.

Parameters

src	Source to copy

Returns: This

◆ operator=() [3/3]

ThisType& operator= ( const ThisType & src )

inline

Assignment operator.

This copies the hash and comparison objects as well

Parameters

src	Source to copy

Returns: This

◆ operator==()

bool operator== ( const MapBaseType & map ) const

inlineinherited

Equality operator.

Parameters

map	Map to compre

Returns: Whether maps are equal (have same keys and values)

◆ operator[]()

Value& operator[] ( const Key & key )

inline

Get item value for key (mutable).

Item is created with default value if not found
Same as get(const Key&)

Parameters

key	Key to use

Returns: Value reference for key

◆ ordered()

bool ordered ( ) const

inlineinherited

Get whether map is ordered.

Ordered maps keep items in order by key so iteration is predictable

◆ remove() [1/3]

bool remove ( const Key & key )

inlinevirtual

Find and remove item with given key.

Caution: Removing an item may shift other iterators on same map, in an unpredictable way – see remove(IterM&,IteratorDir)

Parameters

key	Key to use

Returns: Whether key was removed, false if not found

Implements Map< TKey, TValue, TSize >.

◆ remove() [2/3]

bool remove	(	typename MapBaseType::IterM &	iter,
		IteratorDir	dir = `iterNONE`
	)

inlinevirtual

Remove item using given iterator.

This will move the iterator to the next item according to dir, or end position if no more
Caution: Removing an item may shift other iterators on same map, in an unpredictable way

Parameters

iter	Iterator position
dir	Direction to move iterator to next item, iterNONE for end position

Returns: Whether item was removed, false if iterator at end position

Implements Map< TKey, TValue, TSize >.

◆ remove() [3/3]

bool remove	(	IterM &	iter,
		IteratorDir	dir = `iterNONE`
	)

inlinevirtual

Remove item using given iterator.

This will move the iterator to the next item according to dir, or end position if no more
Caution: Removing an item may shift other iterators on same map, in an unpredictable way

Parameters

iter	Iterator position
dir	Direction to move iterator to next item, iterNONE for end position

Returns: Whether item was removed, false if iterator at end position

Implements Map< TKey, TValue, TSize >.

◆ reserve()

ThisType& reserve ( Size size )

inline

Reserve space for new items.

For best performance, call this before adding multiple items
This calls capacitymin() with current size + size to reserve space
This is just a suggestion – some implementations may ignore it

Parameters

size	Size to reserve

Returns: This

◆ resize()

void resize ( Size size )

inline

Set hash map size (capacity) directly.

This will force capacity to a given size (rounded up to next power of 2 if not a power of 2)
All existing items are preserved and rehashed as needed
If size is too small this will increase collisions and reduce lookup performance
Creating a new item or calling capacity(Size) will automatically resize the hash table if too small
Caution: This will invalidate iterators on this map

Parameters

size	New size/capacity, minimum size of 8 is used if lower

Returns: This

◆ set() [1/3]

ThisType& set ( )

inlinevirtual

Set as null and empty.

Returns: This

Implements Map< TKey, TValue, TSize >.

◆ set() [2/3]

ThisType& set ( const MapBaseType & src )

inline

◆ set() [3/3]

ThisType& set ( const ThisType & src )

inlinevirtual

Set as copy of given map.

This clears all items in current map.

Parameters

src	Source map

Returns: This

Implements Map< TKey, TValue, TSize >.

◆ setempty()

ThisType& setempty ( )

inlinevirtual

Set as empty but not null.

Returns: This

Implements Map< TKey, TValue, TSize >.

◆ shared()

bool shared ( ) const

inlinevirtual

Get whether shared.

Data is shared when referencing external data or buffer is allocated and shared (reference count > 1)

Returns: Whether shared

Implements Map< TKey, TValue, TSize >.

◆ size()

Size size ( ) const

inlineinherited

Get map size (number of items).

Returns: Map size

◆ unshare()

ThisType& unshare ( )

inlinevirtual

Make data unique by allocating new buffer, if needed (modifier).

Use reserve() instead to reserve additional space while unsharing
Use to make buffer unique (not shared) and writable (when not empty)
This is called automatically by mutable/modifier methods
This does nothing if empty or not shared

Returns: This

Implements Map< TKey, TValue, TSize >.

Member Data Documentation

◆ ordered_

bool ordered_

protectedinherited

Whether map is ordered (items are kept in order by key)

◆ size_

Size size_

protectedinherited

Map size (number of items, automatically updated by concrete set members)

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

evo/maphash.h

Detailed Description

template<class TKey, class TValue, class THash = CompareHash<TKey>, class TSize = SizeT> class evo::MapHash< TKey, TValue, THash, TSize >

Public Types

Public Member Functions

Protected Member Functions

Protected Attributes

Member Typedef Documentation

◆ EvoContainerType

◆ Hash

◆ Item

◆ Iter

◆ IterM

◆ Key

◆ KeyPass

◆ MapBaseType

◆ Size

◆ ThisType

◆ Value

◆ ValuePass

Constructor & Destructor Documentation

◆ MapHash() [1/5]

◆ MapHash() [2/5]

◆ MapHash() [3/5]

◆ MapHash() [4/5]

◆ MapHash() [5/5]

Member Function Documentation

◆ add() [1/4]

◆ add() [2/4]

◆ add() [3/4]

◆ add() [4/4]

◆ addsplit()

◆ asconst()

◆ begin() [1/2]

◆ begin() [2/2]

◆ capacity() [1/2]

◆ capacity() [2/2]

◆ capacitymin()

◆ cbegin()

◆ cend()

◆ clear()

◆ compact()

◆ contains()

◆ empty()

◆ end() [1/2]

◆ end() [2/2]

◆ find()

◆ findM()

◆ get()

◆ getitem()

◆ getiter()

◆ iter()

◆ iterM()

◆ null()

◆ operator!=()

◆ operator=() [1/3]

◆ operator=() [2/3]

◆ operator=() [3/3]

◆ operator==()

◆ operator[]()

◆ ordered()

◆ remove() [1/3]

◆ remove() [2/3]

◆ remove() [3/3]

◆ reserve()

◆ resize()

◆ set() [1/3]

◆ set() [2/3]

◆ set() [3/3]

◆ setempty()

◆ shared()

◆ size()

◆ unshare()

Member Data Documentation

◆ ordered_

◆ size_

template<class TKey, class TValue, class THash = CompareHash<TKey>, class TSize = SizeT>
class evo::MapHash< TKey, TValue, THash, TSize >