Bioplib
Protein Structure C Library
 All Data Structures Files Functions Variables Typedefs Macros Pages
aalist.h
Go to the documentation of this file.
1 /************************************************************************/
2 /**
3 
4  \file aalist.h
5 
6  \version V3.3
7  \date 14.08.14
8  \brief Include file for amino acid linked lists.
9 
10  \copyright (c) UCL / Dr. Andrew C.R. Martin 2006-2014
11  \author Dr. Andrew C.R. Martin
12  \par
13  Institute of Structural & Molecular Biology,
14  University College London,
15  Gower Street,
16  London.
17  WC1E 6BT.
18  \par
19  andrew@bioinf.org.uk
20  andrew.martin@ucl.ac.uk
21 
22 **************************************************************************
23 
24  This code is NOT IN THE PUBLIC DOMAIN, but it may be copied
25  according to the conditions laid out in the accompanying file
26  COPYING.DOC.
27 
28  The code may be modified as required, but any modifications must be
29  documented so that the person responsible can be identified.
30 
31  The code may not be sold commercially or included as part of a
32  commercial product except as described in the file COPYING.DOC.
33 
34 **************************************************************************
35 
36  Description:
37  ============
38 
39 
40 **************************************************************************
41 
42  Usage:
43  ======
44 
45 **************************************************************************
46 
47  Revision History:
48  =================
49 - V1.0 21.08.06 Original By: ACRM
50 - V3.0 06.11.08 Incorporated into ProFit V3 By: CTP
51 - V3.0 18.02.09 Moved to bioplib. By: CTP
52 - V3.1 07.07.14 Use bl prefix for functions By: CTP
53 - V3.2 31.07.14 Updated deprecation: Removed deprecated.h and added
54  prototypes for renamed functions. By: CTP
55 - V3.3 14.08.14 Moved deprecated function prototypes to deprecated.h
56  By: CTP
57 
58 *************************************************************************/
59 #ifndef _AALIST_H
60 #define _AALIST_H
61 
62 
63 /* Includes
64 */
65 #include "general.h"
66 
67 /************************************************************************/
68 /* Defines and macros
69 */
70 typedef struct aa
71 {
72  struct aa *next, *prev;
73  int seqnum;
75  char res;
76 } AA;
77 
78 
79 /************************************************************************/
80 /* Globals
81 */
82 
83 /************************************************************************/
84 /* Prototypes
85 */
86 AA *blInsertNextResiduesInAAList(AA *a, char res, int nres);
88 char *blBuildSeqFromAAList(AA *aa);
89 AA *blInsertResidueInAAListAt(AA *aa, char res, int pos);
90 AA *blInsertResiduesInAAListAt(AA *aa, char res, int nres, int pos);
91 AA *blBuildAAList(char *seq);
92 int blFindAAListOffsetByResnum(AA *aa, int resnum);
93 AA *blFindAAListItemByResnum(AA *aa, int resnum);
94 void blSetAAListFlagByResnum(AA *aa, int resnum);
95 char *blBuildFlagSeqFromAAList(AA *aa, char ch);
96 int blGetAAListLen(AA *aa);
97 
98 /************************************************************************/
99 /* Include deprecated functions */
100 #define _AALIST_H_DEPRECATED
101 # include "deprecated.h"
102 /************************************************************************/
103 
104 
105 #endif
AA * blBuildAAList(char *seq)
Definition: aalist.c:359
void blSetAAListFlagByResnum(AA *aa, int resnum)
Definition: aalist.c:470
int blFindAAListOffsetByResnum(AA *aa, int resnum)
Definition: aalist.c:406
short BOOL
Definition: SysDefs.h:64
char * blBuildSeqFromAAList(AA *aa)
Definition: aalist.c:221
char * blBuildFlagSeqFromAAList(AA *aa, char ch)
Definition: aalist.c:494
Redirect calls to deprecated functions.
BOOL flag
Definition: aalist.h:74
AA * blFindAAListItemByResnum(AA *aa, int resnum)
Definition: aalist.c:441
Definition: aalist.h:70
AA * blInsertResiduesInAAListAt(AA *aa, char res, int nres, int pos)
Definition: aalist.c:335
int seqnum
Definition: aalist.h:73
AA * blInsertNextResidueInAAList(AA *a, char res)
Definition: aalist.c:182
char res
Definition: aalist.h:75
struct aa * next
Definition: aalist.h:72
AA * blInsertNextResiduesInAAList(AA *a, char res, int nres)
Definition: aalist.c:154
struct aa * prev
Definition: aalist.h:72
int blGetAAListLen(AA *aa)
Definition: aalist.c:527
Header file for general purpose routines.
struct aa AA
AA * blInsertResidueInAAListAt(AA *aa, char res, int pos)
Definition: aalist.c:261