binaries/src/ViennaRNA/H/Lfold.h

   1 #ifndef __VIENNA_RNA_PACKAGE_LFOLD_H__
   2 #define __VIENNA_RNA_PACKAGE_LFOLD_H__
   3
   4 /**
   5  */
   6
   7 /**
   8  *  \addtogroup local_fold
   9  *
  10  *  Local structures can be predicted by a modified version of the
  11  *  fold() algorithm that restricts the span of all base pairs.
  12  *  @{
  13  *    \file Lfold.h
  14  *    \brief Predicting local MFE structures of large sequences
  15  *
  16  *  @}
  17  */
  18
  19 /**
  20  *  \addtogroup local_mfe_fold
  21  *  @{
  22  *
  23  *  @}
  24  */
  25
  26 /**
  27  *  \brief The local analog to fold().
  28  *
  29  *  Computes the minimum free energy structure including only base pairs
  30  *  with a span smaller than 'maxdist'
  31  *
  32  *  \ingroup local_mfe_fold
  33  *
  34  *  \param string
  35  *  \param structure
  36  *  \param maxdist
  37  */
  38 float Lfold(const char *string,
  39             char *structure,
  40             int maxdist);
  41
  42 /**
  43  *  \brief
  44  *
  45  *  \ingroup local_mfe_fold
  46  *
  47  *  \param string
  48  *  \param structure
  49  *  \param maxdist
  50  *  \param zsc
  51  *  \param min_z
  52  */
  53 float Lfoldz( const char *string,
  54               char *structure,
  55               int maxdist,
  56               int zsc,
  57               double min_z);
  58
  59
  60 /**
  61  *  \addtogroup local_consensus_fold
  62  *  @{
  63  *
  64  *  @}
  65  */
  66
  67 /**
  68  *  \brief
  69  *
  70  *  \ingroup local_consensus_fold
  71  *
  72  *  \param strings
  73  *  \param structure
  74  *  \param maxdist
  75  *  \return
  76  */
  77 float aliLfold( const char **strings,
  78                 char *structure,
  79                 int maxdist);
  80
  81 #endif