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

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