1read_allocate(3)                Staden Package                read_allocate(3)
2
3
4

NAME

6       read_allocate,  read_deallocate  -  Allocate  and  deallocate  the Read
7       structure.
8
9

SYNOPSIS

11       #include <Read.h>
12
13       Read *read_allocate(
14            int num_points,
15            int num_bases);
16
17       void read_deallocate(
18            Read *read);
19
20

DESCRIPTION

22       These functions create and destroy Read structures. The Read  structure
23       is  a  generalised in-memory data structure used for holding trace data
24       information.
25
26       read_allocate()  creates  a  Read  structure  large  enough   to   hold
27       num_points  trace  sample  points and num_bases called bases. The allo‐
28       cated data is then  initialised  to  appropriate  defaults,  which  are
29       mainly zeros and null pointers.
30
31       read_deallocate()  destroys  a previously created Read structure. It is
32       not sufficient to simply use the free() call instead.
33
34

RETURN VALUES

36       On  successful  completion,  the  read_allocate()  function  returns  a
37       pointer  to  a  Read  structure. Otherwise this function returns a null
38       pointer.
39
40       The read_deallocate() function returns no value.
41
42

SEE ALSO

44       read_reading(3), fread_reading(3), write_reading(3), fwrite_reading(3)
45
46
47
48                                                              read_allocate(3)