Detailed Description

hash table that resolves conflicts by queueing, thereby allowing for duplicate entries

Functions
int	SCIPcalcMultihashSize (int minsize)
SCIP_RETCODE	SCIPmultihashCreate (SCIP_MULTIHASH *multihash, BMS_BLKMEM blkmem, int tablesize, SCIP_DECL_HASHGETKEY((hashgetkey)), SCIP_DECL_HASHKEYEQ((hashkeyeq)), SCIP_DECL_HASHKEYVAL((hashkeyval)), void userptr)
void	SCIPmultihashFree (SCIP_MULTIHASH **multihash)
SCIP_RETCODE	SCIPmultihashInsert (SCIP_MULTIHASH multihash, void element)
SCIP_RETCODE	SCIPmultihashSafeInsert (SCIP_MULTIHASH multihash, void element)
void *	SCIPmultihashRetrieve (SCIP_MULTIHASH multihash, void key)
void *	SCIPmultihashRetrieveNext (SCIP_MULTIHASH multihash, SCIP_MULTIHASHLIST multihashlist, void key)
SCIP_Bool	SCIPmultihashExists (SCIP_MULTIHASH multihash, void element)
SCIP_RETCODE	SCIPmultihashRemove (SCIP_MULTIHASH multihash, void element)
void	SCIPmultihashRemoveAll (SCIP_MULTIHASH *multihash)
SCIP_Longint	SCIPmultihashGetNElements (SCIP_MULTIHASH *multihash)
SCIP_Real	SCIPmultihashGetLoad (SCIP_MULTIHASH *multihash)
void	SCIPmultihashPrintStatistics (SCIP_MULTIHASH multihash, SCIP_MESSAGEHDLR messagehdlr)
	SCIP_DECL_HASHKEYEQ (SCIPhashKeyEqString)
	SCIP_DECL_HASHKEYVAL (SCIPhashKeyValString)
	SCIP_DECL_HASHGETKEY (SCIPhashGetKeyStandard)
	SCIP_DECL_HASHKEYEQ (SCIPhashKeyEqPtr)
	SCIP_DECL_HASHKEYVAL (SCIPhashKeyValPtr)

Function Documentation

◆ SCIPcalcMultihashSize()

int SCIPcalcMultihashSize ( int minsize )

returns a reasonable hash table size (a prime number) that is at least as large as the specified value

Parameters

minsize minimal size of the hash table

Definition at line 1639 of file misc.c.

References assert(), primetable, primetablesize, SCIPcalcMultihashSize(), and SCIPsortedvecFindInt().

Referenced by SCIPcalcMultihashSize().

◆ SCIPmultihashCreate()

SCIP_RETCODE SCIPmultihashCreate	(	SCIP_MULTIHASH **	multihash,
		BMS_BLKMEM *	blkmem,
		int	tablesize,
		SCIP_DECL_HASHGETKEY((*hashgetkey))	,
		SCIP_DECL_HASHKEYEQ((*hashkeyeq))	,
		SCIP_DECL_HASHKEYVAL((*hashkeyval))	,
		void *	userptr )

creates a multihash table

Parameters

multihash	pointer to store the created multihash table
blkmem	block memory used to store multihash table entries
tablesize	size of the hash table
-	gets the key of the given element
-	returns TRUE iff both keys are equal
-	returns the hash value of the key
userptr	user pointer

Definition at line 1962 of file misc.c.

References assert(), BMSallocBlockMemory, BMSallocClearBlockMemoryArray, NULL, SCIP_ALLOC, SCIP_DECL_HASHGETKEY, SCIP_DECL_HASHKEYEQ, SCIP_DECL_HASHKEYVAL, SCIP_OKAY, and SCIPmultihashCreate().

Referenced by SCIPmultihashCreate(), and SCIPreplaceCommonSubexpressions().

◆ SCIPmultihashFree()

void SCIPmultihashFree ( SCIP_MULTIHASH ** multihash )

frees the multihash table

Parameters

multihash pointer to the multihash table

Definition at line 1995 of file misc.c.

References assert(), SCIP_MultiHash::blkmem, BMSfreeBlockMemory, BMSfreeBlockMemoryArray, i, SCIP_MultiHash::lists, multihashlistFree(), SCIP_MultiHash::nlists, NULL, and SCIPmultihashFree().

Referenced by SCIPmultihashFree(), and SCIPreplaceCommonSubexpressions().

◆ SCIPmultihashInsert()

SCIP_RETCODE SCIPmultihashInsert	(	SCIP_MULTIHASH *	multihash,
		void *	element )

inserts element in multihash table (multiple inserts of same element possible)

Note: A pointer to a multihashlist returned by SCIPmultihashRetrieveNext() might get invalid when adding an element to the hash table, due to dynamic resizing.

Parameters

multihash	multihash table
element	element to insert into the table

Definition at line 2026 of file misc.c.

References assert(), SCIP_MultiHash::blkmem, SCIP_MultiHash::lists, multihashlistAppend(), multihashResize(), SCIP_MultiHash::nelements, SCIP_MultiHash::nlists, NULL, SCIP_CALL, SCIP_MULTIHASH_RESIZE_PERCENTAGE, SCIP_OKAY, SCIPmultihashGetLoad(), SCIPmultihashInsert(), and SCIP_MultiHash::userptr.

Referenced by findEqualExpr(), SCIPmultihashInsert(), and SCIPmultihashSafeInsert().

◆ SCIPmultihashSafeInsert()

SCIP_RETCODE SCIPmultihashSafeInsert	(	SCIP_MULTIHASH *	multihash,
		void *	element )

inserts element in multihash table (multiple insertion of same element is checked and results in an error)

Note: A pointer to a multihashlist returned by SCIPmultihashRetrieveNext() might get invalid when adding a new element to the multihash table, due to dynamic resizing.

Parameters

multihash	multihash table
element	element to insert into the table

Definition at line 2067 of file misc.c.

References assert(), NULL, SCIP_CALL, SCIP_KEYALREADYEXISTING, SCIP_OKAY, SCIPmultihashInsert(), SCIPmultihashRetrieve(), SCIPmultihashSafeInsert(), and SCIP_MultiHash::userptr.

Referenced by SCIPmultihashSafeInsert().

◆ SCIPmultihashRetrieve()

void * SCIPmultihashRetrieve	(	SCIP_MULTIHASH *	multihash,
		void *	key )

retrieve element with key from multihash table, returns NULL if not existing

Parameters

multihash	multihash table
key	key to retrieve

Definition at line 2086 of file misc.c.

References assert(), SCIP_MultiHash::lists, multihashlistRetrieve(), SCIP_MultiHash::nlists, NULL, SCIPmultihashRetrieve(), and SCIP_MultiHash::userptr.

Referenced by SCIPmultihashRetrieve(), and SCIPmultihashSafeInsert().

◆ SCIPmultihashRetrieveNext()

void * SCIPmultihashRetrieveNext	(	SCIP_MULTIHASH *	multihash,
		SCIP_MULTIHASHLIST **	multihashlist,
		void *	key )

retrieve element with key from multihash table, returns NULL if not existing can be used to retrieve all entries with the same key (one-by-one)

Note: The returned multimultihashlist pointer might get invalid when adding a new element to the multihash table.

Parameters

multihash	multihash table
multihashlist	input: entry in hash table list from which to start searching, or NULL output: entry in hash table list corresponding to element after retrieved one, or NULL
key	key to retrieve

Definition at line 2115 of file misc.c.

References assert(), SCIP_MultiHash::lists, multihashlistRetrieveNext(), SCIP_MultiHash::nlists, NULL, SCIPmultihashRetrieveNext(), and SCIP_MultiHash::userptr.

Referenced by findEqualExpr(), and SCIPmultihashRetrieveNext().

◆ SCIPmultihashExists()

SCIP_Bool SCIPmultihashExists	(	SCIP_MULTIHASH *	multihash,
		void *	element )

returns whether the given element exists in the multihash table

Parameters

multihash	multihash table
element	element to search in the table

Definition at line 2151 of file misc.c.

References assert(), SCIP_MultiHash::lists, multihashlistFind(), SCIP_MultiHash::nlists, NULL, SCIP_Bool, SCIPmultihashExists(), and SCIP_MultiHash::userptr.

Referenced by SCIPmultihashExists().

◆ SCIPmultihashRemove()

SCIP_RETCODE SCIPmultihashRemove	(	SCIP_MULTIHASH *	multihash,
		void *	element )

removes element from the multihash table, if it exists

Parameters

multihash	multihash table
element	element to remove from the table

Definition at line 2178 of file misc.c.

References assert(), SCIP_MultiHash::blkmem, SCIP_MultiHash::lists, multihashlistRemove(), SCIP_MultiHash::nelements, SCIP_MultiHash::nlists, NULL, SCIP_OKAY, SCIPmultihashRemove(), and SCIP_MultiHash::userptr.

Referenced by SCIPmultihashRemove().

◆ SCIPmultihashRemoveAll()

void SCIPmultihashRemoveAll ( SCIP_MULTIHASH * multihash )

removes all elements of the multihash table

Note: From a performance point of view you should not fill and clear a hash table too often since the clearing can be expensive. Clearing is done by looping over all buckets and removing the hash table lists one-by-one.

Parameters

multihash multihash table

Definition at line 2212 of file misc.c.

References assert(), SCIP_MultiHash::blkmem, i, SCIP_MultiHash::lists, multihashlistFree(), SCIP_MultiHash::nelements, SCIP_MultiHash::nlists, NULL, and SCIPmultihashRemoveAll().

Referenced by multihashResize(), and SCIPmultihashRemoveAll().