Mercurial > repos > dawe > srf2fastq
comparison srf2fastq/io_lib-1.12.2/man/man3/read_allocate.3 @ 0:d901c9f41a6a default tip
Migrated tool version 1.0.1 from old tool shed archive to new tool shed repository
author | dawe |
---|---|
date | Tue, 07 Jun 2011 17:48:05 -0400 |
parents | |
children |
comparison
equal
deleted
inserted
replaced
-1:000000000000 | 0:d901c9f41a6a |
---|---|
1 .TH read_allocate 3 "" "" "Staden Package" | |
2 | |
3 .SH NAME | |
4 | |
5 .LP | |
6 .BR read_allocate , | |
7 .BR read_deallocate | |
8 \- Allocate and deallocate the \fBRead\fR structure. | |
9 | |
10 .SH SYNOPSIS | |
11 .LP | |
12 .nf | |
13 .ft B | |
14 #include <Read.h> | |
15 | |
16 .nf | |
17 .ft B | |
18 Read *read_allocate( | |
19 int num_points, | |
20 int num_bases); | |
21 .ft | |
22 .fi | |
23 .LP | |
24 .nf | |
25 .ft B | |
26 void read_deallocate( | |
27 Read *read); | |
28 .ft | |
29 .fi | |
30 .IX "read_allocate()" "" "read_allocate()" | |
31 .IX "read_deallocate()" "" "read_deallocate()" | |
32 | |
33 .SH DESCRIPTION | |
34 .LP | |
35 These functions create and destroy \fBRead\fR structures. The \fBRead\fR | |
36 structure is a generalised in-memory data structure used for holding trace | |
37 data information. | |
38 .LP | |
39 .B read_allocate() | |
40 creates a \fBRead\fR structure large enough to hold \fBnum_points\fR trace | |
41 sample points and \fBnum_bases\fR called bases. The allocated data is then | |
42 initialised to appropriate defaults, which are mainly zeros and null pointers. | |
43 .LP | |
44 .B read_deallocate() | |
45 destroys a previously created \fBRead\fR structure. It is not sufficient to | |
46 simply use the \fBfree()\fR call instead. | |
47 | |
48 .SH RETURN VALUES | |
49 .LP | |
50 On successful completion, the \fBread_allocate()\fR function returns a pointer | |
51 to a \fBRead\fR structure. Otherwise this function returns a null pointer. | |
52 .LP | |
53 The \fBread_deallocate()\fR function returns no value. | |
54 | |
55 .SH SEE ALSO | |
56 .LP | |
57 .BR read_reading (3), | |
58 .BR fread_reading (3), | |
59 .BR write_reading (3), | |
60 .BR fwrite_reading (3) |