kzc_hash_set_accessors_hpp.inl File Reference

Accessor declarations for hash set. More...

Macros

#define kzcHashSetIteratorPointerGetValue(iterator_param)
 Returns the pointer value of the pointer hash map entry pointed by the iterator. More...
 
#define kzcHashSetIteratorIntGetValue(iterator_param)
 Returns the integer value of the integer hash map entry pointed by the iterator. More...
 
#define kzcHashSetIteratorUintGetValue(iterator_param)
 Returns the unsigned integer value of the unsigned integer hash map entry pointed by the iterator. More...
 
#define kzcHashSetIteratorFloatGetValue(iterator_param)
 Returns the float value of the float hash map entry pointed by the iterator. More...
 

Functions

KANZI_API kzsError kzcHashSetPointerAdd (struct KzcHashSet *hashSet, const void *value)
 Adds the given pointer value to the given pointer hash set. More...
 
KANZI_API kzsError kzcHashSetIntAdd (struct KzcHashSet *hashSet, kzInt value)
 Adds the given integer value to the given integer hash set. More...
 
KANZI_API kzsError kzcHashSetUintAdd (struct KzcHashSet *hashSet, kzUint value)
 Adds the given unsigned integer value to the given unsigned integer hash set. More...
 
KANZI_API kzsError kzcHashSetFloatAdd (struct KzcHashSet *hashSet, kzFloat value)
 Adds the given float value to the given float hash set. More...
 
KANZI_API kzsError kzcHashSetStringAdd (struct KzcHashSet *hashSet, kzString value)
 Adds the given string value to the given string hash set. More...
 
KANZI_API kzsError kzcHashSetCustomAdd (struct KzcHashSet *hashSet, const void *value)
 Adds the given pointer value to the given pointer hash set. More...
 
KANZI_API kzsError kzcHashSetPointerRemove (struct KzcHashSet *hashSet, const void *value)
 Removes the given pointer value from the given pointer hash set. More...
 
KANZI_API kzsError kzcHashSetIntRemove (struct KzcHashSet *hashSet, kzInt value)
 Removes the given integer value from the given integer hash set. More...
 
KANZI_API kzsError kzcHashSetUintRemove (struct KzcHashSet *hashSet, kzUint value)
 Removes the given unsigned integer value from the given unsigned integer hash set. More...
 
KANZI_API kzsError kzcHashSetFloatRemove (struct KzcHashSet *hashSet, kzFloat value)
 Removes the given float value from the given float hash set. More...
 
KANZI_API kzsError kzcHashSetStringRemove (struct KzcHashSet *hashSet, kzString value)
 Removes the given string value from the given string hash set. More...
 
KANZI_API kzsError kzcHashSetCustomRemove (struct KzcHashSet *hashSet, const void *value)
 Removes the given pointer value from the given pointer hash set. More...
 
KANZI_API void * kzcHashSetPointerGetStoredValue (const struct KzcHashSet *hashSet, const void *value)
 Gets the stored pointer value corresponding to the pointer value given as a parameter. More...
 
KANZI_API void * kzcHashSetCustomGetStoredValue (const struct KzcHashSet *hashSet, const void *value)
 Gets the stored pointer value corresponding to the pointer value given as a parameter. More...
 
KANZI_API kzBool kzcHashSetPointerContains (const struct KzcHashSet *hashSet, const void *value)
 Checks if the specified pointer value exists in the pointer hash set. More...
 
KANZI_API kzBool kzcHashSetIntContains (const struct KzcHashSet *hashSet, kzInt value)
 Checks if the specified integer value exists in the integer hash set. More...
 
KANZI_API kzBool kzcHashSetUintContains (const struct KzcHashSet *hashSet, kzUint value)
 Checks if the specified unsigned integer value exists in the unsigned integer hash set. More...
 
KANZI_API kzBool kzcHashSetFloatContains (const struct KzcHashSet *hashSet, kzFloat value)
 Checks if the specified float value exists in the float hash set. More...
 
KANZI_API kzBool kzcHashSetStringContains (const struct KzcHashSet *hashSet, kzString value)
 Checks if the specified string value exists in the string hash set. More...
 
KANZI_API kzBool kzcHashSetCustomContains (const struct KzcHashSet *hashSet, const void *value)
 Checks if the specified pointer value exists in the pointer hash set. More...
 

Detailed Description

Accessor declarations for hash set.

To be included in kzc_hash_set.h Do not change this file, as the file is generated automatically.

Copyright 2008-2017 by Rightware. All rights reserved.

Macro Definition Documentation

#define kzcHashSetIteratorPointerGetValue (   iterator_param)

Returns the pointer value of the pointer hash map entry pointed by the iterator.

#define kzcHashSetIteratorIntGetValue (   iterator_param)

Returns the integer value of the integer hash map entry pointed by the iterator.

#define kzcHashSetIteratorUintGetValue (   iterator_param)

Returns the unsigned integer value of the unsigned integer hash map entry pointed by the iterator.

#define kzcHashSetIteratorFloatGetValue (   iterator_param)

Returns the float value of the float hash map entry pointed by the iterator.

Function Documentation

KANZI_API kzsError kzcHashSetPointerAdd ( struct KzcHashSet hashSet,
const void *  value 
)

Adds the given pointer value to the given pointer hash set.

In case of a collision the existing entry is replaced.

KANZI_API kzsError kzcHashSetIntAdd ( struct KzcHashSet hashSet,
kzInt  value 
)

Adds the given integer value to the given integer hash set.

In case of a collision the existing entry is replaced.

KANZI_API kzsError kzcHashSetUintAdd ( struct KzcHashSet hashSet,
kzUint  value 
)

Adds the given unsigned integer value to the given unsigned integer hash set.

In case of a collision the existing entry is replaced.

KANZI_API kzsError kzcHashSetFloatAdd ( struct KzcHashSet hashSet,
kzFloat  value 
)

Adds the given float value to the given float hash set.

In case of a collision the existing entry is replaced.

KANZI_API kzsError kzcHashSetStringAdd ( struct KzcHashSet hashSet,
kzString  value 
)

Adds the given string value to the given string hash set.

In case of a collision the existing entry is replaced.

KANZI_API kzsError kzcHashSetCustomAdd ( struct KzcHashSet hashSet,
const void *  value 
)

Adds the given pointer value to the given pointer hash set.

In case of a collision the existing entry is replaced.

KANZI_API kzsError kzcHashSetPointerRemove ( struct KzcHashSet hashSet,
const void *  value 
)

Removes the given pointer value from the given pointer hash set.

If the value does not exist, an error is returned.

KANZI_API kzsError kzcHashSetIntRemove ( struct KzcHashSet hashSet,
kzInt  value 
)

Removes the given integer value from the given integer hash set.

If the value does not exist, an error is returned.

KANZI_API kzsError kzcHashSetUintRemove ( struct KzcHashSet hashSet,
kzUint  value 
)

Removes the given unsigned integer value from the given unsigned integer hash set.

If the value does not exist, an error is returned.

KANZI_API kzsError kzcHashSetFloatRemove ( struct KzcHashSet hashSet,
kzFloat  value 
)

Removes the given float value from the given float hash set.

If the value does not exist, an error is returned.

KANZI_API kzsError kzcHashSetStringRemove ( struct KzcHashSet hashSet,
kzString  value 
)

Removes the given string value from the given string hash set.

If the value does not exist, an error is returned.

KANZI_API kzsError kzcHashSetCustomRemove ( struct KzcHashSet hashSet,
const void *  value 
)

Removes the given pointer value from the given pointer hash set.

If the value does not exist, an error is returned.

KANZI_API void* kzcHashSetPointerGetStoredValue ( const struct KzcHashSet hashSet,
const void *  value 
)

Gets the stored pointer value corresponding to the pointer value given as a parameter.

Returns KZ_NULL if an entry with a matching value does not exist in the hash set.

This function only makes sense for strings and custom types.

KANZI_API void* kzcHashSetCustomGetStoredValue ( const struct KzcHashSet hashSet,
const void *  value 
)

Gets the stored pointer value corresponding to the pointer value given as a parameter.

Returns KZ_NULL if an entry with a matching value does not exist in the hash set.

This function only makes sense for strings and custom types.

KANZI_API kzBool kzcHashSetPointerContains ( const struct KzcHashSet hashSet,
const void *  value 
)

Checks if the specified pointer value exists in the pointer hash set.

Returns KZ_TRUE if the value is found and KZ_FALSE otherwise.

KANZI_API kzBool kzcHashSetIntContains ( const struct KzcHashSet hashSet,
kzInt  value 
)

Checks if the specified integer value exists in the integer hash set.

Returns KZ_TRUE if the value is found and KZ_FALSE otherwise.

KANZI_API kzBool kzcHashSetUintContains ( const struct KzcHashSet hashSet,
kzUint  value 
)

Checks if the specified unsigned integer value exists in the unsigned integer hash set.

Returns KZ_TRUE if the value is found and KZ_FALSE otherwise.

KANZI_API kzBool kzcHashSetFloatContains ( const struct KzcHashSet hashSet,
kzFloat  value 
)

Checks if the specified float value exists in the float hash set.

Returns KZ_TRUE if the value is found and KZ_FALSE otherwise.

KANZI_API kzBool kzcHashSetStringContains ( const struct KzcHashSet hashSet,
kzString  value 
)

Checks if the specified string value exists in the string hash set.

Returns KZ_TRUE if the value is found and KZ_FALSE otherwise.

KANZI_API kzBool kzcHashSetCustomContains ( const struct KzcHashSet hashSet,
const void *  value 
)

Checks if the specified pointer value exists in the pointer hash set.

Returns KZ_TRUE if the value is found and KZ_FALSE otherwise.