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

   1 \hypertarget{treedist_8h}{
   2 \section{/homes/fmmarquesmadeira/Projects/jabaws/binaries/src/ViennaRNA/H/treedist.h File Reference}
   3 \label{treedist_8h}\index{/homes/fmmarquesmadeira/Projects/jabaws/binaries/src/ViennaRNA/H/treedist.h@{/homes/fmmarquesmadeira/Projects/jabaws/binaries/src/ViennaRNA/H/treedist.h}}
   4 }
   5
   6
   7 Functions for \hyperlink{structTree}{Tree} Edit Distances.
   8 Include dependency graph for treedist.h:\nopagebreak
   9 \begin{figure}[H]
  10 \begin{center}
  11 \leavevmode
  12 \includegraphics[width=211pt]{treedist_8h__incl}
  13 \end{center}
  14 \end{figure}
  15 \subsection*{Functions}
  16 \begin{DoxyCompactItemize}
  17 \item
  18 \hyperlink{structTree}{Tree} $\ast$ \hyperlink{treedist_8h_a08fe4d5afd385dce593b86eaf010c6e3}{make\_\-tree} (char $\ast$struc)
  19 \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()}. \item\end{DoxyCompactList}\item
  20 float \hyperlink{treedist_8h_a3b21f1925f7071f46d93431a835217bb}{tree\_\-edit\_\-distance} (\hyperlink{structTree}{Tree} $\ast$T1, \hyperlink{structTree}{Tree} $\ast$T2)
  21 \begin{DoxyCompactList}\small\item\em Calculates the edit distance of the two trees. \item\end{DoxyCompactList}\item
  22 \hypertarget{treedist_8h_a21ad4de3ba4055aeef08b28c9ad48894}{
  23 void \hyperlink{treedist_8h_a21ad4de3ba4055aeef08b28c9ad48894}{print\_\-tree} (\hyperlink{structTree}{Tree} $\ast$t)}
  24 \label{treedist_8h_a21ad4de3ba4055aeef08b28c9ad48894}
  25
  26 \begin{DoxyCompactList}\small\item\em Print a tree (mainly for debugging). \item\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. \item\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}{
  36 \index{treedist.h@{treedist.h}!make\_\-tree@{make\_\-tree}}
  37 \index{make\_\-tree@{make\_\-tree}!treedist.h@{treedist.h}}
  38 \subsubsection[{make\_\-tree}]{\setlength{\rightskip}{0pt plus 5cm}{\bf Tree}$\ast$ make\_\-tree (char $\ast$ {\em struc})}}
  39 \label{treedist_8h_a08fe4d5afd385dce593b86eaf010c6e3}
  40
  41
  42 Constructs a \hyperlink{structTree}{Tree} ( essentially the postorder list ) of the structure 'struc', for use in \hyperlink{treedist_8h_a3b21f1925f7071f46d93431a835217bb}{tree\_\-edit\_\-distance()}.
  43 \begin{DoxyParams}{Parameters}
  44 \item[{\em struc}]may be any rooted structure representation. \end{DoxyParams}
  45 \begin{DoxyReturn}{Returns}
  46
  47 \end{DoxyReturn}
  48 \hypertarget{treedist_8h_a3b21f1925f7071f46d93431a835217bb}{
  49 \index{treedist.h@{treedist.h}!tree\_\-edit\_\-distance@{tree\_\-edit\_\-distance}}
  50 \index{tree\_\-edit\_\-distance@{tree\_\-edit\_\-distance}!treedist.h@{treedist.h}}
  51 \subsubsection[{tree\_\-edit\_\-distance}]{\setlength{\rightskip}{0pt plus 5cm}float tree\_\-edit\_\-distance ({\bf Tree} $\ast$ {\em T1}, \/  {\bf Tree} $\ast$ {\em T2})}}
  52 \label{treedist_8h_a3b21f1925f7071f46d93431a835217bb}
  53
  54
  55 Calculates the edit distance of the two trees.
  56 \begin{DoxyParams}{Parameters}
  57 \item[{\em T1}]\item[{\em T2}]\end{DoxyParams}
  58 \begin{DoxyReturn}{Returns}
  59
  60 \end{DoxyReturn}
  61 \hypertarget{treedist_8h_acbc1cb9bce582ea945e4a467c76a57aa}{
  62 \index{treedist.h@{treedist.h}!free\_\-tree@{free\_\-tree}}
  63 \index{free\_\-tree@{free\_\-tree}!treedist.h@{treedist.h}}
  64 \subsubsection[{free\_\-tree}]{\setlength{\rightskip}{0pt plus 5cm}void free\_\-tree ({\bf Tree} $\ast$ {\em t})}}
  65 \label{treedist_8h_acbc1cb9bce582ea945e4a467c76a57aa}
  66
  67
  68 Free the memory allocated for \hyperlink{structTree}{Tree} t.
  69 \begin{DoxyParams}{Parameters}
  70 \item[{\em t}]\end{DoxyParams}