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_fitter.tex
\hypertarget{class_ox_1_1_fitter}{\section{Ox\-:\-:Fitter$<$ Measure\-Type $>$ Class Template Reference}
\label{class_ox_1_1_fitter}\index{Ox\-::\-Fitter$<$ Measure\-Type $>$@{Ox\-::\-Fitter$<$ Measure\-Type $>$}}
}


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

\subsection*{Public Member Functions}
\begin{DoxyCompactItemize}
\item 
virtual int \hyperlink{class_ox_1_1_fitter_a8f240f0da86d06b339ab2747e87f21b9}{perform\-Fitting} ()=0
\item 
\hypertarget{class_ox_1_1_fitter_aab3e83fef361dc2dfa855c4988af2393}{virtual const \hyperlink{class_ox_1_1_model}{Model}\\*
$<$ Measure\-Type $>$ $\ast$ {\bfseries get\-Model} () const }\label{class_ox_1_1_fitter_aab3e83fef361dc2dfa855c4988af2393}

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

\item 
\hypertarget{class_ox_1_1_fitter_a21f92547f664c9b6f3fa8da4c7d16965}{virtual const Measure\-Type {\bfseries get\-X\-Tolerance} () const }\label{class_ox_1_1_fitter_a21f92547f664c9b6f3fa8da4c7d16965}

\item 
\hypertarget{class_ox_1_1_fitter_ac62bf275718aafc95b5e49d0aa9fc1ef}{virtual const Measure\-Type {\bfseries get\-F\-Tolerance} () const }\label{class_ox_1_1_fitter_ac62bf275718aafc95b5e49d0aa9fc1ef}

\item 
\hypertarget{class_ox_1_1_fitter_aba3fc8ad5260390faf59e2f904ab6d6d}{virtual const bool {\bfseries get\-Use\-Gradient} () const }\label{class_ox_1_1_fitter_aba3fc8ad5260390faf59e2f904ab6d6d}

\item 
\hypertarget{class_ox_1_1_fitter_a04f36e075f86c6a89df833d17b9f029d}{virtual const unsigned int {\bfseries get\-Max\-Function\-Evals} () const }\label{class_ox_1_1_fitter_a04f36e075f86c6a89df833d17b9f029d}

\item 
\hypertarget{class_ox_1_1_fitter_a68e317f1c05ea2aa24f9d4803ee19215}{virtual const unsigned int {\bfseries get\-Thread\-Id} () const }\label{class_ox_1_1_fitter_a68e317f1c05ea2aa24f9d4803ee19215}

\item 
\hypertarget{class_ox_1_1_fitter_afeba16a2218db1f3fc646e2dde75f386}{virtual const bool {\bfseries get\-Verbose} () const }\label{class_ox_1_1_fitter_afeba16a2218db1f3fc646e2dde75f386}

\item 
\hypertarget{class_ox_1_1_fitter_a9c3401372be5c8698464deb05c0f5533}{virtual const bool {\bfseries get\-Trace} () const }\label{class_ox_1_1_fitter_a9c3401372be5c8698464deb05c0f5533}

\item 
\hypertarget{class_ox_1_1_fitter_a58bc5939283a694d4683dcc160ad4009}{virtual void {\bfseries set\-Model} (\hyperlink{class_ox_1_1_model}{Model}$<$ Measure\-Type $>$ $\ast$\-\_\-\-Model\-T1)}\label{class_ox_1_1_fitter_a58bc5939283a694d4683dcc160ad4009}

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

\item 
\hypertarget{class_ox_1_1_fitter_ad2b680ee88b12dd51538a2da865b2589}{virtual void {\bfseries set\-X\-Tolerance} (const Measure\-Type \-\_\-\-X\-Tolerance)}\label{class_ox_1_1_fitter_ad2b680ee88b12dd51538a2da865b2589}

\item 
\hypertarget{class_ox_1_1_fitter_a2441247888adc90a26d779043f10c5e1}{virtual void {\bfseries set\-Use\-Gradient} (const bool \-\_\-\-Use\-Gradient)}\label{class_ox_1_1_fitter_a2441247888adc90a26d779043f10c5e1}

\item 
\hypertarget{class_ox_1_1_fitter_aca7109a663e737c46cb29483c2276f4a}{virtual void {\bfseries set\-F\-Tolerance} (const Measure\-Type \-\_\-\-F\-Tolerance)}\label{class_ox_1_1_fitter_aca7109a663e737c46cb29483c2276f4a}

\item 
\hypertarget{class_ox_1_1_fitter_a293d2876b8b053bd637c35c3f6f3f68e}{virtual void {\bfseries set\-Max\-Function\-Evals} (const unsigned int \-\_\-\-Max\-Function\-Evals)}\label{class_ox_1_1_fitter_a293d2876b8b053bd637c35c3f6f3f68e}

\item 
\hypertarget{class_ox_1_1_fitter_aa1fc4674aa6a3e6c8567c86ec1fa90e0}{virtual void {\bfseries set\-Thread\-Id} (const unsigned int \-\_\-\-Thread\-Id)}\label{class_ox_1_1_fitter_aa1fc4674aa6a3e6c8567c86ec1fa90e0}

\item 
\hypertarget{class_ox_1_1_fitter_a696da03b83fe3083f29ae4c0e2ecfc44}{virtual void {\bfseries set\-Verbose} (const bool \-\_\-\-Verbose)}\label{class_ox_1_1_fitter_a696da03b83fe3083f29ae4c0e2ecfc44}

\item 
\hypertarget{class_ox_1_1_fitter_a4ac0096f6bc6d733c542d28a839d32c9}{virtual void {\bfseries set\-Trace} (const bool \-\_\-\-Trace)}\label{class_ox_1_1_fitter_a4ac0096f6bc6d733c542d28a839d32c9}

\item 
virtual void \hyperlink{class_ox_1_1_fitter_a783ba791c88d7208deb4004354b10022}{copy\-To\-Parameters} (const Measure\-Type $\ast$ptr\-From)
\item 
\hypertarget{class_ox_1_1_fitter_a0a9b45eb21ba174327f95a894e6331b6}{virtual void \hyperlink{class_ox_1_1_fitter_a0a9b45eb21ba174327f95a894e6331b6}{disp} ()}\label{class_ox_1_1_fitter_a0a9b45eb21ba174327f95a894e6331b6}

\begin{DoxyCompactList}\small\item\em show me your \hyperlink{class_ox_1_1_fitter}{Fitter} \end{DoxyCompactList}\item 
\hypertarget{class_ox_1_1_fitter_a7b42acb389394bc4c496990eea8b9ac9}{\hyperlink{class_ox_1_1_fitter_a7b42acb389394bc4c496990eea8b9ac9}{Fitter} ()}\label{class_ox_1_1_fitter_a7b42acb389394bc4c496990eea8b9ac9}

\begin{DoxyCompactList}\small\item\em constructor \end{DoxyCompactList}\item 
\hyperlink{class_ox_1_1_fitter_ac51130b722159f88a0dad59877b76417}{Fitter} (const \hyperlink{class_ox_1_1_fitter}{Fitter} \&old)
\item 
virtual \hyperlink{class_ox_1_1_fitter}{Fitter}$<$ Measure\-Type $>$ $\ast$ \hyperlink{class_ox_1_1_fitter_a665ec51e52ed351c9ef801acc83fbdea}{new\-By\-Cloning} ()=0
\item 
\hypertarget{class_ox_1_1_fitter_ab56eef37096f6f0687d83b8d15e00d43}{virtual \hyperlink{class_ox_1_1_fitter_ab56eef37096f6f0687d83b8d15e00d43}{$\sim$\-Fitter} ()}\label{class_ox_1_1_fitter_ab56eef37096f6f0687d83b8d15e00d43}

\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_fitter_abe055a1231bcc600f387f34194d7fc0e}{\hyperlink{class_ox_1_1_model}{Model}$<$ Measure\-Type $>$ $\ast$ {\bfseries \-\_\-\-Model\-T1}}\label{class_ox_1_1_fitter_abe055a1231bcc600f387f34194d7fc0e}

\item 
\hypertarget{class_ox_1_1_fitter_a508e5654aaf79dd744ec816d95b7e33c}{Measure\-Type $\ast$ {\bfseries \-\_\-\-Parameters}}\label{class_ox_1_1_fitter_a508e5654aaf79dd744ec816d95b7e33c}

\item 
\hypertarget{class_ox_1_1_fitter_af91a5ea8fb20072277ddcd64f5537b09}{Measure\-Type {\bfseries \-\_\-\-X\-Tolerance}}\label{class_ox_1_1_fitter_af91a5ea8fb20072277ddcd64f5537b09}

\item 
\hypertarget{class_ox_1_1_fitter_a926f6cf38998f041c31b079e93bf27ab}{Measure\-Type {\bfseries \-\_\-\-F\-Tolerance}}\label{class_ox_1_1_fitter_a926f6cf38998f041c31b079e93bf27ab}

\item 
\hypertarget{class_ox_1_1_fitter_a3be7ea1c1f19d3f4fb384474e2b1a033}{unsigned int {\bfseries \-\_\-\-Max\-Function\-Evals}}\label{class_ox_1_1_fitter_a3be7ea1c1f19d3f4fb384474e2b1a033}

\item 
\hypertarget{class_ox_1_1_fitter_a34c039e87d52c28b19092535a171264f}{bool {\bfseries \-\_\-\-Use\-Gradient}}\label{class_ox_1_1_fitter_a34c039e87d52c28b19092535a171264f}

\item 
\hypertarget{class_ox_1_1_fitter_a0d97d7a9c9fad0349484151464fefe4f}{unsigned int {\bfseries \-\_\-\-Thread\-Id}}\label{class_ox_1_1_fitter_a0d97d7a9c9fad0349484151464fefe4f}

\item 
\hypertarget{class_ox_1_1_fitter_a6457339f5252c85d7c92f20439544975}{bool {\bfseries \-\_\-\-Verbose}}\label{class_ox_1_1_fitter_a6457339f5252c85d7c92f20439544975}

\item 
\hypertarget{class_ox_1_1_fitter_a9ba79cb05ecc670254b3e7ddafc519ab}{bool {\bfseries \-\_\-\-Trace}}\label{class_ox_1_1_fitter_a9ba79cb05ecc670254b3e7ddafc519ab}

\end{DoxyCompactItemize}


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


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


\subsection{Constructor \& Destructor Documentation}
\hypertarget{class_ox_1_1_fitter_ac51130b722159f88a0dad59877b76417}{\index{Ox\-::\-Fitter@{Ox\-::\-Fitter}!Fitter@{Fitter}}
\index{Fitter@{Fitter}!Ox::Fitter@{Ox\-::\-Fitter}}
\subsubsection[{Fitter}]{\setlength{\rightskip}{0pt plus 5cm}template$<$typename Measure\-Type$>$ {\bf Ox\-::\-Fitter}$<$ Measure\-Type $>$\-::{\bf Fitter} (
\begin{DoxyParamCaption}
\item[{const {\bf Fitter}$<$ Measure\-Type $>$ \&}]{old}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily [inline]}}}\label{class_ox_1_1_fitter_ac51130b722159f88a0dad59877b76417}
copy constructor 
\begin{DoxyParams}{Parameters}
{\em old} & \\
\hline
\end{DoxyParams}


\subsection{Member Function Documentation}
\hypertarget{class_ox_1_1_fitter_a783ba791c88d7208deb4004354b10022}{\index{Ox\-::\-Fitter@{Ox\-::\-Fitter}!copy\-To\-Parameters@{copy\-To\-Parameters}}
\index{copy\-To\-Parameters@{copy\-To\-Parameters}!Ox::Fitter@{Ox\-::\-Fitter}}
\subsubsection[{copy\-To\-Parameters}]{\setlength{\rightskip}{0pt plus 5cm}template$<$typename Measure\-Type$>$ virtual void {\bf Ox\-::\-Fitter}$<$ Measure\-Type $>$\-::copy\-To\-Parameters (
\begin{DoxyParamCaption}
\item[{const Measure\-Type $\ast$}]{ptr\-From}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily [inline]}, {\ttfamily [virtual]}}}\label{class_ox_1_1_fitter_a783ba791c88d7208deb4004354b10022}
copy from ptr\-From to the parameters. Parameters have to be allocated first 
\begin{DoxyParams}{Parameters}
{\em ptr\-From} & \\
\hline
\end{DoxyParams}
\hypertarget{class_ox_1_1_fitter_a665ec51e52ed351c9ef801acc83fbdea}{\index{Ox\-::\-Fitter@{Ox\-::\-Fitter}!new\-By\-Cloning@{new\-By\-Cloning}}
\index{new\-By\-Cloning@{new\-By\-Cloning}!Ox::Fitter@{Ox\-::\-Fitter}}
\subsubsection[{new\-By\-Cloning}]{\setlength{\rightskip}{0pt plus 5cm}template$<$typename Measure\-Type$>$ virtual {\bf Fitter}$<$Measure\-Type$>$$\ast$ {\bf Ox\-::\-Fitter}$<$ Measure\-Type $>$\-::new\-By\-Cloning (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily [pure virtual]}}}\label{class_ox_1_1_fitter_a665ec51e52ed351c9ef801acc83fbdea}
cloning \begin{DoxyReturn}{Returns}

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


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