ks_number.h File Reference

Interface to the libkarmaclient number type. More...

#include "ks_malloc.h"
#include "ks_common.h"

Go to the source code of this file.

Data Structures
struct	_ks_number_t
	libkarmaclient number type. More...
Typedefs
typedef _ks_number_t	ks_number_t
	libkarmaclient number type.
Functions
ks_type_t *	ks_number_type (void)
ks_number_t *	ks_number_new (long int)
void	ks_number_init (ks_number_t *, long int)
void	ks_number_free (ks_number_t *)
void	ks_number_fini (ks_number_t *)
void	ks_number_set (ks_number_t *n, long int)
long int	ks_number_get (ks_number_t *n)

---

Detailed Description

Interface to the libkarmaclient number type.

Type and function declarations for the functions defined in ks_number.c Do not include this file directly in your client. Instead, include the application header file, ks.h, which will include all the libkarmaclient header files for you.

Definition in file ks_number.h.

---

Typedef Documentation

typedef struct _ks_number_t ks_number_t

libkarmaclient number type.

---

Function Documentation

void ks_number_fini (  ks_number_t *  n  )

Reset a number to 0L. Parameters: n  a pointer to the ks_number_t to reset. Returns: nothing Definition at line 115 of file ks_number.c. References _ks_number_t::number. Referenced by ks_bquery_free(), and ks_number_free().

void ks_number_free (  ks_number_t *  n  )

Destroy a given ks_number_t and free all memory that has been allocated for it. Parameters: n  a pointer to the ks_number_t to be destroyed. Returns: Nothing. Definition at line 102 of file ks_number.c. References ks_free(), and ks_number_fini().

long int ks_number_get (  ks_number_t *  n  )

Get the number contained in ks_number_t (n). Parameters: n  a pointer to a ks_number_t Returns: the number contained in n. Definition at line 151 of file ks_number.c. References _ks_number_t::number. Referenced by ks_combination_score(), ks_fact_feed(), ks_fact_value(), and ks_response_time().

void ks_number_init (  ks_number_t *  n, long int  num )

Initialise a ks_number_t to a give number num. Parameters: n  The ks_number_t to set. num  the value to set it to. Returns: Nothing. Definition at line 88 of file ks_number.c. References _ks_number_t::base, ks_number_set(), and _ks_base_t::type. Referenced by ks_bquery_new(), and ks_number_new().

ks_number_t* ks_number_new (  long int  num  )

Create a new ks_number_t Returns: A pointer to the newly created ks_number_t on success or NULL on failure. Definition at line 73 of file ks_number.c. References ks_malloc(), and ks_number_init().

void ks_number_set (  ks_number_t *  n, long int  num )

Set the number in n to num. Parameters: n  A pointer to a ks_number_t to set. num  the number to set it to. Returns: nothing Definition at line 139 of file ks_number.c. References _ks_number_t::number. Referenced by ks_bquery_flags_set(), and ks_number_init().

ks_type_t* ks_number_type (  void   )

Get the metaclass for ks_number_t Returns: A pointer to ks_number_t's metaclass. Definition at line 126 of file ks_number.c. Referenced by ks_fact_feed().

---