binaries/src/ViennaRNA/doc/latex/group__subopt__wuchty.tex

   1 \hypertarget{group__subopt__wuchty}{
   2 \section{Suboptimal structures within an energy band arround the MFE}
   3 \label{group__subopt__wuchty}\index{Suboptimal structures within an energy band arround the MFE@{Suboptimal structures within an energy band arround the MFE}}
   4 }
   5
   6
   7 Collaboration diagram for Suboptimal structures within an energy band arround the MFE:\nopagebreak
   8 \begin{figure}[H]
   9 \begin{center}
  10 \leavevmode
  11 \includegraphics[width=272pt]{group__subopt__wuchty}
  12 \end{center}
  13 \end{figure}
  14 \subsection*{Functions}
  15 \begin{DoxyCompactItemize}
  16 \item
  17 \hyperlink{structSOLUTION}{SOLUTION} $\ast$ \hyperlink{group__subopt__wuchty_ga700f662506a233e42dd7fda74fafd40e}{subopt} (char $\ast$seq, char $\ast$structure, int delta, FILE $\ast$fp)
  18 \begin{DoxyCompactList}\small\item\em Returns list of subopt structures or writes to fp. \item\end{DoxyCompactList}\item
  19 \hypertarget{group__subopt__wuchty_ga554dedfcdb249fdf151caade58666e4d}{
  20 \hyperlink{structSOLUTION}{SOLUTION} $\ast$ \hyperlink{group__subopt__wuchty_ga554dedfcdb249fdf151caade58666e4d}{subopt\_\-par} (char $\ast$seq, char $\ast$structure, \hyperlink{structparamT}{paramT} $\ast$parameters, int delta, int is\_\-constrained, int is\_\-circular, FILE $\ast$fp)}
  21 \label{group__subopt__wuchty_ga554dedfcdb249fdf151caade58666e4d}
  22
  23 \begin{DoxyCompactList}\small\item\em Returns list of subopt structures or writes to fp. \item\end{DoxyCompactList}\item
  24 \hyperlink{structSOLUTION}{SOLUTION} $\ast$ \hyperlink{group__subopt__wuchty_ga8634516e4740e0b6c9a46d2bae940340}{subopt\_\-circ} (char $\ast$seq, char $\ast$sequence, int delta, FILE $\ast$fp)
  25 \begin{DoxyCompactList}\small\item\em Returns list of circular subopt structures or writes to fp. \item\end{DoxyCompactList}\end{DoxyCompactItemize}
  26 \subsection*{Variables}
  27 \begin{DoxyCompactItemize}
  28 \item
  29 \hypertarget{group__subopt__wuchty_ga873cf8ed69e0437f8efa8b1fec854a0e}{
  30 int \hyperlink{group__subopt__wuchty_ga873cf8ed69e0437f8efa8b1fec854a0e}{subopt\_\-sorted}}
  31 \label{group__subopt__wuchty_ga873cf8ed69e0437f8efa8b1fec854a0e}
  32
  33 \begin{DoxyCompactList}\small\item\em Sort output by energy. \item\end{DoxyCompactList}\item
  34 \hypertarget{group__subopt__wuchty_ga5e57d914bcb5feeecdf520e25313fcfe}{
  35 double \hyperlink{group__subopt__wuchty_ga5e57d914bcb5feeecdf520e25313fcfe}{print\_\-energy}}
  36 \label{group__subopt__wuchty_ga5e57d914bcb5feeecdf520e25313fcfe}
  37
  38 \begin{DoxyCompactList}\small\item\em printing threshold for use with logML \item\end{DoxyCompactList}\end{DoxyCompactItemize}
  39
  40
  41 \subsection{Function Documentation}
  42 \hypertarget{group__subopt__wuchty_ga700f662506a233e42dd7fda74fafd40e}{
  43 \index{subopt\_\-wuchty@{subopt\_\-wuchty}!subopt@{subopt}}
  44 \index{subopt@{subopt}!subopt_wuchty@{subopt\_\-wuchty}}
  45 \subsubsection[{subopt}]{\setlength{\rightskip}{0pt plus 5cm}{\bf SOLUTION}$\ast$ subopt (char $\ast$ {\em seq}, \/  char $\ast$ {\em structure}, \/  int {\em delta}, \/  FILE $\ast$ {\em fp})}}
  46 \label{group__subopt__wuchty_ga700f662506a233e42dd7fda74fafd40e}
  47
  48
  49 Returns list of subopt structures or writes to fp. This function produces {\bfseries all} suboptimal secondary structures within 'delta' $\ast$ 0.01 kcal/mol of the optimum. The results are either directly written to a 'fp' (if 'fp' is not NULL), or (fp==NULL) returned in a \hyperlink{structSOLUTION}{SOLUTION} $\ast$ list terminated by an entry were the 'structure' pointer is NULL.
  50
  51
  52 \begin{DoxyParams}{Parameters}
  53 \item[{\em seq}]\item[{\em structure}]\item[{\em delta}]\item[{\em fp}]\end{DoxyParams}
  54 \begin{DoxyReturn}{Returns}
  55
  56 \end{DoxyReturn}
  57 \hypertarget{group__subopt__wuchty_ga8634516e4740e0b6c9a46d2bae940340}{
  58 \index{subopt\_\-wuchty@{subopt\_\-wuchty}!subopt\_\-circ@{subopt\_\-circ}}
  59 \index{subopt\_\-circ@{subopt\_\-circ}!subopt_wuchty@{subopt\_\-wuchty}}
  60 \subsubsection[{subopt\_\-circ}]{\setlength{\rightskip}{0pt plus 5cm}{\bf SOLUTION}$\ast$ subopt\_\-circ (char $\ast$ {\em seq}, \/  char $\ast$ {\em sequence}, \/  int {\em delta}, \/  FILE $\ast$ {\em fp})}}
  61 \label{group__subopt__wuchty_ga8634516e4740e0b6c9a46d2bae940340}
  62
  63
  64 Returns list of circular subopt structures or writes to fp. This function is similar to \hyperlink{group__subopt__wuchty_ga700f662506a233e42dd7fda74fafd40e}{subopt()} but calculates secondary structures assuming the RNA sequence to be circular instead of linear
  65
  66
  67 \begin{DoxyParams}{Parameters}
  68 \item[{\em seq}]\item[{\em sequence}]\item[{\em delta}]\item[{\em fp}]\end{DoxyParams}
  69 \begin{DoxyReturn}{Returns}
  70
  71 \end{DoxyReturn}