kzc_hash_set_accessors_h.inl File Reference

Accessor declarations for hash set. More...

#include <system/kzs_types.h>
#include <system/debug/kzs_error.h>
#include <system/kzs_header.h>

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...
#define	kzcHashSetIteratorStringGetValue(iterator_param)
	Returns the string value of the string hash map entry pointed by the iterator. More...

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

#define kzcHashSetIteratorStringGetValue

(

iterator_param

)

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

Function Documentation

KZ_HEADER_BEGIN 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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.