swh:1:snp:e6d42e6731ce66e3c09de07ac49964c03139e990
Raw File
Tip revision: 26b818c8be2be41dd673d938b403c5c7562635de authored by Travis CI on 28 November 2019, 13:55:12 UTC
Deploy code docs to GitHub Pages Travis build: 305
Tip revision: 26b818c
class_ox_1_1_sign_calculator.tex
\hypertarget{class_ox_1_1_sign_calculator}{\section{Ox\-:\-:Sign\-Calculator$<$ Measure\-Type $>$ Class Template Reference}
\label{class_ox_1_1_sign_calculator}\index{Ox\-::\-Sign\-Calculator$<$ Measure\-Type $>$@{Ox\-::\-Sign\-Calculator$<$ Measure\-Type $>$}}
}


{\ttfamily \#include $<$Ox\-Sign\-Calculator.\-h$>$}



Inheritance diagram for Ox\-:\-:Sign\-Calculator$<$ Measure\-Type $>$\-:
\nopagebreak
\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=350pt]{class_ox_1_1_sign_calculator__inherit__graph}
\end{center}
\end{figure}
\subsection*{Public Member Functions}
\begin{DoxyCompactItemize}
\item 
\hypertarget{class_ox_1_1_sign_calculator_aeae2b269b870b515f9da0ecb9a0c9dda}{virtual const Measure\-Type $\ast$ {\bfseries get\-Inv\-Times} () const }\label{class_ox_1_1_sign_calculator_aeae2b269b870b515f9da0ecb9a0c9dda}

\item 
\hypertarget{class_ox_1_1_sign_calculator_abe5cfb287faab9e06e113bf33daa9b2e}{virtual const Measure\-Type $\ast$ {\bfseries get\-Sig\-Mag} () const }\label{class_ox_1_1_sign_calculator_abe5cfb287faab9e06e113bf33daa9b2e}

\item 
\hypertarget{class_ox_1_1_sign_calculator_a5d875d51f77739c61d8c6391d665ade9}{virtual const Measure\-Type $\ast$ {\bfseries get\-Sig\-Pha} () const }\label{class_ox_1_1_sign_calculator_a5d875d51f77739c61d8c6391d665ade9}

\item 
\hypertarget{class_ox_1_1_sign_calculator_ac4dc2ae5e3e5eee88d0a3a347a68a637}{virtual Measure\-Type $\ast$ {\bfseries get\-Signal} ()}\label{class_ox_1_1_sign_calculator_ac4dc2ae5e3e5eee88d0a3a347a68a637}

\item 
\hypertarget{class_ox_1_1_sign_calculator_a04d65630c95cf94ee6198193a5c0c346}{virtual Measure\-Type $\ast$ {\bfseries get\-Signs} ()}\label{class_ox_1_1_sign_calculator_a04d65630c95cf94ee6198193a5c0c346}

\item 
\hypertarget{class_ox_1_1_sign_calculator_a6f1f77383cd088a1339ae91ce0b58e40}{virtual int {\bfseries get\-N\-Samples} ()}\label{class_ox_1_1_sign_calculator_a6f1f77383cd088a1339ae91ce0b58e40}

\item 
\hypertarget{class_ox_1_1_sign_calculator_a184b9d2bd4b6677fef960aef40dbfe1c}{virtual void {\bfseries set\-Inv\-Times} (const Measure\-Type $\ast$\-\_\-\-Inv\-Times)}\label{class_ox_1_1_sign_calculator_a184b9d2bd4b6677fef960aef40dbfe1c}

\item 
\hypertarget{class_ox_1_1_sign_calculator_ad010dcfd41f343b7d9cad99a3c628468}{virtual void {\bfseries set\-Sig\-Mag} (const Measure\-Type $\ast$\-\_\-\-Sig\-Mag)}\label{class_ox_1_1_sign_calculator_ad010dcfd41f343b7d9cad99a3c628468}

\item 
\hypertarget{class_ox_1_1_sign_calculator_a1fe78e188915e35e8d0db885642852c9}{virtual void {\bfseries set\-Sig\-Pha} (const Measure\-Type $\ast$\-\_\-\-Sig\-Pha)}\label{class_ox_1_1_sign_calculator_a1fe78e188915e35e8d0db885642852c9}

\item 
\hypertarget{class_ox_1_1_sign_calculator_ade6aa249b05f92357cb825065be8a203}{virtual void {\bfseries set\-Signal} (Measure\-Type $\ast$\-\_\-\-Signal)}\label{class_ox_1_1_sign_calculator_ade6aa249b05f92357cb825065be8a203}

\item 
\hypertarget{class_ox_1_1_sign_calculator_a3de14f899f64c93df9076fb837e553bf}{virtual void {\bfseries set\-Signs} (Measure\-Type $\ast$\-\_\-\-Signs)}\label{class_ox_1_1_sign_calculator_a3de14f899f64c93df9076fb837e553bf}

\item 
\hypertarget{class_ox_1_1_sign_calculator_a8a4f3f8b94fad53d444cf6f1c1191497}{virtual void {\bfseries set\-N\-Samples} (int \-\_\-n\-Samples)}\label{class_ox_1_1_sign_calculator_a8a4f3f8b94fad53d444cf6f1c1191497}

\item 
virtual int \hyperlink{class_ox_1_1_sign_calculator_a6a85028b70e41f6a60a5b639c468e455}{calculate\-Sign} ()=0
\item 
\hypertarget{class_ox_1_1_sign_calculator_afc55176ad2a81085942e1e98242376bf}{virtual void {\bfseries disp} ()}\label{class_ox_1_1_sign_calculator_afc55176ad2a81085942e1e98242376bf}

\item 
\hypertarget{class_ox_1_1_sign_calculator_a59de754f72402b4cf7dc2f8766f0a1ff}{void \hyperlink{class_ox_1_1_sign_calculator_a59de754f72402b4cf7dc2f8766f0a1ff}{set\-All\-Pointers\-To\-Null} ()}\label{class_ox_1_1_sign_calculator_a59de754f72402b4cf7dc2f8766f0a1ff}

\begin{DoxyCompactList}\small\item\em set all the pointers to zero \end{DoxyCompactList}\item 
\hypertarget{class_ox_1_1_sign_calculator_a1b0a177a5f2c6080d6730ff5fdc384af}{\hyperlink{class_ox_1_1_sign_calculator_a1b0a177a5f2c6080d6730ff5fdc384af}{Sign\-Calculator} ()}\label{class_ox_1_1_sign_calculator_a1b0a177a5f2c6080d6730ff5fdc384af}

\begin{DoxyCompactList}\small\item\em constructor \end{DoxyCompactList}\item 
\hypertarget{class_ox_1_1_sign_calculator_a118469032ecb643b93ba56f948fdce85}{\hyperlink{class_ox_1_1_sign_calculator_a118469032ecb643b93ba56f948fdce85}{Sign\-Calculator} (const \hyperlink{class_ox_1_1_sign_calculator}{Sign\-Calculator} \&old)}\label{class_ox_1_1_sign_calculator_a118469032ecb643b93ba56f948fdce85}

\begin{DoxyCompactList}\small\item\em copy constructor \end{DoxyCompactList}\item 
virtual \hyperlink{class_ox_1_1_sign_calculator}{Sign\-Calculator}\\*
$<$ Measure\-Type $>$ $\ast$ \hyperlink{class_ox_1_1_sign_calculator_a40d9d97a505a69b687429bf545597687}{new\-By\-Cloning} ()=0
\item 
\hypertarget{class_ox_1_1_sign_calculator_a5143a172e360633d8df758756d146889}{virtual \hyperlink{class_ox_1_1_sign_calculator_a5143a172e360633d8df758756d146889}{$\sim$\-Sign\-Calculator} ()}\label{class_ox_1_1_sign_calculator_a5143a172e360633d8df758756d146889}

\begin{DoxyCompactList}\small\item\em do not forget about the virtual destructor, see \href{https://stackoverflow.com/questions/461203/when-to-use-virtual-destructors}{\tt https\-://stackoverflow.\-com/questions/461203/when-\/to-\/use-\/virtual-\/destructors} \end{DoxyCompactList}\end{DoxyCompactItemize}
\subsection*{Protected Attributes}
\begin{DoxyCompactItemize}
\item 
\hypertarget{class_ox_1_1_sign_calculator_a46be35659f793c2e1280a975f799db4d}{const Measure\-Type $\ast$ {\bfseries \-\_\-\-Inv\-Times}}\label{class_ox_1_1_sign_calculator_a46be35659f793c2e1280a975f799db4d}

\item 
\hypertarget{class_ox_1_1_sign_calculator_a635a62974bc9b9f30d0d560a84fcf3f1}{const Measure\-Type $\ast$ {\bfseries \-\_\-\-Sig\-Mag}}\label{class_ox_1_1_sign_calculator_a635a62974bc9b9f30d0d560a84fcf3f1}

\item 
\hypertarget{class_ox_1_1_sign_calculator_a19b203aacea5e39bc9675a27c57197d3}{const Measure\-Type $\ast$ {\bfseries \-\_\-\-Sig\-Pha}}\label{class_ox_1_1_sign_calculator_a19b203aacea5e39bc9675a27c57197d3}

\item 
\hypertarget{class_ox_1_1_sign_calculator_aaf53cad7c5d49133017677f8abb589bf}{Measure\-Type $\ast$ {\bfseries \-\_\-\-Signal}}\label{class_ox_1_1_sign_calculator_aaf53cad7c5d49133017677f8abb589bf}

\item 
\hypertarget{class_ox_1_1_sign_calculator_a6dda6e1e4d83dd7ad4654f7fd2b44bb3}{Measure\-Type $\ast$ {\bfseries \-\_\-\-Signs}}\label{class_ox_1_1_sign_calculator_a6dda6e1e4d83dd7ad4654f7fd2b44bb3}

\item 
\hypertarget{class_ox_1_1_sign_calculator_a133488500068bccf0e041d9244a09e02}{int {\bfseries \-\_\-n\-Samples}}\label{class_ox_1_1_sign_calculator_a133488500068bccf0e041d9244a09e02}

\end{DoxyCompactItemize}


\subsection{Detailed Description}
\subsubsection*{template$<$typename Measure\-Type$>$class Ox\-::\-Sign\-Calculator$<$ Measure\-Type $>$}


\begin{DoxyTemplParams}{Template Parameters}
{\em Measure\-Type} & \\
\hline
\end{DoxyTemplParams}


\subsection{Member Function Documentation}
\hypertarget{class_ox_1_1_sign_calculator_a6a85028b70e41f6a60a5b639c468e455}{\index{Ox\-::\-Sign\-Calculator@{Ox\-::\-Sign\-Calculator}!calculate\-Sign@{calculate\-Sign}}
\index{calculate\-Sign@{calculate\-Sign}!Ox::SignCalculator@{Ox\-::\-Sign\-Calculator}}
\subsubsection[{calculate\-Sign}]{\setlength{\rightskip}{0pt plus 5cm}template$<$typename Measure\-Type$>$ virtual int {\bf Ox\-::\-Sign\-Calculator}$<$ Measure\-Type $>$\-::calculate\-Sign (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily [pure virtual]}}}\label{class_ox_1_1_sign_calculator_a6a85028b70e41f6a60a5b639c468e455}
the most important function of this class \begin{DoxyReturn}{Returns}
success/failure 
\end{DoxyReturn}


Implemented in \hyperlink{class_ox_1_1_sign_calculator_no_sign_a8e78a82d817f66385d1a2140f8ef11d7}{Ox\-::\-Sign\-Calculator\-No\-Sign$<$ Measure\-Type $>$}, \hyperlink{class_ox_1_1_sign_calculator_real_imag_ae3f3c8f8e8ea994da7ad56f4a180cb36}{Ox\-::\-Sign\-Calculator\-Real\-Imag$<$ Measure\-Type $>$}, and \hyperlink{class_ox_1_1_sign_calculator_shmolli_ab981a3a9790976de560609860f455edd}{Ox\-::\-Sign\-Calculator\-Shmolli$<$ Measure\-Type $>$}.

\hypertarget{class_ox_1_1_sign_calculator_a40d9d97a505a69b687429bf545597687}{\index{Ox\-::\-Sign\-Calculator@{Ox\-::\-Sign\-Calculator}!new\-By\-Cloning@{new\-By\-Cloning}}
\index{new\-By\-Cloning@{new\-By\-Cloning}!Ox::SignCalculator@{Ox\-::\-Sign\-Calculator}}
\subsubsection[{new\-By\-Cloning}]{\setlength{\rightskip}{0pt plus 5cm}template$<$typename Measure\-Type$>$ virtual {\bf Sign\-Calculator}$<$Measure\-Type$>$$\ast$ {\bf Ox\-::\-Sign\-Calculator}$<$ Measure\-Type $>$\-::new\-By\-Cloning (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily [pure virtual]}}}\label{class_ox_1_1_sign_calculator_a40d9d97a505a69b687429bf545597687}
cloning \begin{DoxyReturn}{Returns}

\end{DoxyReturn}


Implemented in \hyperlink{class_ox_1_1_sign_calculator_shmolli_a9d9cd9b7107e43b4762846f54ff023d4}{Ox\-::\-Sign\-Calculator\-Shmolli$<$ Measure\-Type $>$}, \hyperlink{class_ox_1_1_sign_calculator_no_sign_ac480086ad668ac264393b1b18a926221}{Ox\-::\-Sign\-Calculator\-No\-Sign$<$ Measure\-Type $>$}, and \hyperlink{class_ox_1_1_sign_calculator_real_imag_ae3340d1ac5728efcaf3d5a9299f01f2c}{Ox\-::\-Sign\-Calculator\-Real\-Imag$<$ Measure\-Type $>$}.



The documentation for this class was generated from the following file\-:\begin{DoxyCompactItemize}
\item 
lib/\hyperlink{_ox_sign_calculator_8h}{Ox\-Sign\-Calculator.\-h}\end{DoxyCompactItemize}
back to top