include/complib/cl_qmap.h

62 *	structures.  Each item stored in a quick map has a unique 64-bit key
64 *	efficiently search for an item given a key.
148 	uint64_t key;
175 *	key
431 *	The cl_qmap_key function retrieves the key value of a map item.
438 	return (p_item->key);
444 *		[in] Pointer to a map item whose key value to return.
447 *	Returns the 64-bit key value for the specified map item.
450 *	The key value is set in a call to cl_qmap_insert.
523 *	The cl_qmap_head function returns the map item with the lowest key
539 *		key is returned.
542 *	Pointer to the map item with the lowest key in the quick map.
559 *	The cl_qmap_tail function returns the map item with the highest key
575 *		highest key is returned.
578 *	Pointer to the map item with the highest key in the quick map.
596 *	key value than a specified map item.
612 *	Pointer to the map item with the next higher key value in a quick map.
628 *	key value than a precified map item.
644 *	Pointer to the map item with the next lower key value in a quick map.
660 *  NOTE: Only if such a key does not alerady exist in the map !!!!
665 			      IN const uint64_t key,
672 *	key
679 *	Pointer to the item in the map with the specified key.  If insertion
681 *	specified key already exists in the map, the pointer to that item is
682 *	returned - but the new key is NOT inserted...
696 *	The cl_qmap_get function returns the map item associated with a key.
701 			   IN const uint64_t key);
706 *		item with the specified key.
708 *	key
712 *	Pointer to the map item with the desired key value.
714 *	Pointer to the map end if there was no item with the desired key value
730 *	key > the key specified.
735 				IN const uint64_t key);
740 *		first item with a key > the specified key.
742 *	key
746 *	Pointer to the first map item with a key > the desired key value.
748 *	Pointer to the map end if there was no item with a key > the desired key
794 *	The cl_qmap_remove function removes the map item with the specified key
800 			      IN const uint64_t key);
805 *		with the specified key.
807 *	key
813 *	Pointer to the map end if no item with the specified key exists in the