NAME

free_queue - Frees a queue

SYNOPSIS

#include "l/l_queue.h"

Example compile flags (system dependent):
  -DLINUX_X86_64 -DLINUX_X86_64_OPTERON  -DGNU_COMPILER 
   -I/home/kobus/include
   -L/home/kobus/misc/load/linux_x86_64_opteron -L/usr/lib/x86_64-linux-gnu
  -lKJB                               -lfftw3  -lgsl -lgslcblas -ljpeg  -lSVM -lstdc++                    -lpthread -lSLATEC -lg2c    -lacml -lacml_mv -lblas -lg2c      -lncursesw 


void free_queue
(
	Queue_element **head_ptr_ptr,
	Queue_element **tail_ptr_ptr,
	void (*free_contents_fn)(void *)
);

DESCRIPTION

This routine is used to dispose of the queue pointed to by *head_ptr_ptr. The tail pointer is optional for queues. If there is one, then it should be passed to this routine; otherwise tail_ptr_ptr should be NULL. The queue elements are freed using the function (*free_contents_fn). If free_contents_fn is NULL, then kjb_free is used. Once the queue is freed, *head_ptr_ptr, (and *tail_ptr_ptr if applicable) are set to NULL

DISCLAIMER

This software is not adequatedly tested. It is recomended that results are checked independantly where appropriate.

AUTHOR

Kobus Barnard

DOCUMENTER

Kobus Barnard

SEE ALSO

free_queue_element , alloc_insert_into_queue , alloc_insert_at_end_of_queue , insert_into_queue , insert_at_end_of_queue , insert_into_ordered_queue , remove_first_element , remove_last_element , search_queue , remove_first_selected_element , remove_elements_less_than_key , is_queue_ordered , apply_to_queue , apply_and_free , count_queue_elements , print_str_queue , print_queue