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

   1 \hypertarget{group__subopt__wuchty}{\section{Suboptimal structures within an energy band arround the M\-F\-E}
   2 \label{group__subopt__wuchty}\index{Suboptimal structures within an energy band arround the M\-F\-E@{Suboptimal structures within an energy band arround the M\-F\-E}}
   3 }
   4 Collaboration diagram for Suboptimal structures within an energy band arround the M\-F\-E\-:
   5 \nopagebreak
   6 \begin{figure}[H]
   7 \begin{center}
   8 \leavevmode
   9 \includegraphics[width=348pt]{group__subopt__wuchty}
  10 \end{center}
  11 \end{figure}
  12 \subsection*{Functions}
  13 \begin{DoxyCompactItemize}
  14 \item
  15 \hyperlink{structSOLUTION}{S\-O\-L\-U\-T\-I\-O\-N} $\ast$ \hyperlink{group__subopt__wuchty_ga700f662506a233e42dd7fda74fafd40e}{subopt} (char $\ast$seq, char $\ast$structure, int delta, F\-I\-L\-E $\ast$fp)
  16 \begin{DoxyCompactList}\small\item\em Returns list of subopt structures or writes to fp. \end{DoxyCompactList}\item
  17 \hypertarget{group__subopt__wuchty_ga554dedfcdb249fdf151caade58666e4d}{\hyperlink{structSOLUTION}{S\-O\-L\-U\-T\-I\-O\-N} $\ast$ \hyperlink{group__subopt__wuchty_ga554dedfcdb249fdf151caade58666e4d}{subopt\-\_\-par} (char $\ast$seq, char $\ast$structure, \hyperlink{structparamT}{param\-T} $\ast$parameters, int delta, int is\-\_\-constrained, int is\-\_\-circular, F\-I\-L\-E $\ast$fp)}\label{group__subopt__wuchty_ga554dedfcdb249fdf151caade58666e4d}
  18
  19 \begin{DoxyCompactList}\small\item\em Returns list of subopt structures or writes to fp. \end{DoxyCompactList}\item
  20 \hyperlink{structSOLUTION}{S\-O\-L\-U\-T\-I\-O\-N} $\ast$ \hyperlink{group__subopt__wuchty_ga8634516e4740e0b6c9a46d2bae940340}{subopt\-\_\-circ} (char $\ast$seq, char $\ast$sequence, int delta, F\-I\-L\-E $\ast$fp)
  21 \begin{DoxyCompactList}\small\item\em Returns list of circular subopt structures or writes to fp. \end{DoxyCompactList}\end{DoxyCompactItemize}
  22 \subsection*{Variables}
  23 \begin{DoxyCompactItemize}
  24 \item
  25 \hypertarget{group__subopt__wuchty_ga873cf8ed69e0437f8efa8b1fec854a0e}{int \hyperlink{group__subopt__wuchty_ga873cf8ed69e0437f8efa8b1fec854a0e}{subopt\-\_\-sorted}}\label{group__subopt__wuchty_ga873cf8ed69e0437f8efa8b1fec854a0e}
  26
  27 \begin{DoxyCompactList}\small\item\em Sort output by energy. \end{DoxyCompactList}\item
  28 \hypertarget{group__subopt__wuchty_ga5e57d914bcb5feeecdf520e25313fcfe}{double \hyperlink{group__subopt__wuchty_ga5e57d914bcb5feeecdf520e25313fcfe}{print\-\_\-energy}}\label{group__subopt__wuchty_ga5e57d914bcb5feeecdf520e25313fcfe}
  29
  30 \begin{DoxyCompactList}\small\item\em printing threshold for use with log\-M\-L \end{DoxyCompactList}\end{DoxyCompactItemize}
  31
  32
  33 \subsection{Detailed Description}
  34
  35
  36 \subsection{Function Documentation}
  37 \hypertarget{group__subopt__wuchty_ga700f662506a233e42dd7fda74fafd40e}{\index{Suboptimal structures within an energy band arround the M\-F\-E@{Suboptimal structures within an energy band arround the M\-F\-E}!subopt@{subopt}}
  38 \index{subopt@{subopt}!Suboptimal structures within an energy band arround the MFE@{Suboptimal structures within an energy band arround the M\-F\-E}}
  39 \subsubsection[{subopt}]{\setlength{\rightskip}{0pt plus 5cm}{\bf S\-O\-L\-U\-T\-I\-O\-N}$\ast$ subopt (
  40 \begin{DoxyParamCaption}
  41 \item[{char $\ast$}]{seq, }
  42 \item[{char $\ast$}]{structure, }
  43 \item[{int}]{delta, }
  44 \item[{F\-I\-L\-E $\ast$}]{fp}
  45 \end{DoxyParamCaption}
  46 )}}\label{group__subopt__wuchty_ga700f662506a233e42dd7fda74fafd40e}
  47
  48
  49 Returns list of subopt structures or writes to fp.
  50
  51 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 N\-U\-L\-L), or (fp==N\-U\-L\-L) returned in a \hyperlink{structSOLUTION}{S\-O\-L\-U\-T\-I\-O\-N} $\ast$ list terminated by an entry were the 'structure' pointer is N\-U\-L\-L.
  52
  53
  54 \begin{DoxyParams}{Parameters}
  55 {\em seq} & \\
  56 \hline
  57 {\em structure} & \\
  58 \hline
  59 {\em delta} & \\
  60 \hline
  61 {\em fp} & \\
  62 \hline
  63 \end{DoxyParams}
  64 \begin{DoxyReturn}{Returns}
  65
  66 \end{DoxyReturn}
  67 \hypertarget{group__subopt__wuchty_ga8634516e4740e0b6c9a46d2bae940340}{\index{Suboptimal structures within an energy band arround the M\-F\-E@{Suboptimal structures within an energy band arround the M\-F\-E}!subopt\-\_\-circ@{subopt\-\_\-circ}}
  68 \index{subopt\-\_\-circ@{subopt\-\_\-circ}!Suboptimal structures within an energy band arround the MFE@{Suboptimal structures within an energy band arround the M\-F\-E}}
  69 \subsubsection[{subopt\-\_\-circ}]{\setlength{\rightskip}{0pt plus 5cm}{\bf S\-O\-L\-U\-T\-I\-O\-N}$\ast$ subopt\-\_\-circ (
  70 \begin{DoxyParamCaption}
  71 \item[{char $\ast$}]{seq, }
  72 \item[{char $\ast$}]{sequence, }
  73 \item[{int}]{delta, }
  74 \item[{F\-I\-L\-E $\ast$}]{fp}
  75 \end{DoxyParamCaption}
  76 )}}\label{group__subopt__wuchty_ga8634516e4740e0b6c9a46d2bae940340}
  77
  78
  79 Returns list of circular subopt structures or writes to fp.
  80
  81 This function is similar to \hyperlink{group__subopt__wuchty_ga700f662506a233e42dd7fda74fafd40e}{subopt()} but calculates secondary structures assuming the R\-N\-A sequence to be circular instead of linear
  82
  83
  84 \begin{DoxyParams}{Parameters}
  85 {\em seq} & \\
  86 \hline
  87 {\em sequence} & \\
  88 \hline
  89 {\em delta} & \\
  90 \hline
  91 {\em fp} & \\
  92 \hline
  93 \end{DoxyParams}
  94 \begin{DoxyReturn}{Returns}
  95
  96 \end{DoxyReturn}