aalist.h

Go to the documentation of this file.

/************************************************************************/
/**

   \file       aalist.h
   
   \version    V3.3
   \date       14.08.14
   \brief      Include file for amino acid linked lists.
   
   \copyright  (c) UCL / Dr. Andrew C.R. Martin 2006-2014
   \author     Dr. Andrew C.R. Martin
   \par
               Institute of Structural & Molecular Biology,
               University College London,
               Gower Street,
               London.
               WC1E 6BT.
   \par
               andrew@bioinf.org.uk
               andrew.martin@ucl.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.0  21.08.06 Original   By: ACRM
-  V3.0  06.11.08 Incorporated into ProFit V3 By: CTP
-  V3.0  18.02.09 Moved to bioplib. By: CTP
-  V3.1  07.07.14 Use bl prefix for functions By: CTP
-  V3.2  31.07.14 Updated deprecation: Removed deprecated.h and added 
                  prototypes for renamed functions. By: CTP
-  V3.3  14.08.14 Moved deprecated function prototypes to deprecated.h 
                  By: CTP

*************************************************************************/
#ifndef _AALIST_H
#define _AALIST_H


/* Includes
*/
#include "general.h"

/************************************************************************/
/* Defines and macros
*/
typedef struct aa
{
   struct aa *next, *prev;
   int    seqnum;
   BOOL   flag;
   char   res;
} AA;


/************************************************************************/
/* Globals
*/

/************************************************************************/
/* Prototypes
*/
AA *blInsertNextResiduesInAAList(AA *a, char res, int nres);
AA *blInsertNextResidueInAAList(AA *a, char res);
char *blBuildSeqFromAAList(AA *aa);
AA *blInsertResidueInAAListAt(AA *aa, char res, int pos);
AA *blInsertResiduesInAAListAt(AA *aa, char res, int nres, int pos);
AA *blBuildAAList(char *seq);
int blFindAAListOffsetByResnum(AA *aa, int resnum);
AA *blFindAAListItemByResnum(AA *aa, int resnum);
void blSetAAListFlagByResnum(AA *aa, int resnum);
char *blBuildFlagSeqFromAAList(AA *aa, char ch);
int blGetAAListLen(AA *aa);

/************************************************************************/
/* Include deprecated functions                                         */
#define _AALIST_H_DEPRECATED
# include "deprecated.h" 
/************************************************************************/


#endif