Scippy

SCIP

Solving Constraint Integer Programs

Detailed Description

hash table that resolves conflicts by probing

Macros

#define SCIPhashSignature64(a)   ((uint64_t)(UINT64_C(1) << ((a) % 64)))
 
#define SCIPhashTwo(a, b)   ((uint32_t)((((uint64_t)(a) + 0xd37e9a1ce2148403ULL) * ((uint64_t)(b) + 0xe5fcc163aef32782ULL) )>>32))
 
#define SCIPhashFour(a, b, c, d)
 
#define SCIPcombineTwoInt(a, b)   (((uint64_t) (a) << 32) | (uint64_t) (b) )
 
#define SCIPcombineThreeInt(a, b, c)   (((uint64_t) (a) << 43) + ((uint64_t) (b) << 21) + ((uint64_t) (c)) )
 
#define SCIPcombineFourInt(a, b, c, d)   (((uint64_t) (a) << 48) + ((uint64_t) (b) << 32) + ((uint64_t) (c) << 16) + ((uint64_t) (d)) )
 
#define SCIPrealHashCode(x, n)   ( (x)*(1<<n) >= INT64_MAX ? INT64_MAX : ((x)*(1<<n) <= INT64_MIN ? INT64_MIN : (int64_t)((x)*(1<<n))) )
 
#define SCIPpositiveRealHashCode(x, n)   ( (x)*(1<<n) >= UINT64_MAX ? UINT64_MAX : (uint64_t)((x)*(1<<n)) )
 

Functions

SCIP_RETCODE SCIPhashtableCreate (SCIP_HASHTABLE **hashtable, BMS_BLKMEM *blkmem, int tablesize, SCIP_DECL_HASHGETKEY((*hashgetkey)), SCIP_DECL_HASHKEYEQ((*hashkeyeq)), SCIP_DECL_HASHKEYVAL((*hashkeyval)), void *userptr)
 
void SCIPhashtableFree (SCIP_HASHTABLE **hashtable)
 
void SCIPhashtableClear (SCIP_HASHTABLE *hashtable)
 
SCIP_RETCODE SCIPhashtableInsert (SCIP_HASHTABLE *hashtable, void *element)
 
SCIP_RETCODE SCIPhashtableSafeInsert (SCIP_HASHTABLE *hashtable, void *element)
 
void * SCIPhashtableRetrieve (SCIP_HASHTABLE *hashtable, void *key)
 
SCIP_Bool SCIPhashtableExists (SCIP_HASHTABLE *hashtable, void *element)
 
SCIP_RETCODE SCIPhashtableRemove (SCIP_HASHTABLE *hashtable, void *element)
 
void SCIPhashtableRemoveAll (SCIP_HASHTABLE *hashtable)
 
SCIP_Longint SCIPhashtableGetNElements (SCIP_HASHTABLE *hashtable)
 
SCIP_Real SCIPhashtableGetLoad (SCIP_HASHTABLE *hashtable)
 
void SCIPhashtablePrintStatistics (SCIP_HASHTABLE *hashtable, SCIP_MESSAGEHDLR *messagehdlr)
 

Macro Definition Documentation

◆ SCIPhashSignature64

#define SCIPhashSignature64 (   a)    ((uint64_t)(UINT64_C(1) << ((a) % 64)))

Definition at line 470 of file pub_misc.h.

Referenced by consdataGetFeasibility().

◆ SCIPhashTwo

#define SCIPhashTwo (   a,
 
)    ((uint32_t)((((uint64_t)(a) + 0xd37e9a1ce2148403ULL) * ((uint64_t)(b) + 0xe5fcc163aef32782ULL) )>>32))

Definition at line 471 of file pub_misc.h.

Referenced by randomInitialize(), and SCIP_DECL_HASHKEYVAL().

◆ SCIPhashFour

#define SCIPhashFour (   a,
  b,
  c,
 
)
Value:
((uint32_t)((((uint64_t)(a) + 0xbd5c89185f082658ULL) * ((uint64_t)(b) + 0xe5fcc163aef32782ULL) + \
((uint64_t)(c) + 0xd37e9a1ce2148403ULL) * ((uint64_t)(d) + 0x926f2d4dc4a67218ULL))>>32 ))

Definition at line 473 of file pub_misc.h.

Referenced by SCIP_DECL_HASHKEYVAL().

◆ SCIPcombineTwoInt

#define SCIPcombineTwoInt (   a,
 
)    (((uint64_t) (a) << 32) | (uint64_t) (b) )

Definition at line 477 of file pub_misc.h.

Referenced by SCIP_DECL_HASHKEYVAL().

◆ SCIPcombineThreeInt

#define SCIPcombineThreeInt (   a,
  b,
 
)    (((uint64_t) (a) << 43) + ((uint64_t) (b) << 21) + ((uint64_t) (c)) )

Definition at line 479 of file pub_misc.h.

Referenced by SCIP_DECL_HASHKEYVAL().

◆ SCIPcombineFourInt

#define SCIPcombineFourInt (   a,
  b,
  c,
 
)    (((uint64_t) (a) << 48) + ((uint64_t) (b) << 32) + ((uint64_t) (c) << 16) + ((uint64_t) (d)) )

Definition at line 481 of file pub_misc.h.

◆ SCIPrealHashCode

#define SCIPrealHashCode (   x,
 
)    ( (x)*(1<<n) >= INT64_MAX ? INT64_MAX : ((x)*(1<<n) <= INT64_MIN ? INT64_MIN : (int64_t)((x)*(1<<n))) )

Definition at line 484 of file pub_misc.h.

◆ SCIPpositiveRealHashCode

#define SCIPpositiveRealHashCode (   x,
 
)    ( (x)*(1<<n) >= UINT64_MAX ? UINT64_MAX : (uint64_t)((x)*(1<<n)) )

Definition at line 486 of file pub_misc.h.

Referenced by SCIP_DECL_HASHKEYVAL().

Function Documentation

◆ SCIPhashtableCreate()

SCIP_RETCODE SCIPhashtableCreate ( SCIP_HASHTABLE **  hashtable,
BMS_BLKMEM blkmem,
int  tablesize,
SCIP_DECL_HASHGETKEY((*hashgetkey))  ,
SCIP_DECL_HASHKEYEQ((*hashkeyeq))  ,
SCIP_DECL_HASHKEYVAL((*hashkeyval))  ,
void *  userptr 
)

◆ SCIPhashtableFree()

◆ SCIPhashtableClear()

void SCIPhashtableClear ( SCIP_HASHTABLE hashtable)

removes all elements of the hash 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.
Deprecated:
Please use SCIPhashtableRemoveAll()

removes all elements of the hash 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.
Deprecated:
Please use SCIPhashtableRemoveAll()
Parameters
hashtablehash table

Definition at line 2117 of file misc.c.

References SCIPhashtableRemoveAll().

◆ SCIPhashtableInsert()

◆ SCIPhashtableSafeInsert()

SCIP_RETCODE SCIPhashtableSafeInsert ( SCIP_HASHTABLE hashtable,
void *  element 
)

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

inserts element in hash table

Note
multiple insertion of same element is checked and results in an error
Parameters
hashtablehash table
elementelement to insert into the table

Definition at line 2286 of file misc.c.

References FALSE, SCIP_HashTable::hashes, hashtableCheckLoad(), hashtableInsert(), hashvalue(), SCIP_HashTable::mask, NULL, SCIP_CALL, SCIP_HashTable::slots, and SCIP_HashTable::userptr.

Referenced by paramsetAdd().

◆ SCIPhashtableRetrieve()

void* SCIPhashtableRetrieve ( SCIP_HASHTABLE hashtable,
void *  key 
)

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

Parameters
hashtablehash table
keykey to retrieve

Definition at line 2315 of file misc.c.

References ELEM_DISTANCE, SCIP_HashTable::hashes, hashvalue(), SCIP_HashTable::mask, NULL, SCIP_HashTable::shift, SCIP_HashTable::slots, TRUE, and SCIP_HashTable::userptr.

Referenced by applyVariableAssignment(), consdataFree(), CREATE_CONSTRAINT(), createAndAddAndCons(), createConstantAssignment(), createLinking(), createVariable(), detectRedundantConstraints(), exprparseReadVariable(), extractGates(), nodepairqueueCreate(), paramSetBool(), paramSetChar(), paramSetInt(), paramSetLongint(), paramsetParse(), paramSetReal(), paramsetSetHeuristicsAggressive(), paramsetSetHeuristicsFast(), paramsetSetPresolvingAggressive(), paramsetSetPresolvingFast(), paramsetSetSeparatingAggressive(), paramsetSetSeparatingDefault(), parseAggregation(), parseArrayIndex(), parseConstraint(), parseQuadratic(), parseSolveItem(), parseValue(), parseVariableArrayAssignment(), SCIPcliquetableAdd(), SCIPcliquetableCleanup(), SCIPcreateConsPseudobooleanWithConss(), SCIPcutpoolAddRow(), SCIPcutpoolDelRow(), SCIPhashtableExists(), SCIPparamsetCopyParams(), SCIPparamsetFix(), SCIPparamsetGetBool(), SCIPparamsetGetChar(), SCIPparamsetGetInt(), SCIPparamsetGetLongint(), SCIPparamsetGetParam(), SCIPparamsetGetReal(), SCIPparamsetGetString(), SCIPparamsetIsFixed(), SCIPparamsetSet(), SCIPparamsetSetBool(), SCIPparamsetSetChar(), SCIPparamsetSetDefaultBool(), SCIPparamsetSetDefaultInt(), SCIPparamsetSetEmphasis(), SCIPparamsetSetInt(), SCIPparamsetSetLongint(), SCIPparamsetSetReal(), SCIPparamsetSetString(), SCIPparamsetSetToDefault(), SCIPprobFindCons(), SCIPprobFindVar(), SCIPprobRemoveConsName(), and transformToOrig().

◆ SCIPhashtableExists()

◆ SCIPhashtableRemove()

SCIP_RETCODE SCIPhashtableRemove ( SCIP_HASHTABLE hashtable,
void *  element 
)

◆ SCIPhashtableRemoveAll()

void SCIPhashtableRemoveAll ( SCIP_HASHTABLE hashtable)

removes all elements of the hash table

Parameters
hashtablehash table

Definition at line 2462 of file misc.c.

References BMSclearMemoryArray, SCIP_HashTable::hashes, SCIP_HashTable::mask, SCIP_HashTable::nelements, and NULL.

Referenced by correctPresoldata(), resolvePropagation(), SCIPhashtableClear(), and variablegraphBreadthFirst().

◆ SCIPhashtableGetNElements()

SCIP_Longint SCIPhashtableGetNElements ( SCIP_HASHTABLE hashtable)

returns number of hash table elements

Parameters
hashtablehash table

Definition at line 2474 of file misc.c.

References SCIP_HashTable::nelements, and NULL.

◆ SCIPhashtableGetLoad()

SCIP_Real SCIPhashtableGetLoad ( SCIP_HASHTABLE hashtable)

returns the load of the given hash table in percentage

Parameters
hashtablehash table

Definition at line 2484 of file misc.c.

References SCIP_HashTable::mask, SCIP_HashTable::nelements, NULL, and SCIP_Real.

◆ SCIPhashtablePrintStatistics()

void SCIPhashtablePrintStatistics ( SCIP_HASHTABLE hashtable,
SCIP_MESSAGEHDLR messagehdlr 
)

prints statistics about hash table usage

Parameters
hashtablehash table
messagehdlrmessage handler

Definition at line 2494 of file misc.c.

References ELEM_DISTANCE, SCIP_HashTable::hashes, SCIP_HashTable::mask, MAX, SCIP_HashTable::nelements, NULL, SCIP_Real, and SCIPmessagePrintInfo().