Référence du fichier integer_queue.h

File (FIFO) contenant des valeurs de type int Plus de détails...

#include <stdlib.h>
#include "integer_list.h"

Aller au code source de ce fichier.

Définitions de type
typedef integer_list_t	integer_queue_t
	Type de données pour représenter une file contenant des valeurs de type int

Fonctions
void	integer_queue_init (integer_queue_t *queue)
	Initialisation d'une nouvelle file contenant des valeurs de type int
void	integer_queue_destroy (integer_queue_t *queue)
	Destruction d'une file.
int	integer_queue_size (integer_queue_t *queue)
	Accesseur sur la taille d'une file.
int	integer_queue_enqueue (integer_queue_t *queue, int data)
	Ajouter un élément de type int dans la file.
int	integer_queue_dequeue (integer_queue_t *queue, int *data)
	Supprime un élément de type int dans la file.
int	integer_queue_peek (integer_queue_t *queue)
	Récupère la valeur de type int le plus ancien de la file.

Description détaillée

File (FIFO) contenant des valeurs de type int

Documentation des définitions de type

integer_queue_t

typedef integer_list_t integer_queue_t

Type de données pour représenter une file contenant des valeurs de type int

Une file est une liste chaînée gérée de manière adéquate: insertion en tête et suppression en queue.

Documentation des fonctions

integer_queue_dequeue()

int integer_queue_dequeue	(	integer_queue_t *	queue,
		int *	data )

Supprime un élément de type int dans la file.

Etant donné un pointeur vers une file (représentée par une liste chaînée), supprime l'élément le plus ancien de la file.

Paramètres

queue

est un pointeur vers la structure de données integer_queue_t @pram data un pointeur sur type int qui permet de récupérer la valeur de l'élément supprimer de la file

Renvoie

un entier indiquant si tout s'est bien passé (0 pour OK, et -1 en cas de problème mémoire)

integer_queue_destroy()

void integer_queue_destroy

(

integer_queue_t *

queue

)

Destruction d'une file.

Utilise la fonction de destruction des listes chaînées pour parcourir la liste et détruire tous les éléments de la file.

Paramètres

queue

est un pointeur vers la structure de données des piles integer_queue_t

integer_queue_enqueue()

int integer_queue_enqueue	(	integer_queue_t *	queue,
		int	data )

Ajouter un élément de type int dans la file.

Etant donné un pointeur vers une file (représentée par une liste chaînée) et une valeur de type int, ajoute un nouvel élément à la file avec cette valeur.

Paramètres

queue

est un pointeur vers la structure de données integer_queue_t @pram data une valeur de type int à ajouter à la file

Renvoie

un entier indiquant si tout s'est bien passé (0 pour OK, et -1 en cas de problème mémoire)

integer_queue_init()

void integer_queue_init

(

integer_queue_t *

queue

)

Initialisation d'une nouvelle file contenant des valeurs de type int

Utilise la fonction d'initalisation des listes chaînée pour mettre à zéro la taille et à NULL les pointeurs vers le premier et le dernier élément de la liste, i.e., de la file.

Paramètres

queue

est un pointeur vers la structure de données des files integer_queue_t

integer_queue_peek()

int integer_queue_peek

(

integer_queue_t *

queue

)

Récupère la valeur de type int le plus ancien de la file.

Etant donné un pointeur vers une file (représentée par une liste chaînée), récupère la valeur de l'élément le plus ancien de la file sans le supprimer.

Paramètres

queue

est un pointeur vers la structure de données integer_queue_t

Renvoie

une valeur de int de l'élément le plus ancien de la file

integer_queue_size()

int integer_queue_size

(

integer_queue_t *

queue

)

Accesseur sur la taille d'une file.

Etant donné un pointeur vers une file (représentée par une liste chaînée), retourne la valeur du champ size

Paramètres

queue

est un pointeur vers la structure de données integer_queue_t

Renvoie

un entier indiquant la taille de la file