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

   1 \hypertarget{treedist_8h}{\section{/home/asherstnev/\-Projects/\-Java.projects/jabaws/secure-\/git/develop/binaries/src/\-Vienna\-R\-N\-A/\-H/treedist.h File Reference}
   2 \label{treedist_8h}\index{/home/asherstnev/\-Projects/\-Java.\-projects/jabaws/secure-\/git/develop/binaries/src/\-Vienna\-R\-N\-A/\-H/treedist.\-h@{/home/asherstnev/\-Projects/\-Java.\-projects/jabaws/secure-\/git/develop/binaries/src/\-Vienna\-R\-N\-A/\-H/treedist.\-h}}
   3 }
   4
   5
   6 Functions for \hyperlink{structTree}{Tree} Edit Distances.
   7
   8
   9 Include dependency graph for treedist.\-h\-:
  10 \nopagebreak
  11 \begin{figure}[H]
  12 \begin{center}
  13 \leavevmode
  14 \includegraphics[width=250pt]{treedist_8h__incl}
  15 \end{center}
  16 \end{figure}
  17 \subsection*{Functions}
  18 \begin{DoxyCompactItemize}
  19 \item
  20 \hyperlink{structTree}{Tree} $\ast$ \hyperlink{treedist_8h_a08fe4d5afd385dce593b86eaf010c6e3}{make\-\_\-tree} (char $\ast$struc)
  21 \begin{DoxyCompactList}\small\item\em Constructs a \hyperlink{structTree}{Tree} ( essentially the postorder list ) of the structure 'struc', for use in \hyperlink{treedist_8h_a3b21f1925f7071f46d93431a835217bb}{tree\-\_\-edit\-\_\-distance()}. \end{DoxyCompactList}\item
  22 float \hyperlink{treedist_8h_a3b21f1925f7071f46d93431a835217bb}{tree\-\_\-edit\-\_\-distance} (\hyperlink{structTree}{Tree} $\ast$T1, \hyperlink{structTree}{Tree} $\ast$T2)
  23 \begin{DoxyCompactList}\small\item\em Calculates the edit distance of the two trees. \end{DoxyCompactList}\item
  24 \hypertarget{treedist_8h_a21ad4de3ba4055aeef08b28c9ad48894}{void \hyperlink{treedist_8h_a21ad4de3ba4055aeef08b28c9ad48894}{print\-\_\-tree} (\hyperlink{structTree}{Tree} $\ast$t)}\label{treedist_8h_a21ad4de3ba4055aeef08b28c9ad48894}
  25
  26 \begin{DoxyCompactList}\small\item\em Print a tree (mainly for debugging) \end{DoxyCompactList}\item
  27 void \hyperlink{treedist_8h_acbc1cb9bce582ea945e4a467c76a57aa}{free\-\_\-tree} (\hyperlink{structTree}{Tree} $\ast$t)
  28 \begin{DoxyCompactList}\small\item\em Free the memory allocated for \hyperlink{structTree}{Tree} t. \end{DoxyCompactList}\end{DoxyCompactItemize}
  29
  30
  31 \subsection{Detailed Description}
  32 Functions for \hyperlink{structTree}{Tree} Edit Distances.
  33
  34 \subsection{Function Documentation}
  35 \hypertarget{treedist_8h_a08fe4d5afd385dce593b86eaf010c6e3}{\index{treedist.\-h@{treedist.\-h}!make\-\_\-tree@{make\-\_\-tree}}
  36 \index{make\-\_\-tree@{make\-\_\-tree}!treedist.h@{treedist.\-h}}
  37 \subsubsection[{make\-\_\-tree}]{\setlength{\rightskip}{0pt plus 5cm}{\bf Tree}$\ast$ make\-\_\-tree (
  38 \begin{DoxyParamCaption}
  39 \item[{char $\ast$}]{struc}
  40 \end{DoxyParamCaption}
  41 )}}\label{treedist_8h_a08fe4d5afd385dce593b86eaf010c6e3}
  42
  43
  44 Constructs a \hyperlink{structTree}{Tree} ( essentially the postorder list ) of the structure 'struc', for use in \hyperlink{treedist_8h_a3b21f1925f7071f46d93431a835217bb}{tree\-\_\-edit\-\_\-distance()}.
  45
  46
  47 \begin{DoxyParams}{Parameters}
  48 {\em struc} & may be any rooted structure representation. \\
  49 \hline
  50 \end{DoxyParams}
  51 \begin{DoxyReturn}{Returns}
  52
  53 \end{DoxyReturn}
  54 \hypertarget{treedist_8h_a3b21f1925f7071f46d93431a835217bb}{\index{treedist.\-h@{treedist.\-h}!tree\-\_\-edit\-\_\-distance@{tree\-\_\-edit\-\_\-distance}}
  55 \index{tree\-\_\-edit\-\_\-distance@{tree\-\_\-edit\-\_\-distance}!treedist.h@{treedist.\-h}}
  56 \subsubsection[{tree\-\_\-edit\-\_\-distance}]{\setlength{\rightskip}{0pt plus 5cm}float tree\-\_\-edit\-\_\-distance (
  57 \begin{DoxyParamCaption}
  58 \item[{{\bf Tree} $\ast$}]{T1, }
  59 \item[{{\bf Tree} $\ast$}]{T2}
  60 \end{DoxyParamCaption}
  61 )}}\label{treedist_8h_a3b21f1925f7071f46d93431a835217bb}
  62
  63
  64 Calculates the edit distance of the two trees.
  65
  66
  67 \begin{DoxyParams}{Parameters}
  68 {\em T1} & \\
  69 \hline
  70 {\em T2} & \\
  71 \hline
  72 \end{DoxyParams}
  73 \begin{DoxyReturn}{Returns}
  74
  75 \end{DoxyReturn}
  76 \hypertarget{treedist_8h_acbc1cb9bce582ea945e4a467c76a57aa}{\index{treedist.\-h@{treedist.\-h}!free\-\_\-tree@{free\-\_\-tree}}
  77 \index{free\-\_\-tree@{free\-\_\-tree}!treedist.h@{treedist.\-h}}
  78 \subsubsection[{free\-\_\-tree}]{\setlength{\rightskip}{0pt plus 5cm}void free\-\_\-tree (
  79 \begin{DoxyParamCaption}
  80 \item[{{\bf Tree} $\ast$}]{t}
  81 \end{DoxyParamCaption}
  82 )}}\label{treedist_8h_acbc1cb9bce582ea945e4a467c76a57aa}
  83
  84
  85 Free the memory allocated for \hyperlink{structTree}{Tree} t.
  86
  87
  88 \begin{DoxyParams}{Parameters}
  89 {\em t} & \\
  90 \hline
  91 \end{DoxyParams}