Add missing doc files
[jabaws.git] / binaries / src / ViennaRNA / doc / latex / stringdist_8h.tex
1 \hypertarget{stringdist_8h}{\section{/home/asherstnev/\-Projects/\-Java.projects/jabaws/secure-\/git/develop/binaries/src/\-Vienna\-R\-N\-A/\-H/stringdist.h File Reference}
2 \label{stringdist_8h}\index{/home/asherstnev/\-Projects/\-Java.\-projects/jabaws/secure-\/git/develop/binaries/src/\-Vienna\-R\-N\-A/\-H/stringdist.\-h@{/home/asherstnev/\-Projects/\-Java.\-projects/jabaws/secure-\/git/develop/binaries/src/\-Vienna\-R\-N\-A/\-H/stringdist.\-h}}
3 }
4
5
6 Functions for String Alignment.  
7
8
9 Include dependency graph for stringdist.\-h\-:
10 \nopagebreak
11 \begin{figure}[H]
12 \begin{center}
13 \leavevmode
14 \includegraphics[width=250pt]{stringdist_8h__incl}
15 \end{center}
16 \end{figure}
17 \subsection*{Functions}
18 \begin{DoxyCompactItemize}
19 \item 
20 \hyperlink{structswString}{sw\-String} $\ast$ \hyperlink{stringdist_8h_a3125991b3a403b3f89230474deb3f22e}{Make\-\_\-sw\-String} (char $\ast$string)
21 \begin{DoxyCompactList}\small\item\em Convert a structure into a format suitable for \hyperlink{stringdist_8h_a89e3c335ef17780576d7c0e713830db9}{string\-\_\-edit\-\_\-distance()}. \end{DoxyCompactList}\item 
22 float \hyperlink{stringdist_8h_a89e3c335ef17780576d7c0e713830db9}{string\-\_\-edit\-\_\-distance} (\hyperlink{structswString}{sw\-String} $\ast$T1, \hyperlink{structswString}{sw\-String} $\ast$T2)
23 \begin{DoxyCompactList}\small\item\em Calculate the string edit distance of T1 and T2. \end{DoxyCompactList}\end{DoxyCompactItemize}
24
25
26 \subsection{Detailed Description}
27 Functions for String Alignment. 
28
29 \subsection{Function Documentation}
30 \hypertarget{stringdist_8h_a3125991b3a403b3f89230474deb3f22e}{\index{stringdist.\-h@{stringdist.\-h}!Make\-\_\-sw\-String@{Make\-\_\-sw\-String}}
31 \index{Make\-\_\-sw\-String@{Make\-\_\-sw\-String}!stringdist.h@{stringdist.\-h}}
32 \subsubsection[{Make\-\_\-sw\-String}]{\setlength{\rightskip}{0pt plus 5cm}{\bf sw\-String}$\ast$ Make\-\_\-sw\-String (
33 \begin{DoxyParamCaption}
34 \item[{char $\ast$}]{string}
35 \end{DoxyParamCaption}
36 )}}\label{stringdist_8h_a3125991b3a403b3f89230474deb3f22e}
37
38
39 Convert a structure into a format suitable for \hyperlink{stringdist_8h_a89e3c335ef17780576d7c0e713830db9}{string\-\_\-edit\-\_\-distance()}. 
40
41
42 \begin{DoxyParams}{Parameters}
43 {\em string} & \\
44 \hline
45 \end{DoxyParams}
46 \begin{DoxyReturn}{Returns}
47
48 \end{DoxyReturn}
49 \hypertarget{stringdist_8h_a89e3c335ef17780576d7c0e713830db9}{\index{stringdist.\-h@{stringdist.\-h}!string\-\_\-edit\-\_\-distance@{string\-\_\-edit\-\_\-distance}}
50 \index{string\-\_\-edit\-\_\-distance@{string\-\_\-edit\-\_\-distance}!stringdist.h@{stringdist.\-h}}
51 \subsubsection[{string\-\_\-edit\-\_\-distance}]{\setlength{\rightskip}{0pt plus 5cm}float string\-\_\-edit\-\_\-distance (
52 \begin{DoxyParamCaption}
53 \item[{{\bf sw\-String} $\ast$}]{T1, }
54 \item[{{\bf sw\-String} $\ast$}]{T2}
55 \end{DoxyParamCaption}
56 )}}\label{stringdist_8h_a89e3c335ef17780576d7c0e713830db9}
57
58
59 Calculate the string edit distance of T1 and T2. 
60
61
62 \begin{DoxyParams}{Parameters}
63 {\em T1} & \\
64 \hline
65 {\em T2} & \\
66 \hline
67 \end{DoxyParams}
68 \begin{DoxyReturn}{Returns}
69
70 \end{DoxyReturn}