binaries/src/ViennaRNA/H/findpath.h

   1 #ifndef __VIENNA_RNA_PACKAGE_FIND_PATH_H__
   2 #define __VIENNA_RNA_PACKAGE_FIND_PATH_H__
   3
   4 #include "data_structures.h"
   5
   6 /**
   7  *  \file findpath.h
   8  *  \brief Compute direct refolding paths between two secondary structures
   9  */
  10
  11 /**
  12  *  \brief Find energy of a saddle point between 2 structures
  13  *  (serch only direct path)
  14  *
  15  *  \param seq RNA sequence
  16  *  \param struc1 A pointer to the character array where the first
  17  *         secondary structure in dot-bracket notation will be written to
  18  *  \param struc2 A pointer to the character array where the second
  19  *         secondary structure in dot-bracket notation will be written to
  20  *  \param max integer how many strutures are being kept during the search
  21  *  \returns the saddle energy in 10cal/mol
  22  */
  23 int     find_saddle(const char *seq,
  24                     const char *struc1,
  25                     const char *struc2,
  26                     int max);
  27
  28
  29 /**
  30  *  \brief Find refolding path between 2 structures
  31  *  (serch only direct path)
  32  *
  33  *  \param seq RNA sequence
  34  *  \param s1 A pointer to the character array where the first
  35  *         secondary structure in dot-bracket notation will be written to
  36  *  \param s2 A pointer to the character array where the second
  37  *         secondary structure in dot-bracket notation will be written to
  38  *  \param maxkeep integer how many strutures are being kept during the search
  39  *  \returns direct refolding path between two structures
  40  */
  41 path_t* get_path( const char *seq,
  42                   const char *s1,
  43                   const char* s2,
  44                   int maxkeep);
  45
  46 /**
  47  *  \brief Free memory allocated by get_path() function
  48  *
  49  *  \param path pointer to memory to be freed
  50  */
  51 void    free_path(path_t *path);
  52
  53 #endif