swh:1:snp:e6d42e6731ce66e3c09de07ac49964c03139e990
Tip revision: 26b818c8be2be41dd673d938b403c5c7562635de authored by Travis CI on 28 November 2019, 13:55:12 UTC
Deploy code docs to GitHub Pages Travis build: 305
Deploy code docs to GitHub Pages Travis build: 305
Tip revision: 26b818c
class_ox_1_1_model_t1_shmolli.tex
\hypertarget{class_ox_1_1_model_t1_shmolli}{\section{Ox\-:\-:Model\-T1\-Shmolli$<$ Measure\-Type $>$ Class Template Reference}
\label{class_ox_1_1_model_t1_shmolli}\index{Ox\-::\-Model\-T1\-Shmolli$<$ Measure\-Type $>$@{Ox\-::\-Model\-T1\-Shmolli$<$ Measure\-Type $>$}}
}
Container for a Calculator\-Shmolli model function $ A-B\exp(t/T_1^*) $, cost function and Least-\/\-Squares function and derivatives.
{\ttfamily \#include $<$Ox\-Model\-T1\-Shmolli.\-h$>$}
Inheritance diagram for Ox\-:\-:Model\-T1\-Shmolli$<$ Measure\-Type $>$\-:
\nopagebreak
\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=218pt]{class_ox_1_1_model_t1_shmolli__inherit__graph}
\end{center}
\end{figure}
Collaboration diagram for Ox\-:\-:Model\-T1\-Shmolli$<$ Measure\-Type $>$\-:
\nopagebreak
\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=218pt]{class_ox_1_1_model_t1_shmolli__coll__graph}
\end{center}
\end{figure}
\subsection*{Public Member Functions}
\begin{DoxyCompactItemize}
\item
virtual Measure\-Type \hyperlink{class_ox_1_1_model_t1_shmolli_a72576d4db2ff938037c3d9d4fe25b9d7}{calc\-Model\-Value} (const Measure\-Type $\ast$parameters, Measure\-Type time)
\item
virtual void \hyperlink{class_ox_1_1_model_t1_shmolli_ae393758f44f51e2fddae4c3c919fe4db}{calc\-L\-S\-Residuals} (const Measure\-Type $\ast$parameters, Measure\-Type $\ast$residuals)
\item
virtual void \hyperlink{class_ox_1_1_model_t1_shmolli_a667e5c9088ba65e0cba506246671e3da}{calc\-L\-S\-Jacobian} (const Measure\-Type $\ast$parameters, Measure\-Type $\ast$jacobian)
\item
virtual Measure\-Type \hyperlink{class_ox_1_1_model_t1_shmolli_a0f9b89832a6321b5b54abb9e219e803d}{calc\-Cost\-Value} (const Measure\-Type $\ast$parameters)
\item
virtual void \hyperlink{class_ox_1_1_model_t1_shmolli_afaadbc879361f3ea674fe79a9fc1cf49}{calc\-Cost\-Derivative} (const Measure\-Type $\ast$parameters, Measure\-Type $\ast$derivative)
\item
virtual \hyperlink{class_ox_1_1_model}{Model}$<$ Measure\-Type $>$ $\ast$ \hyperlink{class_ox_1_1_model_t1_shmolli_a846fb817183738d5c2b3f9f126c1597b}{new\-By\-Cloning} ()
\item
\hypertarget{class_ox_1_1_model_t1_shmolli_ad5dd9c59e049f1c356541ac278bc1e18}{virtual \hyperlink{class_ox_1_1_model_t1_shmolli_ad5dd9c59e049f1c356541ac278bc1e18}{$\sim$\-Model\-T1\-Shmolli} ()}\label{class_ox_1_1_model_t1_shmolli_ad5dd9c59e049f1c356541ac278bc1e18}
\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*{Public Attributes}
\begin{DoxyCompactItemize}
\item
\hypertarget{class_ox_1_1_model_t1_shmolli_a9ef12784ac237845296da239cd4517f2}{bool {\bfseries \-\_\-exp\-Abs\-Cost}}\label{class_ox_1_1_model_t1_shmolli_a9ef12784ac237845296da239cd4517f2}
\item
\hypertarget{class_ox_1_1_model_t1_shmolli_aa7fd686c2f08a4ed27d33b934fcad37f}{bool {\bfseries \-\_\-prevent\-Under\-Over\-Flow}}\label{class_ox_1_1_model_t1_shmolli_aa7fd686c2f08a4ed27d33b934fcad37f}
\item
\hypertarget{class_ox_1_1_model_t1_shmolli_adc598e5bee08606512d2a823536f7b3d}{bool {\bfseries \-\_\-cost\-Heuristic}}\label{class_ox_1_1_model_t1_shmolli_adc598e5bee08606512d2a823536f7b3d}
\item
\hypertarget{class_ox_1_1_model_t1_shmolli_a043784373e50e27f8dfbdd42d82eb290}{bool {\bfseries \-\_\-root\-Median\-Square\-Cost}}\label{class_ox_1_1_model_t1_shmolli_a043784373e50e27f8dfbdd42d82eb290}
\end{DoxyCompactItemize}
\subsection*{Additional Inherited Members}
\subsection{Detailed Description}
\subsubsection*{template$<$typename Measure\-Type$>$class Ox\-::\-Model\-T1\-Shmolli$<$ Measure\-Type $>$}
Container for a Calculator\-Shmolli model function $ A-B\exp(t/T_1^*) $, cost function and Least-\/\-Squares function and derivatives.
\begin{DoxyTemplParams}{Template Parameters}
{\em Measure\-Type} & \\
\hline
\end{DoxyTemplParams}
\subsection{Member Function Documentation}
\hypertarget{class_ox_1_1_model_t1_shmolli_afaadbc879361f3ea674fe79a9fc1cf49}{\index{Ox\-::\-Model\-T1\-Shmolli@{Ox\-::\-Model\-T1\-Shmolli}!calc\-Cost\-Derivative@{calc\-Cost\-Derivative}}
\index{calc\-Cost\-Derivative@{calc\-Cost\-Derivative}!Ox::ModelT1Shmolli@{Ox\-::\-Model\-T1\-Shmolli}}
\subsubsection[{calc\-Cost\-Derivative}]{\setlength{\rightskip}{0pt plus 5cm}template$<$typename Measure\-Type $>$ void {\bf Ox\-::\-Model\-T1\-Shmolli}$<$ Measure\-Type $>$\-::calc\-Cost\-Derivative (
\begin{DoxyParamCaption}
\item[{const Measure\-Type $\ast$}]{parameters, }
\item[{Measure\-Type $\ast$}]{derivative}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily [virtual]}}}\label{class_ox_1_1_model_t1_shmolli_afaadbc879361f3ea674fe79a9fc1cf49}
calc\-Cost\-Derivative the most important function of this class
\begin{DoxyParams}{Parameters}
{\em derivative} & \\
\hline
\end{DoxyParams}
Implements \hyperlink{class_ox_1_1_model_a274f0efdbbc364e82bba7470f933eecd}{Ox\-::\-Model$<$ Measure\-Type $>$}.
\hypertarget{class_ox_1_1_model_t1_shmolli_a0f9b89832a6321b5b54abb9e219e803d}{\index{Ox\-::\-Model\-T1\-Shmolli@{Ox\-::\-Model\-T1\-Shmolli}!calc\-Cost\-Value@{calc\-Cost\-Value}}
\index{calc\-Cost\-Value@{calc\-Cost\-Value}!Ox::ModelT1Shmolli@{Ox\-::\-Model\-T1\-Shmolli}}
\subsubsection[{calc\-Cost\-Value}]{\setlength{\rightskip}{0pt plus 5cm}template$<$typename Measure\-Type $>$ Measure\-Type {\bf Ox\-::\-Model\-T1\-Shmolli}$<$ Measure\-Type $>$\-::calc\-Cost\-Value (
\begin{DoxyParamCaption}
\item[{const Measure\-Type $\ast$}]{parameters}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily [virtual]}}}\label{class_ox_1_1_model_t1_shmolli_a0f9b89832a6321b5b54abb9e219e803d}
calc\-Cost\-Value the most important function of this class \begin{DoxyReturn}{Returns}
\end{DoxyReturn}
Implements \hyperlink{class_ox_1_1_model_aa5997cea7114d0e323e79956adb13ba4}{Ox\-::\-Model$<$ Measure\-Type $>$}.
\hypertarget{class_ox_1_1_model_t1_shmolli_a667e5c9088ba65e0cba506246671e3da}{\index{Ox\-::\-Model\-T1\-Shmolli@{Ox\-::\-Model\-T1\-Shmolli}!calc\-L\-S\-Jacobian@{calc\-L\-S\-Jacobian}}
\index{calc\-L\-S\-Jacobian@{calc\-L\-S\-Jacobian}!Ox::ModelT1Shmolli@{Ox\-::\-Model\-T1\-Shmolli}}
\subsubsection[{calc\-L\-S\-Jacobian}]{\setlength{\rightskip}{0pt plus 5cm}template$<$typename Measure\-Type $>$ void {\bf Ox\-::\-Model\-T1\-Shmolli}$<$ Measure\-Type $>$\-::calc\-L\-S\-Jacobian (
\begin{DoxyParamCaption}
\item[{const Measure\-Type $\ast$}]{parameters, }
\item[{Measure\-Type $\ast$}]{jacobian}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily [virtual]}}}\label{class_ox_1_1_model_t1_shmolli_a667e5c9088ba65e0cba506246671e3da}
calc\-L\-S\-Jacobian the most important function of this class
\begin{DoxyParams}{Parameters}
{\em jacobian} & -\/ 2d matrix stored as 1d array \\
\hline
\end{DoxyParams}
Implements \hyperlink{class_ox_1_1_model_a4cadb65b8416b4b30e91bf6db00737f3}{Ox\-::\-Model$<$ Measure\-Type $>$}.
\hypertarget{class_ox_1_1_model_t1_shmolli_ae393758f44f51e2fddae4c3c919fe4db}{\index{Ox\-::\-Model\-T1\-Shmolli@{Ox\-::\-Model\-T1\-Shmolli}!calc\-L\-S\-Residuals@{calc\-L\-S\-Residuals}}
\index{calc\-L\-S\-Residuals@{calc\-L\-S\-Residuals}!Ox::ModelT1Shmolli@{Ox\-::\-Model\-T1\-Shmolli}}
\subsubsection[{calc\-L\-S\-Residuals}]{\setlength{\rightskip}{0pt plus 5cm}template$<$typename Measure\-Type $>$ void {\bf Ox\-::\-Model\-T1\-Shmolli}$<$ Measure\-Type $>$\-::calc\-L\-S\-Residuals (
\begin{DoxyParamCaption}
\item[{const Measure\-Type $\ast$}]{parameters, }
\item[{Measure\-Type $\ast$}]{residuals}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily [virtual]}}}\label{class_ox_1_1_model_t1_shmolli_ae393758f44f51e2fddae4c3c919fe4db}
calc\-L\-S\-Residuals the most important function of this class
\begin{DoxyParams}{Parameters}
{\em residuals} & \\
\hline
\end{DoxyParams}
Implements \hyperlink{class_ox_1_1_model_a17e0ef71135350d4f61bef2a097fb586}{Ox\-::\-Model$<$ Measure\-Type $>$}.
\hypertarget{class_ox_1_1_model_t1_shmolli_a72576d4db2ff938037c3d9d4fe25b9d7}{\index{Ox\-::\-Model\-T1\-Shmolli@{Ox\-::\-Model\-T1\-Shmolli}!calc\-Model\-Value@{calc\-Model\-Value}}
\index{calc\-Model\-Value@{calc\-Model\-Value}!Ox::ModelT1Shmolli@{Ox\-::\-Model\-T1\-Shmolli}}
\subsubsection[{calc\-Model\-Value}]{\setlength{\rightskip}{0pt plus 5cm}template$<$typename Measure\-Type $>$ Measure\-Type {\bf Ox\-::\-Model\-T1\-Shmolli}$<$ Measure\-Type $>$\-::calc\-Model\-Value (
\begin{DoxyParamCaption}
\item[{const Measure\-Type $\ast$}]{parameters, }
\item[{Measure\-Type}]{time}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily [virtual]}}}\label{class_ox_1_1_model_t1_shmolli_a72576d4db2ff938037c3d9d4fe25b9d7}
calc\-Model\-Value the most important function of this class
\begin{DoxyParams}{Parameters}
{\em time} & \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
model(time)
\end{DoxyReturn}
Implements \hyperlink{class_ox_1_1_model_ae3a3f5bfeefd8a8c0c012e1761eac1f5}{Ox\-::\-Model$<$ Measure\-Type $>$}.
\hypertarget{class_ox_1_1_model_t1_shmolli_a846fb817183738d5c2b3f9f126c1597b}{\index{Ox\-::\-Model\-T1\-Shmolli@{Ox\-::\-Model\-T1\-Shmolli}!new\-By\-Cloning@{new\-By\-Cloning}}
\index{new\-By\-Cloning@{new\-By\-Cloning}!Ox::ModelT1Shmolli@{Ox\-::\-Model\-T1\-Shmolli}}
\subsubsection[{new\-By\-Cloning}]{\setlength{\rightskip}{0pt plus 5cm}template$<$typename Measure\-Type$>$ virtual {\bf Model}$<$Measure\-Type$>$$\ast$ {\bf Ox\-::\-Model\-T1\-Shmolli}$<$ Measure\-Type $>$\-::new\-By\-Cloning (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily [inline]}, {\ttfamily [virtual]}}}\label{class_ox_1_1_model_t1_shmolli_a846fb817183738d5c2b3f9f126c1597b}
cloning \begin{DoxyReturn}{Returns}
\end{DoxyReturn}
Implements \hyperlink{class_ox_1_1_model_a694868476dd17a4d203f4ebc57047d2f}{Ox\-::\-Model$<$ Measure\-Type $>$}.
The documentation for this class was generated from the following files\-:\begin{DoxyCompactItemize}
\item
lib/\hyperlink{_ox_model_t1_shmolli_8h}{Ox\-Model\-T1\-Shmolli.\-h}\item
lib/\hyperlink{_ox_model_t1_shmolli_8hxx}{Ox\-Model\-T1\-Shmolli.\-hxx}\end{DoxyCompactItemize}