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

   1 \hypertarget{group__energy__parameters__rw}{
   2 \section{Reading/Writing energy parameter sets from/to File}
   3 \label{group__energy__parameters__rw}\index{Reading/Writing energy parameter sets from/to File@{Reading/Writing energy parameter sets from/to File}}
   4 }
   5
   6
   7 Read and Write energy parameter sets from and to text files.
   8
   9
  10 Collaboration diagram for Reading/Writing energy parameter sets from/to File:\nopagebreak
  11 \begin{figure}[H]
  12 \begin{center}
  13 \leavevmode
  14 \includegraphics[width=420pt]{group__energy__parameters__rw}
  15 \end{center}
  16 \end{figure}
  17 \subsection*{Modules}
  18 \begin{DoxyCompactItemize}
  19 \item
  20 \hyperlink{group__energy__parameters__convert}{Converting energy parameter files}
  21
  22
  23 \begin{DoxyCompactList}\small\item\em Convert energy parameter files into the latest format. \item\end{DoxyCompactList}\end{DoxyCompactItemize}
  24 \subsection*{Files}
  25 \begin{DoxyCompactItemize}
  26 \item
  27 file \hyperlink{read__epars_8h}{read\_\-epars.h}
  28 \end{DoxyCompactItemize}
  29 \subsection*{Functions}
  30 \begin{DoxyCompactItemize}
  31 \item
  32 void \hyperlink{group__energy__parameters__rw_ga165a142a3c68fb6655c69ef4ab7cd749}{read\_\-parameter\_\-file} (const char fname\mbox{[}$\,$\mbox{]})
  33 \begin{DoxyCompactList}\small\item\em Read energy parameters from a file. \item\end{DoxyCompactList}\item
  34 void \hyperlink{group__energy__parameters__rw_ga8a43459be386a7489feeab68dc2c6c76}{write\_\-parameter\_\-file} (const char fname\mbox{[}$\,$\mbox{]})
  35 \begin{DoxyCompactList}\small\item\em Write energy parameters to a file. \item\end{DoxyCompactList}\end{DoxyCompactItemize}
  36
  37
  38 \subsection{Detailed Description}
  39 Read and Write energy parameter sets from and to text files. A default set of parameters, identical to the one described in  mathews:2004 and  turner:2010, is compiled into the library.
  40
  41 \subsection{Function Documentation}
  42 \hypertarget{group__energy__parameters__rw_ga165a142a3c68fb6655c69ef4ab7cd749}{
  43 \index{energy\_\-parameters\_\-rw@{energy\_\-parameters\_\-rw}!read\_\-parameter\_\-file@{read\_\-parameter\_\-file}}
  44 \index{read\_\-parameter\_\-file@{read\_\-parameter\_\-file}!energy_parameters_rw@{energy\_\-parameters\_\-rw}}
  45 \subsubsection[{read\_\-parameter\_\-file}]{\setlength{\rightskip}{0pt plus 5cm}void read\_\-parameter\_\-file (const char {\em fname}\mbox{[}$\,$\mbox{]})}}
  46 \label{group__energy__parameters__rw_ga165a142a3c68fb6655c69ef4ab7cd749}
  47
  48
  49 Read energy parameters from a file.
  50 \begin{DoxyParams}{Parameters}
  51 \item[{\em fname}]The path to the file containing the energy parameters \end{DoxyParams}
  52 \hypertarget{group__energy__parameters__rw_ga8a43459be386a7489feeab68dc2c6c76}{
  53 \index{energy\_\-parameters\_\-rw@{energy\_\-parameters\_\-rw}!write\_\-parameter\_\-file@{write\_\-parameter\_\-file}}
  54 \index{write\_\-parameter\_\-file@{write\_\-parameter\_\-file}!energy_parameters_rw@{energy\_\-parameters\_\-rw}}
  55 \subsubsection[{write\_\-parameter\_\-file}]{\setlength{\rightskip}{0pt plus 5cm}void write\_\-parameter\_\-file (const char {\em fname}\mbox{[}$\,$\mbox{]})}}
  56 \label{group__energy__parameters__rw_ga8a43459be386a7489feeab68dc2c6c76}
  57
  58
  59 Write energy parameters to a file.
  60 \begin{DoxyParams}{Parameters}
  61 \item[{\em fname}]A filename (path) for the file where the current energy parameters will be written to \end{DoxyParams}