-
Notifications
You must be signed in to change notification settings - Fork 1
/
array.h
108 lines (91 loc) · 4.45 KB
/
array.h
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
/* File: array.h
* Authors: Richard Durbin ([email protected]) and Jean Thierry-Mieg
* Copyright (C) J Thierry-Mieg and R Durbin, 1989-
* -------------------------------------------------------------------
* This file is derived from the ACEDB genome database package, written by
* Richard Durbin (Sanger Centre, UK) [email protected], and
* Jean Thierry-Mieg (CRBM du CNRS, France) [email protected]
* Acedb is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
* as published by the Free Software Foundation; either version 2
* of the License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
* or see the on-line version at http://www.gnu.org/copyleft/gpl.txt
* -------------------------------------------------------------------
* Description: header for array.c
* Exported functions:
* the Array type and associated macros and functions
* HISTORY:
* Last edited: Apr 13 02:42 2018 (rd)
*-------------------------------------------------------------------
*/
#ifndef ARRAY_DEFINED
#define ARRAY_DEFINED
/* #define ARRAY_CHECK either here or in a single file to
check the bounds on arr() and arrp() calls
if defined here can remove from specific C files by defining ARRAY_NO_CHECK
*/
/* #define ARRAY_CHECK */
typedef struct ArrayStruct
{ int magic ;
char* base ; /* char* since need to do pointer arithmetic in bytes */
int dim ; /* length of alloc'ed space in number of elements */
int size ; /* size of elements in bytes */
int max ; /* 1+largest element accessed via array() = number of active elements */
#ifdef ARRAY_REPORT
int id ; /* unique identifier */
#endif
} *Array ;
/* NB we need the full definition for arr() for macros to work
do not use it in user programs - it is private.
*/
#define ARRAY_MAGIC 8918274
Array uArrayCreate (int n, int size) ;
#define arrayCreate(n,type) uArrayCreate(n,sizeof(type))
Array uArrayReCreate (Array a, int n, int size) ;
#define arrayReCreate(a,n,type) uArrayReCreate(a,n,sizeof(type))
void arrayDestroy (Array a) ;
Array arrayCopy (Array a) ;
void arrayExtend (Array a, int n) ;
/* array() and arrayp() will extend the array if necessary */
char *uArray (Array a, int index) ;
#define array(ar,i,type) (*(type*)uArray(ar,i))
#define arrayp(ar,i,type) ((type*)uArray(ar,i))
char *uArrayBlock (Array a, int i, int n) ;
#define arrayBlock(ar,i,n,type) ((type*)uArrayBlock(ar,i,n)) /* use when memset(), fread() etc multiple items */
/* only use arr() when there is no danger of needing expansion */
#if (defined(ARRAY_CHECK) && !defined(ARRAY_NO_CHECK))
char *uArrCheck (Array a, int index) ;
#define arr(ar,i,type) (*(type*)uArrCheck(ar,i))
#define arrp(ar,i,type) ((type*)uArrCheck(ar,i))
#else
#define arr(ar,i,type) ((*(type*)((ar)->base + (i)*(ar)->size)))
#define arrp(ar,i,type) (((type*)((ar)->base + (i)*(ar)->size)))
#endif /* ARRAY_CHECK */
BOOL arrayWrite (Array a, FILE *f) ;
Array arrayRead (FILE *f) ; /* returns 0 if fails */
#define arrayMax(ar) ((ar)->max)
/* JTM's package to hold sorted arrays of ANY TYPE */
typedef int ArrayOrder(const void*, const void*) ; /* call back function prototype for sorting arrays */
#define arraySort(a,order) qsort((a)->base, (a)->max, (a)->size, order)
BOOL arrayInsert(Array a, void * s, ArrayOrder *order);
BOOL arrayRemove(Array a, void * s, ArrayOrder *order);
void arrayCompress(Array a) ;
BOOL arrayFind(Array a, void *s, int *ip, ArrayOrder *order);
#ifdef ARRAY_REPORT
/* status and memory monitoring */
#define ARRAY_REPORT_MAX 0 /* set to maximum number of arrays to keep track of */
void arrayStatus (int *nmadep,int* nusedp, int *memAllocp, int *memUsedp) ; /* memUsed only up to REPORT_MAX */
int arrayReportMark (void) ; /* returns current array number */
void arrayReport (int j) ; /* write stderr about all arrays since j */
#endif
#endif
/**************************** End of File ******************************/