WSTester updated to work plus hopefully all the other changes that need to go into...
[jabaws.git] / binaries / src / ViennaRNA / Progs / RNAsubopt.c
diff --git a/binaries/src/ViennaRNA/Progs/RNAsubopt.c b/binaries/src/ViennaRNA/Progs/RNAsubopt.c
new file mode 100644 (file)
index 0000000..93b79e7
--- /dev/null
@@ -0,0 +1,367 @@
+/* Last changed Time-stamp: <2008-12-03 16:38:01 ivo> */
+/*
+                Ineractive access to suboptimal folding
+
+                           c Ivo L Hofacker
+                          Vienna RNA package
+*/
+#include <config.h>
+#include <stdio.h>
+#include <stdlib.h>
+#include <unistd.h>
+#include <math.h>
+#include <ctype.h>
+#include <string.h>
+#include "part_func.h"
+#include "fold.h"
+#include "cofold.h"
+#include "fold_vars.h"
+#include "utils.h"
+#include "read_epars.h"
+#include "subopt.h"
+#include "params.h"
+#include "RNAsubopt_cmdl.h"
+
+/*@unused@*/
+static char UNUSED rcsid[] = "$Id: RNAsubopt.c,v 1.20 2008/12/03 16:55:44 ivo Exp $";
+
+PRIVATE char *tokenize(char *line);
+PRIVATE void putoutzuker(SOLUTION* zukersolution);
+
+int main(int argc, char *argv[]){
+  struct          RNAsubopt_args_info args_info;
+  unsigned int    input_type;
+  unsigned int    rec_type, read_opt;
+  char            fname[FILENAME_MAX_LENGTH], *c, *input_string, *rec_sequence, *rec_id, **rec_rest, *orig_sequence;
+  char            *cstruc, *structure, *ParamFile, *ns_bases;
+  int             i, length, l, cl, sym, istty;
+  double          deltaf, deltap, betaScale;
+  int             delta, n_back, noconv, circular, dos, zuker;
+  paramT          *P;
+  pf_paramT       *pf_parameters;
+  model_detailsT  md;
+
+  do_backtrack  = 1;
+  dangles       = 2;
+  betaScale     = 1.;
+  delta         = 100;
+  deltap = n_back = noconv = circular = dos = zuker = 0;
+  rec_type      = read_opt = 0;
+  rec_id        = rec_sequence = orig_sequence = NULL;
+  rec_rest      = NULL;
+  input_string  = c = cstruc = structure = ParamFile = ns_bases = NULL;
+  pf_parameters = NULL;
+  P             = NULL;
+
+  set_model_details(&md);
+
+  /*
+  #############################################
+  # check the command line parameters
+  #############################################
+  */
+  if(RNAsubopt_cmdline_parser (argc, argv, &args_info) != 0) exit(1);
+  /* temperature */
+  if(args_info.temp_given)        temperature = args_info.temp_arg;
+  /* structure constraint */
+  if(args_info.constraint_given)  fold_constrained=1;
+  /* do not take special tetra loop energies into account */
+  if(args_info.noTetra_given)     md.special_hp = tetra_loop=0;
+  /* set dangle model */
+  if(args_info.dangles_given){
+    if((args_info.dangles_arg < 0) || (args_info.dangles_arg > 3))
+      warn_user("required dangle model not implemented, falling back to default dangles=2");
+    else
+      md.dangles = dangles = args_info.dangles_arg;
+  }
+  /* do not allow weak pairs */
+  if(args_info.noLP_given)        md.noLP = noLonelyPairs = 1;
+  /* do not allow wobble pairs (GU) */
+  if(args_info.noGU_given)        md.noGU = noGU = 1;
+  /* do not allow weak closing pairs (AU,GU) */
+  if(args_info.noClosingGU_given) md.noGUclosure = no_closingGU = 1;
+  /* do not convert DNA nucleotide "T" to appropriate RNA "U" */
+  if(args_info.noconv_given)      noconv = 1;
+  /* take another energy parameter set */
+  if(args_info.paramFile_given)   ParamFile = strdup(args_info.paramFile_arg);
+  /* Allow other pairs in addition to the usual AU,GC,and GU pairs */
+  if(args_info.nsp_given)         ns_bases = strdup(args_info.nsp_arg);
+  /* energy range */
+  if(args_info.deltaEnergy_given) delta = (int) (0.1+args_info.deltaEnergy_arg*100);
+  /* energy range after post evaluation */
+  if(args_info.deltaEnergyPost_given) deltap = args_info.deltaEnergyPost_arg;
+  /* sorted output */
+  if(args_info.sorted_given)      subopt_sorted = 1;
+  /* assume RNA sequence to be circular */
+  if(args_info.circ_given)        circular=1;
+  /* stochastic backtracking */
+  if(args_info.stochBT_given){
+    n_back = args_info.stochBT_arg;
+    init_rand();
+  }
+  if(args_info.betaScale_given)   betaScale = args_info.betaScale_arg;
+  /* density of states */
+  if(args_info.dos_given){
+    dos = 1;
+    print_energy = -999999;
+  }
+  /* logarithmic multiloop energies */
+  if(args_info.logML_given) md.logML = logML = 1;
+  /* zuker subopts */
+  if(args_info.zuker_given) zuker = 1;
+
+  if(zuker){
+    if(circular){
+      warn_user("Sorry, zuker subopts not yet implemented for circfold");
+      RNAsubopt_cmdline_parser_print_help();
+      exit(1);
+    }
+    else if(n_back>0){
+      warn_user("Can't do zuker subopts and stochastic subopts at the same time");
+      RNAsubopt_cmdline_parser_print_help();
+      exit(1);
+    }
+  }
+
+  /* free allocated memory of command line data structure */
+  RNAsubopt_cmdline_parser_free(&args_info);
+
+  /*
+  #############################################
+  # begin initializing
+  #############################################
+  */
+
+  if (ParamFile != NULL) read_parameter_file(ParamFile);
+
+  if (ns_bases != NULL) {
+    nonstandards = space(33);
+    c=ns_bases;
+    i=sym=0;
+    if (*c=='-') {
+      sym=1; c++;
+    }
+    while (*c!='\0') {
+      if (*c!=',') {
+        nonstandards[i++]=*c++;
+        nonstandards[i++]=*c;
+        if ((sym)&&(*c!=*(c-1))) {
+          nonstandards[i++]=*c;
+          nonstandards[i++]=*(c-1);
+        }
+      }
+      c++;
+    }
+  }
+
+  istty = isatty(fileno(stdout))&&isatty(fileno(stdin));
+
+  /* print user help if we get input from tty */
+  if(istty){
+    if(!zuker)
+      printf("Use '&' to connect 2 sequences that shall form a complex.\n");
+    if(fold_constrained){
+      print_tty_constraint(VRNA_CONSTRAINT_DOT | VRNA_CONSTRAINT_X | VRNA_CONSTRAINT_ANG_BRACK | VRNA_CONSTRAINT_RND_BRACK);
+      print_tty_input_seq_str("Input sequence (upper or lower case) followed by structure constraint\n");
+    }
+    else print_tty_input_seq();
+  }
+
+  /* set options we wanna pass to read_record */
+  if(istty)             read_opt |= VRNA_INPUT_NOSKIP_BLANK_LINES;
+  if(!fold_constrained) read_opt |= VRNA_INPUT_NO_REST;
+
+  P = get_scaled_parameters(temperature, md);
+
+  /*
+  #############################################
+  # main loop: continue until end of file
+  #############################################
+  */
+  while(
+    !((rec_type = read_record(&rec_id, &rec_sequence, &rec_rest, read_opt))
+        & (VRNA_INPUT_ERROR | VRNA_INPUT_QUIT))){
+
+    /*
+    ########################################################
+    # init everything according to the data we've read
+    ########################################################
+    */
+    if(rec_id){
+      /* if(!istty) printf("%s\n", rec_id); */
+      (void) sscanf(rec_id, ">%" XSTR(FILENAME_ID_LENGTH) "s", fname);
+    }
+    else fname[0] = '\0';
+
+    cut_point = -1;
+
+    rec_sequence  = tokenize(rec_sequence); /* frees input_string and sets cut_point */
+    length    = (int) strlen(rec_sequence);
+    structure = (char *) space((unsigned) length+1);
+
+    /* parse the rest of the current dataset to obtain a structure constraint */
+    if(fold_constrained){
+      cstruc = NULL;
+      int cp = cut_point;
+      unsigned int coptions = (rec_id) ? VRNA_CONSTRAINT_MULTILINE : 0;
+      coptions |= VRNA_CONSTRAINT_DOT | VRNA_CONSTRAINT_X | VRNA_CONSTRAINT_ANG_BRACK | VRNA_CONSTRAINT_RND_BRACK;
+      getConstraint(&cstruc, (const char **)rec_rest, coptions);
+      cstruc = tokenize(cstruc);
+      if(cut_point != cp) nrerror("cut point in sequence and structure constraint differs");
+      cl = (cstruc) ? (int)strlen(cstruc) : 0;
+
+      if(cl == 0)           warn_user("structure constraint is missing");
+      else if(cl < length)  warn_user("structure constraint is shorter than sequence");
+      else if(cl > length)  nrerror("structure constraint is too long");
+
+      if(cstruc) strncpy(structure, cstruc, sizeof(char)*(cl+1));
+    }
+
+    /* convert DNA alphabet to RNA if not explicitely switched off */
+    if(!noconv) str_DNA2RNA(rec_sequence);
+    /* store case-unmodified sequence */
+    orig_sequence = strdup(rec_sequence);
+    /* convert sequence to uppercase letters only */
+    str_uppercase(rec_sequence);
+
+    if(istty){
+      if (cut_point == -1)
+        printf("length = %d\n", length);
+      else
+        printf("length1 = %d\nlength2 = %d\n", cut_point-1, length-cut_point+1);
+    }
+
+    /*
+    ########################################################
+    # begin actual computations
+    ########################################################
+    */
+
+    if((logML != 0 || dangles==1 || dangles==3) && dos == 0)
+      if(deltap<=0) deltap = delta/100. + 0.001;
+    if (deltap>0)
+      print_energy = deltap;
+
+    /* stochastic backtracking */
+    if(n_back>0){
+      double mfe, kT;
+      char *ss;
+      if (fname[0] != '\0') printf(">%s\n", fname);
+
+      st_back=1;
+      ss = (char *) space(strlen(rec_sequence)+1);
+      strncpy(ss, structure, length);
+      mfe = fold_par(rec_sequence, ss, P, fold_constrained, circular);
+      kT = (betaScale*((temperature+K0)*GASCONST))/1000.; /* in Kcal */
+      pf_scale = exp(-(1.03*mfe)/kT/length);
+      strncpy(ss, structure, length);
+
+      pf_parameters = get_boltzmann_factors(temperature, betaScale, md, pf_scale);
+      /* ignore return value, we are not interested in the free energy */
+      (void) pf_fold_par(rec_sequence, ss, pf_parameters, do_backtrack, fold_constrained, circular);
+      free(ss);
+      for (i=0; i<n_back; i++) {
+        char *s;
+        s =(circular) ? pbacktrack_circ(rec_sequence) : pbacktrack(rec_sequence);
+        printf("%s\n", s);
+        free(s);
+      }
+      free_pf_arrays();
+      free(pf_parameters);
+    }
+    /* normal subopt */
+    else if(!zuker){
+      /* first lines of output (suitable  for sort +1n) */
+      if (fname[0] != '\0')
+        printf("> %s [%d]\n", fname, delta);
+
+      subopt_par(rec_sequence, structure, P, delta, fold_constrained, circular, stdout);
+      if (dos) {
+        int i;
+        for (i=0; i<= MAXDOS && i<=delta/10; i++) {
+          printf("%4d %6d\n", i, density_of_states[i]);
+        }
+      }
+    }
+    /* Zuker suboptimals */
+    else{
+      SOLUTION *zr;
+      int i;
+      if (fname[0] != '\0') printf(">%s\n%s\n", fname, rec_sequence);
+
+      if (cut_point!=-1) {
+        nrerror("Sorry, zuker subopts not yet implemented for cofold\n");
+      }
+      zr = zukersubopt(rec_sequence);
+      putoutzuker(zr);
+      (void)fflush(stdout);
+      for (i=0; zr[i].structure; i++) {
+        free(zr[i].structure);
+      }
+      free(zr);
+    }
+    
+    (void)fflush(stdout);
+
+    /* clean up */
+    if(cstruc) free(cstruc);
+    if(rec_id) free(rec_id);
+    free(rec_sequence);
+    free(orig_sequence);
+    free(structure);
+    /* free the rest of current dataset */
+    if(rec_rest){
+      for(i=0;rec_rest[i];i++) free(rec_rest[i]);
+      free(rec_rest);
+    }
+    rec_id = rec_sequence = orig_sequence = structure = cstruc = NULL;
+    rec_rest = NULL;
+
+    /* print user help for the next round if we get input from tty */
+    if(istty){
+      if(!zuker)
+        printf("Use '&' to connect 2 sequences that shall form a complex.\n");
+      if(fold_constrained){
+        print_tty_constraint(VRNA_CONSTRAINT_DOT | VRNA_CONSTRAINT_X | VRNA_CONSTRAINT_ANG_BRACK | VRNA_CONSTRAINT_RND_BRACK);
+        print_tty_input_seq_str("Input sequence (upper or lower case) followed by structure constraint\n");
+      }
+      else print_tty_input_seq();
+    }
+  }
+  free(P);
+  return 0;
+}
+
+PRIVATE char *tokenize(char *line)
+{
+  char *pos, *copy;
+  int cut = -1;
+
+  copy = (char *) space(strlen(line)+1);
+  (void) sscanf(line, "%s", copy);
+  pos = strchr(copy, '&');
+  if (pos) {
+    cut = (int) (pos-copy)+1;
+    if (cut >= strlen(copy)) cut = -1;
+    if (strchr(pos+1, '&')) nrerror("more than one cut-point in input");
+    for (;*pos;pos++) *pos = *(pos+1); /* splice out the & */
+  }
+  if (cut > -1) {
+    if (cut_point==-1) cut_point = cut;
+    else if (cut_point != cut) {
+      fprintf(stderr,"cut_point = %d cut = %d\n", cut_point, cut);
+      nrerror("Sequence and Structure have different cut points.");
+    }
+  }
+
+  free(line);
+  return copy;
+}
+PRIVATE void putoutzuker(SOLUTION* zukersolution) {
+  int i;
+  printf("%s [%.2f]\n",zukersolution[0].structure,zukersolution[0].energy/100.);
+  for(i=1; zukersolution[i].structure; i++) {
+    printf("%s [%.2f]\n", zukersolution[i].structure, zukersolution[i].energy/100.);
+  }
+  return;
+}