[cgds.git] / src / types.h

/**
 * @file types.h
 * @brief A few useful data types.
 */

#ifndef CGDS_TYPES_H
#define CGDS_TYPES_H

#include <stdlib.h>
#include <stdint.h>
#include <stdbool.h>

/**
 * @brief Signed integer type.
 */
typedef int64_t Int;

/**
 * @brief Unsigned integer type.
 */
typedef uint64_t UInt;

/**
 * @brief Data type for a real number.
 */
typedef double Real;

/**
 * @brief Enumeration for the type of buffer or heap.
 */
typedef enum {
  MIN_T = 0, ///< Minimum element first.
  MAX_T = 1 ///< Maximum element first.
} OrderType;

/**
 * @brief Generic item-value type; 'value' may correspond e.g. to distance.
 */
typedef struct ItemValue {
  void* item; ///< Pointer to an item of any type.
  Real value; ///< Value associated with the item.
} ItemValue;

#endif
Commit	Line	Data
a7868768 BA	1	/**
	2	* @file types.h
	3	* @brief A few useful data types.
	4	*/
	5
	6	#ifndef CGDS_TYPES_H
	7	#define CGDS_TYPES_H
	8
	9	#include <stdlib.h>
	10	#include <stdint.h>
1ff641f9	11	#include <stdbool.h>
a7868768 BA	12
	13	/**
	14	* @brief Signed integer type.
	15	*/
	16	typedef int64_t Int;
	17
	18	/**
	19	* @brief Unsigned integer type.
	20	*/
	21	typedef uint64_t UInt;
	22
	23	/**
	24	* @brief Data type for a real number.
	25	*/
	26	typedef double Real;
	27
a7868768 BA	28	/**
	29	* @brief Enumeration for the type of buffer or heap.
	30	*/
	31	typedef enum {
e45132ac BA	32	MIN_T = 0, ///< Minimum element first.
e45132ac BA	33	MAX_T = 1 ///< Maximum element first.
a7868768 BA	34	} OrderType;
	35
	36	/**
	37	* @brief Generic item-value type; 'value' may correspond e.g. to distance.
	38	*/
	39	typedef struct ItemValue {
e45132ac BA	40	void* item; ///< Pointer to an item of any type.
e45132ac BA	41	Real value; ///< Value associated with the item.
a7868768 BA	42	} ItemValue;
	43
	44	#endif