Doubly-linked hash map. More...

#include <tkrzw_containers.h>

Classes
class	ConstIterator
	Const iterator of records. More...

class	Iterator
	Iterator of records. More...

struct	Record
	Record data. More...

Public Types
enum	MoveMode : int32_t { MOVE_CURRENT = 0 , MOVE_FIRST = 1 , MOVE_LAST = 2 }
	Enumeration for move modes. More...

Public Member Functions
	LinkedHashMap ()
	Default constructor. More...

	LinkedHashMap (size_t num_buckets)
	Constructor. More...

	~LinkedHashMap ()
	Destructor. More...

	LinkedHashMap (const LinkedHashMap &rhs)=delete
	Copy and assignment are disabled. More...

LinkedHashMap &	operator= (const LinkedHashMap &rhs)=delete

Record *	Get (const KEYTYPE &key, MoveMode mode=MOVE_CURRENT)
	Retrieves a record. More...

VALUETYPE	GetSimple (const KEYTYPE &key, VALUETYPE default_value=VALUETYPE(), MoveMode mode=MOVE_CURRENT)
	Retrieves a record. More...

Record *	Set (const KEYTYPE &key, const VALUETYPE &value, bool overwrite=true, MoveMode mode=MOVE_CURRENT)
	Stores a record. More...

bool	Remove (const KEYTYPE &key)
	Removes a record. More...

Record *	Migrate (const KEYTYPE &key, LinkedHashMap *dest, MoveMode mode)
	Migrates a record to another map. More...

void	clear ()
	Removes all records. More...

size_t	size () const
	Gets the number of records. More...

bool	empty () const
	Checks whether no records exist. More...

Iterator	begin ()
	Gets an iterator at the first record. More...

ConstIterator	begin () const
	Gets a const iterator at the first record. More...

Iterator	end ()
	Gets an iterator of the end sentry. More...

ConstIterator	end () const
	Gets a const iterator of the end sentry. More...

Iterator	find (const KEYTYPE &key)
	Gets an iterator at a record. More...

ConstIterator	find (const KEYTYPE &key) const
	Gets an iterator at a record. More...

VALUETYPE &	operator[] (const KEYTYPE &key)
	Refers to a record. More...

std::pair< Iterator, bool >	insert (const Record &record)
	Insert a record without overwriting an existing record. More...

size_t	erase (const KEYTYPE &key)
	Removes a record. More...

Record &	front ()
	Gets the reference of the first record. More...

const Record &	front () const
	Gets the reference of the first record. More...

Record &	back ()
	Gets the reference of the last record. More...

const Record &	back () const
	Gets the reference of the last record. More...

void	rehash (size_t num_buckets)
	Rehashes all records to a new number of records. More...

float	load_factor () const
	Gets average number of elements per bucket. More...

Static Public Attributes
static constexpr size_t	DEFAULT_NUM_BUCKETS = 101
	The default value of the number of buckets. More...

Detailed Description

template<typename KEYTYPE, typename VALUETYPE, typename HASHTYPE = std::hash<KEYTYPE>, typename EQUALTOTYPE = std::equal_to<KEYTYPE>>
class tkrzw::LinkedHashMap< KEYTYPE, VALUETYPE, HASHTYPE, EQUALTOTYPE >

Doubly-linked hash map.

Parameters

KEYTYPE	the key type.
VALUETYPE	the value type.
HASHTYPE	the hash functor.
EQUALTOTYPE	the equality checking functor.

Member Enumeration Documentation

◆ MoveMode

template<typename KEYTYPE , typename VALUETYPE , typename HASHTYPE = std::hash<KEYTYPE>, typename EQUALTOTYPE = std::equal_to<KEYTYPE>>

enum tkrzw::LinkedHashMap::MoveMode : int32_t

Enumeration for move modes.

Enumerator
MOVE_CURRENT	To keep the current position.
MOVE_FIRST	To move to the first.
MOVE_LAST	To move to the last.

Constructor & Destructor Documentation

◆ LinkedHashMap() [1/3]

template<typename KEYTYPE , typename VALUETYPE , typename HASHTYPE , typename EQUALTOTYPE >

tkrzw::LinkedHashMap< KEYTYPE, VALUETYPE, HASHTYPE, EQUALTOTYPE >::LinkedHashMap

Default constructor.

◆ LinkedHashMap() [2/3]

template<typename KEYTYPE , typename VALUETYPE , typename HASHTYPE , typename EQUALTOTYPE >

tkrzw::LinkedHashMap< KEYTYPE, VALUETYPE, HASHTYPE, EQUALTOTYPE >::LinkedHashMap ( size_t num_buckets )

explicit

Constructor.

Parameters

num_buckets The number of buckets of the hash table.

◆ ~LinkedHashMap()

template<typename KEYTYPE , typename VALUETYPE , typename HASHTYPE , typename EQUALTOTYPE >

tkrzw::LinkedHashMap< KEYTYPE, VALUETYPE, HASHTYPE, EQUALTOTYPE >::~LinkedHashMap

Destructor.

◆ LinkedHashMap() [3/3]

template<typename KEYTYPE , typename VALUETYPE , typename HASHTYPE = std::hash<KEYTYPE>, typename EQUALTOTYPE = std::equal_to<KEYTYPE>>

tkrzw::LinkedHashMap< KEYTYPE, VALUETYPE, HASHTYPE, EQUALTOTYPE >::LinkedHashMap ( const LinkedHashMap< KEYTYPE, VALUETYPE, HASHTYPE, EQUALTOTYPE > & rhs )

explicitdelete

Copy and assignment are disabled.

Member Function Documentation

◆ Get()

template<typename KEYTYPE , typename VALUETYPE , typename HASHTYPE , typename EQUALTOTYPE >

LinkedHashMap< KEYTYPE, VALUETYPE, HASHTYPE, EQUALTOTYPE >::Record * tkrzw::LinkedHashMap< KEYTYPE, VALUETYPE, HASHTYPE, EQUALTOTYPE >::Get	(	const KEYTYPE &	key,
		MoveMode	mode = `MOVE_CURRENT`
	)

Retrieves a record.

Parameters

key	The key.
mode	The moving mode.

Returns: The pointer to the corresponding record, or nullptr on failure.

◆ GetSimple()

template<typename KEYTYPE , typename VALUETYPE , typename HASHTYPE , typename EQUALTOTYPE >

VALUETYPE tkrzw::LinkedHashMap< KEYTYPE, VALUETYPE, HASHTYPE, EQUALTOTYPE >::GetSimple	(	const KEYTYPE &	key,
		VALUETYPE	default_value = `VALUETYPE()`,
		MoveMode	mode = `MOVE_CURRENT`
	)

Retrieves a record.

Parameters

key	The key.
default_value	The value to be returned on failure.
mode	The moving mode.

Returns: The value of the record or the default value on failure.

◆ Set()

template<typename KEYTYPE , typename VALUETYPE , typename HASHTYPE , typename EQUALTOTYPE >

LinkedHashMap< KEYTYPE, VALUETYPE, HASHTYPE, EQUALTOTYPE >::Record * tkrzw::LinkedHashMap< KEYTYPE, VALUETYPE, HASHTYPE, EQUALTOTYPE >::Set	(	const KEYTYPE &	key,
		const VALUETYPE &	value,
		bool	overwrite = `true`,
		MoveMode	mode = `MOVE_CURRENT`
	)

Stores a record.

Parameters

key	The key.
value	The value.
mode	The moving mode.
overwrite	Whether to overwrite the existing value.

Returns: The pointer to the stored record or the existing record.

◆ Remove()

template<typename KEYTYPE , typename VALUETYPE , typename HASHTYPE , typename EQUALTOTYPE >

bool tkrzw::LinkedHashMap< KEYTYPE, VALUETYPE, HASHTYPE, EQUALTOTYPE >::Remove ( const KEYTYPE & key )

Removes a record.

Parameters

key The key.

Returns: True on success, or false on failure.

◆ Migrate()

template<typename KEYTYPE , typename VALUETYPE , typename HASHTYPE , typename EQUALTOTYPE >

LinkedHashMap< KEYTYPE, VALUETYPE, HASHTYPE, EQUALTOTYPE >::Record * tkrzw::LinkedHashMap< KEYTYPE, VALUETYPE, HASHTYPE, EQUALTOTYPE >::Migrate	(	const KEYTYPE &	key,
		LinkedHashMap< KEYTYPE, VALUETYPE, HASHTYPE, EQUALTOTYPE > *	dest,
		MoveMode	mode
	)

Migrates a record to another map.

Parameters

key	The key.
dest	The destination map.
mode	The moving mode.

Returns: The pointer to the migrated record, or nullptr on failure.

◆ clear()

template<typename KEYTYPE , typename VALUETYPE , typename HASHTYPE , typename EQUALTOTYPE >

void tkrzw::LinkedHashMap< KEYTYPE, VALUETYPE, HASHTYPE, EQUALTOTYPE >::clear

Removes all records.

◆ size()

template<typename KEYTYPE , typename VALUETYPE , typename HASHTYPE , typename EQUALTOTYPE >

size_t tkrzw::LinkedHashMap< KEYTYPE, VALUETYPE, HASHTYPE, EQUALTOTYPE >::size

Gets the number of records.

Returns: The number of records.

◆ empty()

template<typename KEYTYPE , typename VALUETYPE , typename HASHTYPE , typename EQUALTOTYPE >

bool tkrzw::LinkedHashMap< KEYTYPE, VALUETYPE, HASHTYPE, EQUALTOTYPE >::empty

Checks whether no records exist.

Returns: True if there's no record or false if there are one or more records.

◆ begin() [1/2]

template<typename KEYTYPE , typename VALUETYPE , typename HASHTYPE , typename EQUALTOTYPE >

LinkedHashMap< KEYTYPE, VALUETYPE, HASHTYPE, EQUALTOTYPE >::Iterator tkrzw::LinkedHashMap< KEYTYPE, VALUETYPE, HASHTYPE, EQUALTOTYPE >::begin

Gets an iterator at the first record.

Returns: The iterator at the first record.

◆ begin() [2/2]

template<typename KEYTYPE , typename VALUETYPE , typename HASHTYPE , typename EQUALTOTYPE >

LinkedHashMap< KEYTYPE, VALUETYPE, HASHTYPE, EQUALTOTYPE >::ConstIterator tkrzw::LinkedHashMap< KEYTYPE, VALUETYPE, HASHTYPE, EQUALTOTYPE >::begin

Gets a const iterator at the first record.

Returns: The const iterator at the first record.

◆ end() [1/2]

template<typename KEYTYPE , typename VALUETYPE , typename HASHTYPE , typename EQUALTOTYPE >

LinkedHashMap< KEYTYPE, VALUETYPE, HASHTYPE, EQUALTOTYPE >::Iterator tkrzw::LinkedHashMap< KEYTYPE, VALUETYPE, HASHTYPE, EQUALTOTYPE >::end

Gets an iterator of the end sentry.

Returns: The iterator at the end sentry.

◆ end() [2/2]

template<typename KEYTYPE , typename VALUETYPE , typename HASHTYPE , typename EQUALTOTYPE >

LinkedHashMap< KEYTYPE, VALUETYPE, HASHTYPE, EQUALTOTYPE >::ConstIterator tkrzw::LinkedHashMap< KEYTYPE, VALUETYPE, HASHTYPE, EQUALTOTYPE >::end

Gets a const iterator of the end sentry.

Returns: The const iterator at the end sentry.

◆ find() [1/2]

template<typename KEYTYPE , typename VALUETYPE , typename HASHTYPE , typename EQUALTOTYPE >

LinkedHashMap< KEYTYPE, VALUETYPE, HASHTYPE, EQUALTOTYPE >::Iterator tkrzw::LinkedHashMap< KEYTYPE, VALUETYPE, HASHTYPE, EQUALTOTYPE >::find ( const KEYTYPE & key )

Gets an iterator at a record.

Parameters

key	The key of the record to find.

Returns: The pointer to the value of the corresponding record, or nullptr on failure.

◆ find() [2/2]

template<typename KEYTYPE , typename VALUETYPE , typename HASHTYPE , typename EQUALTOTYPE >

LinkedHashMap< KEYTYPE, VALUETYPE, HASHTYPE, EQUALTOTYPE >::ConstIterator tkrzw::LinkedHashMap< KEYTYPE, VALUETYPE, HASHTYPE, EQUALTOTYPE >::find ( const KEYTYPE & key ) const

Gets an iterator at a record.

Parameters

key	The key of the record to find.

Returns: The pointer to the value of the corresponding record, or nullptr on failure.

◆ operator[]()

template<typename KEYTYPE , typename VALUETYPE , typename HASHTYPE , typename EQUALTOTYPE >

VALUETYPE & tkrzw::LinkedHashMap< KEYTYPE, VALUETYPE, HASHTYPE, EQUALTOTYPE >::operator[] ( const KEYTYPE & key )

Refers to a record.

Parameters

key	The key of the record to find.

Returns: The reference to the record.

If there's no matching record. a new record is created.

◆ insert()

template<typename KEYTYPE , typename VALUETYPE , typename HASHTYPE , typename EQUALTOTYPE >

std::pair< typename LinkedHashMap< KEYTYPE, VALUETYPE, HASHTYPE, EQUALTOTYPE >::Iterator, bool > tkrzw::LinkedHashMap< KEYTYPE, VALUETYPE, HASHTYPE, EQUALTOTYPE >::insert ( const Record & record )

Insert a record without overwriting an existing record.

Parameters

record The record to insert.

Returns: A pair. The first element is an iterator to the inserted or existing element. The second element is a boolean of whether the insertion is successful.

◆ erase()

template<typename KEYTYPE , typename VALUETYPE , typename HASHTYPE , typename EQUALTOTYPE >

size_t tkrzw::LinkedHashMap< KEYTYPE, VALUETYPE, HASHTYPE, EQUALTOTYPE >::erase ( const KEYTYPE & key )

Removes a record.

Parameters

key The key.

Returns: 1 on success or 0 if there's no matching key.

◆ front() [1/2]

template<typename KEYTYPE , typename VALUETYPE , typename HASHTYPE , typename EQUALTOTYPE >

LinkedHashMap< KEYTYPE, VALUETYPE, HASHTYPE, EQUALTOTYPE >::Record & tkrzw::LinkedHashMap< KEYTYPE, VALUETYPE, HASHTYPE, EQUALTOTYPE >::front

Gets the reference of the first record.

Returns: The reference of the first record.

◆ front() [2/2]

template<typename KEYTYPE , typename VALUETYPE , typename HASHTYPE , typename EQUALTOTYPE >

const LinkedHashMap< KEYTYPE, VALUETYPE, HASHTYPE, EQUALTOTYPE >::Record & tkrzw::LinkedHashMap< KEYTYPE, VALUETYPE, HASHTYPE, EQUALTOTYPE >::front

Gets the reference of the first record.

Returns: The reference of the first record.

◆ back() [1/2]

template<typename KEYTYPE , typename VALUETYPE , typename HASHTYPE , typename EQUALTOTYPE >

LinkedHashMap< KEYTYPE, VALUETYPE, HASHTYPE, EQUALTOTYPE >::Record & tkrzw::LinkedHashMap< KEYTYPE, VALUETYPE, HASHTYPE, EQUALTOTYPE >::back

Gets the reference of the last record.

Returns: The reference of the last record.

◆ back() [2/2]

template<typename KEYTYPE , typename VALUETYPE , typename HASHTYPE , typename EQUALTOTYPE >

const LinkedHashMap< KEYTYPE, VALUETYPE, HASHTYPE, EQUALTOTYPE >::Record & tkrzw::LinkedHashMap< KEYTYPE, VALUETYPE, HASHTYPE, EQUALTOTYPE >::back

Gets the reference of the last record.

Returns: The reference of the last record.

◆ rehash()

template<typename KEYTYPE , typename VALUETYPE , typename HASHTYPE , typename EQUALTOTYPE >

void tkrzw::LinkedHashMap< KEYTYPE, VALUETYPE, HASHTYPE, EQUALTOTYPE >::rehash ( size_t num_buckets )

Rehashes all records to a new number of records.

Parameters

num_buckets The new number of buckets.

◆ load_factor()

template<typename KEYTYPE , typename VALUETYPE , typename HASHTYPE , typename EQUALTOTYPE >

float tkrzw::LinkedHashMap< KEYTYPE, VALUETYPE, HASHTYPE, EQUALTOTYPE >::load_factor

Gets average number of elements per bucket.

Returns: The average number of elements per bucket.

Member Data Documentation

◆ DEFAULT_NUM_BUCKETS

template<typename KEYTYPE , typename VALUETYPE , typename HASHTYPE = std::hash<KEYTYPE>, typename EQUALTOTYPE = std::equal_to<KEYTYPE>>

constexpr size_t tkrzw::LinkedHashMap< KEYTYPE, VALUETYPE, HASHTYPE, EQUALTOTYPE >::DEFAULT_NUM_BUCKETS = 101

staticconstexpr

The default value of the number of buckets.

Classes

Public Types

Public Member Functions

Static Public Attributes

Detailed Description

template<typename KEYTYPE, typename VALUETYPE, typename HASHTYPE = std::hash<KEYTYPE>, typename EQUALTOTYPE = std::equal_to<KEYTYPE>> class tkrzw::LinkedHashMap< KEYTYPE, VALUETYPE, HASHTYPE, EQUALTOTYPE >

Member Enumeration Documentation

◆ MoveMode

Constructor & Destructor Documentation

◆ LinkedHashMap() [1/3]

◆ LinkedHashMap() [2/3]

◆ ~LinkedHashMap()

◆ LinkedHashMap() [3/3]

Member Function Documentation

◆ Get()

◆ GetSimple()

◆ Set()

◆ Remove()

◆ Migrate()

◆ clear()

◆ size()

◆ empty()

◆ begin() [1/2]

◆ begin() [2/2]

◆ end() [1/2]

◆ end() [2/2]

◆ find() [1/2]

◆ find() [2/2]

◆ operator[]()

◆ insert()

◆ erase()

◆ front() [1/2]

◆ front() [2/2]

◆ back() [1/2]

◆ back() [2/2]

◆ rehash()

◆ load_factor()

Member Data Documentation

◆ DEFAULT_NUM_BUCKETS

template<typename KEYTYPE, typename VALUETYPE, typename HASHTYPE = std::hash<KEYTYPE>, typename EQUALTOTYPE = std::equal_to<KEYTYPE>>
class tkrzw::LinkedHashMap< KEYTYPE, VALUETYPE, HASHTYPE, EQUALTOTYPE >