cl_types.h File Reference

Go to the source code of this file.

Macros
#define	_COMPARE_FN(__name, __a_param, __b_param, ...)    _PRIVATE int __name(const void *const __a_param, const void *const __b_param) __VA_ARGS__

Typedefs
typedef int(*	CL_CompareFn) (const void *, const void *)
	A function pointer type for comparing two elements.

Enumerations
enum	CL_Error {   CL_ERR_OK = 0 , CL_ERR_INVALID_PARAMS , CL_ERR_OUT_OF_BOUNDS , CL_ERR_NO_MEMORY ,   CL_ERR_NOT_FOUND , CL_ERR_EMPTY }
	Specify this in the size parameter of the collections initialization to tell the library that the number of elements is unknown, and thus it should automatically resize the collection as needed. More...

Macro Definition Documentation

_COMPARE_FN

#define _COMPARE_FN	(		__name,
			__a_param,
			__b_param,
			...
	)		_PRIVATE int __name(const void *const __a_param, const void *const __b_param) __VA_ARGS__

Definition at line 9 of file cl_types.h.

{
    CL_ERR_OK = 0,
 
    CL_ERR_INVALID_PARAMS,
 
    CL_ERR_OUT_OF_BOUNDS,
 
    CL_ERR_NO_MEMORY,
 
    CL_ERR_NOT_FOUND,
 
    CL_ERR_EMPTY,
} CL_Error;
 
#endif

Typedef Documentation

CL_CompareFn

typedef int(* CL_CompareFn) (const void *, const void *)

A function pointer type for comparing two elements.

Definition at line 7 of file cl_types.h.

Enumeration Type Documentation

CL_Error

enum CL_Error

Specify this in the size parameter of the collections initialization to tell the library that the number of elements is unknown, and thus it should automatically resize the collection as needed.

Note

Always try to specify the size if possible, as this will potentially save memory and improve performance.

Error codes for the Collections library.

Enumerator
CL_ERR_OK	No error.
CL_ERR_INVALID_PARAMS	Invalid arguments.
CL_ERR_OUT_OF_BOUNDS	Out of bounds.
CL_ERR_NO_MEMORY	No memory available.
CL_ERR_NOT_FOUND	Not found.
CL_ERR_EMPTY	Empty collection.

Definition at line 23 of file cl_types.h.

{
    CL_ERR_OK = 0,
 
    CL_ERR_INVALID_PARAMS,
 
    CL_ERR_OUT_OF_BOUNDS,
 
    CL_ERR_NO_MEMORY,
 
    CL_ERR_NOT_FOUND,
 
    CL_ERR_EMPTY,
} CL_Error;