paths.h

Go to the documentation of this file.

#ifndef VIENNA_RNA_PACKAGE_PATHS_H
#define VIENNA_RNA_PACKAGE_PATHS_H

#ifdef VRNA_WARN_DEPRECATED
# if defined(__clang__)
#  define DEPRECATED(func, msg) func __attribute__ ((deprecated("", msg)))
# elif defined(__GNUC__)
#  define DEPRECATED(func, msg) func __attribute__ ((deprecated(msg)))
# else
#  define DEPRECATED(func, msg) func
# endif
#else
# define DEPRECATED(func, msg) func
#endif

typedef struct vrna_path_s vrna_path_t;


typedef struct vrna_path_options_s *vrna_path_options_t;


#ifndef VRNA_DISABLE_BACKWARD_COMPATIBILITY

DEPRECATED(typedef struct vrna_path_s path_t,
             "Use vrna_path_t instead!");

#endif

#include <ViennaRNA/fold_compound.h>
#include <ViennaRNA/landscape/move.h>

#define   VRNA_PATH_TYPE_DOT_BRACKET    1U

#define   VRNA_PATH_TYPE_MOVES          2U

struct vrna_path_s {
  unsigned int type;  
  double      en;     
  char        *s;     
  vrna_move_t move;   
};


void
vrna_path_free(vrna_path_t *path);


void
vrna_path_options_free(vrna_path_options_t options);


vrna_path_options_t
vrna_path_options_findpath(int          width,
                           unsigned int type);


vrna_path_t *
vrna_path_direct(vrna_fold_compound_t *fc,
                 const char           *s1,
                 const char           *s2,
                 vrna_path_options_t  options);


vrna_path_t *
vrna_path_direct_ub(vrna_fold_compound_t  *fc,
                    const char            *s1,
                    const char            *s2,
                    int                   maxE,
                    vrna_path_options_t   options);


#endif