RNAlib-2.4.14
commands.h
Go to the documentation of this file.
1 #ifndef VIENNA_RNA_PACKAGE_COMMANDS_H
2 #define VIENNA_RNA_PACKAGE_COMMANDS_H
3 
18 typedef struct vrna_command_s *vrna_cmd_t;
19 
20 
21 #include <ViennaRNA/fold_compound.h>
22 
27 #define VRNA_CMD_PARSE_HC 1U
28 
32 #define VRNA_CMD_PARSE_SC 2U
33 
37 #define VRNA_CMD_PARSE_UD 4U
38 
42 #define VRNA_CMD_PARSE_SD 8U
43 
47 #define VRNA_CMD_PARSE_DEFAULTS (VRNA_CMD_PARSE_HC \
48  | VRNA_CMD_PARSE_SC \
49  | VRNA_CMD_PARSE_UD \
50  | VRNA_CMD_PARSE_SD \
51  )
52 
53 #define VRNA_CMD_PARSE_SILENT 16U
54 
68 vrna_cmd_t
69 vrna_file_commands_read(const char *filename,
70  unsigned int options);
71 
72 
86 int
87 vrna_file_commands_apply(vrna_fold_compound_t *vc,
88  const char *filename,
89  unsigned int options);
90 
91 
100 int
101 vrna_commands_apply(vrna_fold_compound_t *vc,
102  vrna_cmd_t commands,
103  unsigned int options);
104 
105 
112 void
113 vrna_commands_free(vrna_cmd_t commands);
114 
115 
120 #endif
vrna_commands_apply
int vrna_commands_apply(vrna_fold_compound_t *vc, vrna_cmd_t commands, unsigned int options)
Apply a list of commands to a vrna_fold_compound_t.
vrna_fc_s
The most basic data structure required by many functions throughout the RNAlib.
Definition: fold_compound.h:132
vrna_file_commands_read
vrna_cmd_t vrna_file_commands_read(const char *filename, unsigned int options)
Extract a list of commands from a command file.
vrna_cmd_t
struct vrna_command_s * vrna_cmd_t
A data structure that contains commands.
Definition: commands.h:18
vrna_commands_free
void vrna_commands_free(vrna_cmd_t commands)
Free memory occupied by a list of commands.
fold_compound.h
The Basic Fold Compound API.
vrna_file_commands_apply
int vrna_file_commands_apply(vrna_fold_compound_t *vc, const char *filename, unsigned int options)
Apply a list of commands from a command file.