array.h File Reference

Include file for 2D/3D array functions. More...

#include "deprecated.h"

Go to the source code of this file.

Macros
#define	_ARRAY_H_DEPRECATED

Functions
char **	blArray2D (int size, int dim1, int dim2)
void	blFreeArray2D (char **array, int dim1, int dim2)
char ***	blArray3D (int size, int dim1, int dim2, int dim3)
void	blFreeArray3D (char ***array, int dim1, int dim2, int dim3)

Detailed Description

Include file for 2D/3D array functions.

Version

V1.8

Date

14.08.14

Copyright

(c) UCL / Dr. Andrew C. R. Martin 1994-2014

Author

Dr. Andrew C. R. Martin

Institute of Structural & Molecular Biology, University College London, Gower Street, London. WC1E 6BT.

andre.nosp@m.w@bi.nosp@m.oinf..nosp@m.org..nosp@m.uk andre.nosp@m.w.ma.nosp@m.rtin@.nosp@m.ucl..nosp@m.ac.uk

This code is NOT IN THE PUBLIC DOMAIN, but it may be copied according to the conditions laid out in the accompanying file COPYING.DOC.

The code may be modified as required, but any modifications must be documented so that the person responsible can be identified.

The code may not be sold commercially or included as part of a commercial product except as described in the file COPYING.DOC.

Description:

Usage:

Revision History:

• V1.4 18.03.94
• V1.5 30.05.02 Added 3D functions
• V1.6 07.07.14 Use bl prefix for functions By: CTP
• V1.7 31.07.14 Updated deprecation: Removed deprecated.h and added prototypes for renamed functions. By: CTP
• V1.8 14.08.14 Moved deprecated function prototypes to deprecated.h By: CTP

Definition in file array.h.

Macro Definition Documentation

#define _ARRAY_H_DEPRECATED

Definition at line 86 of file array.h.

Function Documentation

char** blArray2D	(	int	size,
		int	dim1,
		int	dim2
	)

Parameters

[in]	size	Size of an array element
[in]	dim1	First dimension (number of rows)
[in]	dim2	Second dimension (number of columns)

Returns

Array of pointers. Must be cast to required type

Create a 2D array of elements of size `size' with dimensions `dim1' rows by `dim2' columns.

• 07.10.92 Original
• 12.07.93 Tidied and commented
• 07.07.14 Use bl prefix for functions By: CTP

Definition at line 130 of file array2.c.

char*** blArray3D	(	int	size,
		int	dim1,
		int	dim2,
		int	dim3
	)

Parameters

[in]	size	Size of an array element
[in]	dim1	First dimension (number of rows)
[in]	dim2	Second dimension (number of columns)
[in]	dim3	Third dimension (number of planes)

Returns

Array of pointers. Must be cast to required type

Create a 3D array of elements of size `size' with dimensions `dim1' rows by `dim2' columns by `dim3' planes

• 30.05.02 Original
• 07.07.14 Use bl prefix for functions By: CTP

Definition at line 127 of file array3.c.

void blFreeArray2D	(	char **	array,
		int	dim1,
		int	dim2
	)

Parameters

[in]	array	Array of pointers to be freed
[in]	dim1	First dimension (number of rows)
[in]	dim2	Second dimension (number of columns)

Frees a 2D array with dimensions `dim1' rows by `dim2' columns.

• 07.10.92 Original
• 07.07.14 Use bl prefix for functions By: CTP

Definition at line 174 of file array2.c.

void blFreeArray3D	(	char ***	array,
		int	dim1,
		int	dim2,
		int	dim3
	)

Parameters

[in]	array	Array of pointers to be freed
[in]	dim1	First dimension (number of rows)
[in]	dim2	Second dimension (number of columns)
[in]	dim3	Third dimension (number of planes)

Frees a 3D array with dimensions `dim1' rows by `dim2' columns by `dim3' planes.

• 30.05.02 Original
• 07.07.14 Use bl prefix for functions By: CTP

Definition at line 182 of file array3.c.