1
0
Files
SimulatedAnnealing/Rapport/latex/classModel.tex
2023-12-31 15:42:33 +01:00

222 lines
13 KiB
TeX
Executable File

\hypertarget{classModel}{}\doxysection{Model Class Reference}
\label{classModel}\index{Model@{Model}}
{\ttfamily \#include $<$models.\+h$>$}
Inheritance diagram for Model\+:\nopagebreak
\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=350pt]{classModel__inherit__graph}
\end{center}
\end{figure}
Collaboration diagram for Model\+:\nopagebreak
\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=270pt]{classModel__coll__graph}
\end{center}
\end{figure}
\doxysubsection*{Public Member Functions}
\begin{DoxyCompactItemize}
\item
\mbox{\hyperlink{classModel_ae3b375de5f6df4faf74a95d64748e048}{Model}} ()
\item
\mbox{\hyperlink{classModel_a0386968ae522e868e3b6028c8b154837}{Model}} (const \mbox{\hyperlink{classModel}{Model}} \&)
\item
\mbox{\hyperlink{classModel_a025b01adb30f6dabc80e5750e55c111e}{Model}} (\mbox{\hyperlink{classData}{Data}})
\item
virtual \mbox{\hyperlink{classModel_af032d8433c87a0a3a431faf6563a1f03}{$\sim$\+Model}} ()
\item
virtual void \mbox{\hyperlink{classModel_a55049e284aebdb5d8ce738d342a83d90}{set\+Model\+Data}} (\mbox{\hyperlink{classData}{Data}})
\item
virtual void \mbox{\hyperlink{classModel_a4765486c7efeac0e371b655dc9987473}{set\+Exp\+Data}} (\mbox{\hyperlink{classData}{Data}})
\item
virtual void \mbox{\hyperlink{classModel_a22466e6374da46ad87df1d60905e427d}{set\+Cost}} (\mbox{\hyperlink{classCostFunction}{Cost\+Function}} $\ast$)
\item
virtual \mbox{\hyperlink{classData}{Data}} \mbox{\hyperlink{classModel_a77a90ace8590b6360d7602fcd59ec850}{get\+Sol}} () const =0
\item
virtual void \mbox{\hyperlink{classModel_ac7b297577c2e6220842f2c0aa8fb3728}{set\+Param}} (std\+::vector$<$ double $>$)
\item
virtual std\+::vector$<$ double $>$ \mbox{\hyperlink{classModel_aa8a144aa7a9c636e5770b2cfe780dfc1}{get\+Param}} () const =0
\item
virtual std\+::vector$<$ double $>$ \mbox{\hyperlink{classModel_a5742e9709016b3b839e66bb73c239d15}{get\+Neighbor}} (double) const =0
\item
virtual double \mbox{\hyperlink{classModel_a2eb34665190554e9ec728dcc3ad2dd57}{get\+Cost}} ()=0
\item
virtual void \mbox{\hyperlink{classModel_adc89c69e73ec65f31e082e4dbe5464a3}{export\+Model}} () const =0
\item
virtual void \mbox{\hyperlink{classModel_a2bc1c492dc8d485f5402f0c23f465808}{display\+Model}} () const =0
\end{DoxyCompactItemize}
\doxysubsection*{Protected Attributes}
\begin{DoxyCompactItemize}
\item
\mbox{\hyperlink{classData}{Data}} \mbox{\hyperlink{classModel_ae8b5b16a6aa2231446c800bba1dbc5c3}{m\+\_\+data}}
\item
\mbox{\hyperlink{classData}{Data}} \mbox{\hyperlink{classModel_af15b84e853d1bfeb51eb63325a3a780a}{exp\+\_\+data}}
\item
\mbox{\hyperlink{classCostFunction}{Cost\+Function}} $\ast$ \mbox{\hyperlink{classModel_a3a23a55c42e9d91ce99d3f8bb827fbd9}{m\+\_\+cost}}
\end{DoxyCompactItemize}
\doxysubsection{Constructor \& Destructor Documentation}
\mbox{\Hypertarget{classModel_ae3b375de5f6df4faf74a95d64748e048}\label{classModel_ae3b375de5f6df4faf74a95d64748e048}}
\index{Model@{Model}!Model@{Model}}
\index{Model@{Model}!Model@{Model}}
\doxysubsubsection{\texorpdfstring{Model()}{Model()}\hspace{0.1cm}{\footnotesize\ttfamily [1/3]}}
{\footnotesize\ttfamily Model\+::\+Model (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})}
\mbox{\Hypertarget{classModel_a0386968ae522e868e3b6028c8b154837}\label{classModel_a0386968ae522e868e3b6028c8b154837}}
\index{Model@{Model}!Model@{Model}}
\index{Model@{Model}!Model@{Model}}
\doxysubsubsection{\texorpdfstring{Model()}{Model()}\hspace{0.1cm}{\footnotesize\ttfamily [2/3]}}
{\footnotesize\ttfamily Model\+::\+Model (\begin{DoxyParamCaption}\item[{const \mbox{\hyperlink{classModel}{Model}} \&}]{other }\end{DoxyParamCaption})}
\mbox{\Hypertarget{classModel_a025b01adb30f6dabc80e5750e55c111e}\label{classModel_a025b01adb30f6dabc80e5750e55c111e}}
\index{Model@{Model}!Model@{Model}}
\index{Model@{Model}!Model@{Model}}
\doxysubsubsection{\texorpdfstring{Model()}{Model()}\hspace{0.1cm}{\footnotesize\ttfamily [3/3]}}
{\footnotesize\ttfamily Model\+::\+Model (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{classData}{Data}}}]{T }\end{DoxyParamCaption})}
\mbox{\Hypertarget{classModel_af032d8433c87a0a3a431faf6563a1f03}\label{classModel_af032d8433c87a0a3a431faf6563a1f03}}
\index{Model@{Model}!````~Model@{$\sim$Model}}
\index{````~Model@{$\sim$Model}!Model@{Model}}
\doxysubsubsection{\texorpdfstring{$\sim$Model()}{~Model()}}
{\footnotesize\ttfamily virtual Model\+::$\sim$\+Model (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}, {\ttfamily [virtual]}}
\doxysubsection{Member Function Documentation}
\mbox{\Hypertarget{classModel_a2bc1c492dc8d485f5402f0c23f465808}\label{classModel_a2bc1c492dc8d485f5402f0c23f465808}}
\index{Model@{Model}!displayModel@{displayModel}}
\index{displayModel@{displayModel}!Model@{Model}}
\doxysubsubsection{\texorpdfstring{displayModel()}{displayModel()}}
{\footnotesize\ttfamily virtual void Model\+::display\+Model (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [pure virtual]}}
Implemented in \mbox{\hyperlink{classTSP_ac25b5470884ae8e06672c9bd8e9abe37}{T\+SP}}, \mbox{\hyperlink{classPolynomialApprox_aef375908b82ed484d771e9c92fdb598e}{Polynomial\+Approx}}, and \mbox{\hyperlink{classLinearApprox_a824b06137f93c3fb0cb6228038e80f01}{Linear\+Approx}}.
\mbox{\Hypertarget{classModel_adc89c69e73ec65f31e082e4dbe5464a3}\label{classModel_adc89c69e73ec65f31e082e4dbe5464a3}}
\index{Model@{Model}!exportModel@{exportModel}}
\index{exportModel@{exportModel}!Model@{Model}}
\doxysubsubsection{\texorpdfstring{exportModel()}{exportModel()}}
{\footnotesize\ttfamily virtual void Model\+::export\+Model (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [pure virtual]}}
Implemented in \mbox{\hyperlink{classTSP_a234e5ae530133d781e80c57ce5cbab0e}{T\+SP}}, \mbox{\hyperlink{classPolynomialApprox_a41c0ecc9346c128962c1adb6d0bcaf3c}{Polynomial\+Approx}}, and \mbox{\hyperlink{classLinearApprox_af2932daf011b572ffa41bfc32c545d71}{Linear\+Approx}}.
\mbox{\Hypertarget{classModel_a2eb34665190554e9ec728dcc3ad2dd57}\label{classModel_a2eb34665190554e9ec728dcc3ad2dd57}}
\index{Model@{Model}!getCost@{getCost}}
\index{getCost@{getCost}!Model@{Model}}
\doxysubsubsection{\texorpdfstring{getCost()}{getCost()}}
{\footnotesize\ttfamily virtual double Model\+::get\+Cost (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [pure virtual]}}
Implemented in \mbox{\hyperlink{classTSP_a88a596ca1fc98835a81a8b2e63428327}{T\+SP}}, \mbox{\hyperlink{classPolynomialApprox_a4c4b2ab53d34e03ca4b914cb84cf5b4e}{Polynomial\+Approx}}, and \mbox{\hyperlink{classLinearApprox_afff1f531c2348c5c7fc0a1ac73727466}{Linear\+Approx}}.
\mbox{\Hypertarget{classModel_a5742e9709016b3b839e66bb73c239d15}\label{classModel_a5742e9709016b3b839e66bb73c239d15}}
\index{Model@{Model}!getNeighbor@{getNeighbor}}
\index{getNeighbor@{getNeighbor}!Model@{Model}}
\doxysubsubsection{\texorpdfstring{getNeighbor()}{getNeighbor()}}
{\footnotesize\ttfamily virtual std\+::vector$<$double$>$ Model\+::get\+Neighbor (\begin{DoxyParamCaption}\item[{double}]{ }\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [pure virtual]}}
Implemented in \mbox{\hyperlink{classTSP_ab97eddebb80d9c8521bc5654d695d07a}{T\+SP}}, \mbox{\hyperlink{classPolynomialApprox_aa20c8510003c55224b4bb237fd2b95fd}{Polynomial\+Approx}}, and \mbox{\hyperlink{classLinearApprox_a9162626b147e73531cca3d9c0fdea346}{Linear\+Approx}}.
\mbox{\Hypertarget{classModel_aa8a144aa7a9c636e5770b2cfe780dfc1}\label{classModel_aa8a144aa7a9c636e5770b2cfe780dfc1}}
\index{Model@{Model}!getParam@{getParam}}
\index{getParam@{getParam}!Model@{Model}}
\doxysubsubsection{\texorpdfstring{getParam()}{getParam()}}
{\footnotesize\ttfamily virtual std\+::vector$<$double$>$ Model\+::get\+Param (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [pure virtual]}}
Implemented in \mbox{\hyperlink{classTSP_a4ac44600ca8b029fda5beb30c233be0b}{T\+SP}}, \mbox{\hyperlink{classPolynomialApprox_a2be8954337e15407e840bec443268e61}{Polynomial\+Approx}}, and \mbox{\hyperlink{classLinearApprox_a0d0429599a93dfd3ca8dd8cc84d22f88}{Linear\+Approx}}.
\mbox{\Hypertarget{classModel_a77a90ace8590b6360d7602fcd59ec850}\label{classModel_a77a90ace8590b6360d7602fcd59ec850}}
\index{Model@{Model}!getSol@{getSol}}
\index{getSol@{getSol}!Model@{Model}}
\doxysubsubsection{\texorpdfstring{getSol()}{getSol()}}
{\footnotesize\ttfamily virtual \mbox{\hyperlink{classData}{Data}} Model\+::get\+Sol (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [pure virtual]}}
Implemented in \mbox{\hyperlink{classTSP_a4badbbda733f8a2337c1f593cc42313d}{T\+SP}}, \mbox{\hyperlink{classPolynomialApprox_a3b91fc267c2160ea6eaf9f43b6b0599d}{Polynomial\+Approx}}, and \mbox{\hyperlink{classLinearApprox_acb7999893726e2f700978cb900fc63fe}{Linear\+Approx}}.
\mbox{\Hypertarget{classModel_a22466e6374da46ad87df1d60905e427d}\label{classModel_a22466e6374da46ad87df1d60905e427d}}
\index{Model@{Model}!setCost@{setCost}}
\index{setCost@{setCost}!Model@{Model}}
\doxysubsubsection{\texorpdfstring{setCost()}{setCost()}}
{\footnotesize\ttfamily void Model\+::set\+Cost (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{classCostFunction}{Cost\+Function}} $\ast$}]{f }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [virtual]}}
Reimplemented in \mbox{\hyperlink{classTSP_a9b4d44be9257539efc63c9d088bba99b}{T\+SP}}, \mbox{\hyperlink{classPolynomialApprox_aa4ab97ae60bce807a6cd3e3af05dc6fa}{Polynomial\+Approx}}, and \mbox{\hyperlink{classLinearApprox_ae859d40c6ce1d78a8a57ebefe069b7ef}{Linear\+Approx}}.
\mbox{\Hypertarget{classModel_a4765486c7efeac0e371b655dc9987473}\label{classModel_a4765486c7efeac0e371b655dc9987473}}
\index{Model@{Model}!setExpData@{setExpData}}
\index{setExpData@{setExpData}!Model@{Model}}
\doxysubsubsection{\texorpdfstring{setExpData()}{setExpData()}}
{\footnotesize\ttfamily void Model\+::set\+Exp\+Data (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{classData}{Data}}}]{T2 }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [virtual]}}
Reimplemented in \mbox{\hyperlink{classTSP_a3f0ca3c4e220676e0f4dd2df952e05a5}{T\+SP}}, \mbox{\hyperlink{classPolynomialApprox_aaa2e58d7ed15c376b24d4e58f71a9fba}{Polynomial\+Approx}}, and \mbox{\hyperlink{classLinearApprox_a07405c8bd2b5de44df55791e4693a979}{Linear\+Approx}}.
\mbox{\Hypertarget{classModel_a55049e284aebdb5d8ce738d342a83d90}\label{classModel_a55049e284aebdb5d8ce738d342a83d90}}
\index{Model@{Model}!setModelData@{setModelData}}
\index{setModelData@{setModelData}!Model@{Model}}
\doxysubsubsection{\texorpdfstring{setModelData()}{setModelData()}}
{\footnotesize\ttfamily void Model\+::set\+Model\+Data (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{classData}{Data}}}]{T1 }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [virtual]}}
Reimplemented in \mbox{\hyperlink{classTSP_ad6bf10c3dac3211c9ab3075adb08b8db}{T\+SP}}, \mbox{\hyperlink{classPolynomialApprox_a9d3f1fc7eb6fa4bd2001f9911a64363a}{Polynomial\+Approx}}, and \mbox{\hyperlink{classLinearApprox_add22c2da479a38dc69aa66b0ecb05647}{Linear\+Approx}}.
\mbox{\Hypertarget{classModel_ac7b297577c2e6220842f2c0aa8fb3728}\label{classModel_ac7b297577c2e6220842f2c0aa8fb3728}}
\index{Model@{Model}!setParam@{setParam}}
\index{setParam@{setParam}!Model@{Model}}
\doxysubsubsection{\texorpdfstring{setParam()}{setParam()}}
{\footnotesize\ttfamily virtual void Model\+::set\+Param (\begin{DoxyParamCaption}\item[{std\+::vector$<$ double $>$}]{ }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}, {\ttfamily [virtual]}}
Reimplemented in \mbox{\hyperlink{classTSP_af881bef7213735b3d47b0a7bbd1b17fd}{T\+SP}}, \mbox{\hyperlink{classPolynomialApprox_a188bf0dde349878c63e81ae32fd02ae6}{Polynomial\+Approx}}, and \mbox{\hyperlink{classLinearApprox_a5cb23c120f3345b4d66594284c3ec72e}{Linear\+Approx}}.
\doxysubsection{Field Documentation}
\mbox{\Hypertarget{classModel_af15b84e853d1bfeb51eb63325a3a780a}\label{classModel_af15b84e853d1bfeb51eb63325a3a780a}}
\index{Model@{Model}!exp\_data@{exp\_data}}
\index{exp\_data@{exp\_data}!Model@{Model}}
\doxysubsubsection{\texorpdfstring{exp\_data}{exp\_data}}
{\footnotesize\ttfamily \mbox{\hyperlink{classData}{Data}} Model\+::exp\+\_\+data\hspace{0.3cm}{\ttfamily [protected]}}
\mbox{\Hypertarget{classModel_a3a23a55c42e9d91ce99d3f8bb827fbd9}\label{classModel_a3a23a55c42e9d91ce99d3f8bb827fbd9}}
\index{Model@{Model}!m\_cost@{m\_cost}}
\index{m\_cost@{m\_cost}!Model@{Model}}
\doxysubsubsection{\texorpdfstring{m\_cost}{m\_cost}}
{\footnotesize\ttfamily \mbox{\hyperlink{classCostFunction}{Cost\+Function}}$\ast$ Model\+::m\+\_\+cost\hspace{0.3cm}{\ttfamily [protected]}}
\mbox{\Hypertarget{classModel_ae8b5b16a6aa2231446c800bba1dbc5c3}\label{classModel_ae8b5b16a6aa2231446c800bba1dbc5c3}}
\index{Model@{Model}!m\_data@{m\_data}}
\index{m\_data@{m\_data}!Model@{Model}}
\doxysubsubsection{\texorpdfstring{m\_data}{m\_data}}
{\footnotesize\ttfamily \mbox{\hyperlink{classData}{Data}} Model\+::m\+\_\+data\hspace{0.3cm}{\ttfamily [protected]}}
The documentation for this class was generated from the following files\+:\begin{DoxyCompactItemize}
\item
\mbox{\hyperlink{models_8h}{models.\+h}}\item
\mbox{\hyperlink{models_8cpp}{models.\+cpp}}\end{DoxyCompactItemize}