NAME
allocate_2D_ptr_array - Allocates a 2D array of pointers to void
SYNOPSIS
#include "l/l_2D_arr.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 ***allocate_2D_ptr_array
(
int num_rows,
int num_cols
);
DESCRIPTION
This routine returns a pointer, P, to a two-dimensional array of pointers to
void. P can be de-referenced by P[row][col] to obtain the storage of a ptr.
P[0] points to a contiguous area of memory which contains the entire array.
P[1] is a short-cut pointer to the first element of the second row, and so
on. Thus the array can be accessed sequentually starting at P[0], or
explicitly by row and column. (Note that this is not the common way of
setting up a two-dimensional array--see below).
If TEST is #defined (unix only) then this routine is #define'd to be
debug_allocate_2D_ptr_array, which is the version available in the
development library. In development code, memory is tracked so that memory
leaks can be found more easily. Furthermore, all memory free'd is checked
that it was allocated by a KJB library routine. Finally, memory is checked
for overuns.
The routine free_2D_ptr_array should be used to dispose of the storage
once it is no longer needed.
RETURNS
On error, this routine returns NULL, with an error message being set.
On success it returns a pointer to the array.
WARNING
The structure of the returned array is somewhat different than a more
common form of a two-dimensional array in "C" where each row is allocated
separately. Here the storage area is contiguous. This allows for certain
operations to be done quickly, but note the following IMPORTANT point:
rows cannot be swapped by simply swapping row pointers!
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
allocate_2D_byte_array
,
free_2D_byte_array
,
allocate_2D_short_array
,
free_2D_short_array
,
allocate_2D_int_array
,
free_2D_int_array
,
allocate_2D_long_array
,
free_2D_long_array
,
allocate_2D_float_array
,
free_2D_float_array
,
allocate_2D_double_array
,
free_2D_double_array
,
free_2D_ptr_array