doxytest/docs/latex/classtest_1_1Calculator.tex
2025-01-28 01:15:18 +01:00

105 lines
5.2 KiB
TeX

\hypertarget{classtest_1_1Calculator}{}\doxysection{test.\+Calculator Class Reference}
\label{classtest_1_1Calculator}\index{test.Calculator@{test.Calculator}}
\doxysubsection*{Public Member Functions}
\begin{DoxyCompactItemize}
\item
def \mbox{\hyperlink{classtest_1_1Calculator_a350c5ee9551106bcadf487abe983f1ce}{\+\_\+\+\_\+init\+\_\+\+\_\+}} (self, value=0)
\item
def \mbox{\hyperlink{classtest_1_1Calculator_a3b0de864b2501e6cbe51d374023d9485}{add}} (self, number)
\item
def \mbox{\hyperlink{classtest_1_1Calculator_a398ce099422193d3a814a23df307af40}{subtract}} (self, number)
\item
def \mbox{\hyperlink{classtest_1_1Calculator_a4ebb4c4221c4e2b12dc417a1704dc79b}{multiply}} (self, number)
\item
def \mbox{\hyperlink{classtest_1_1Calculator_a39ad2dc1258dd50fd2970d7627f14219}{divide}} (self, number)
\item
def \mbox{\hyperlink{classtest_1_1Calculator_aef3f4068440573b93e3c5fb556964223}{clear}} (self)
\end{DoxyCompactItemize}
\doxysubsection*{Public Attributes}
\begin{DoxyCompactItemize}
\item
\mbox{\Hypertarget{classtest_1_1Calculator_ab35d98546e4ad522f5b85254c435e7ae}\label{classtest_1_1Calculator_ab35d98546e4ad522f5b85254c435e7ae}}
{\bfseries value}
\end{DoxyCompactItemize}
\doxysubsection{Detailed Description}
\begin{DoxyVerb}A simple calculator class to perform basic arithmetic operations.
\end{DoxyVerb}
\doxysubsection{Constructor \& Destructor Documentation}
\mbox{\Hypertarget{classtest_1_1Calculator_a350c5ee9551106bcadf487abe983f1ce}\label{classtest_1_1Calculator_a350c5ee9551106bcadf487abe983f1ce}}
\index{test.Calculator@{test.Calculator}!\_\_init\_\_@{\_\_init\_\_}}
\index{\_\_init\_\_@{\_\_init\_\_}!test.Calculator@{test.Calculator}}
\doxysubsubsection{\texorpdfstring{\_\_init\_\_()}{\_\_init\_\_()}}
{\footnotesize\ttfamily def test.\+Calculator.\+\_\+\+\_\+init\+\_\+\+\_\+ (\begin{DoxyParamCaption}\item[{}]{self, }\item[{}]{value = {\ttfamily 0} }\end{DoxyParamCaption})}
\begin{DoxyVerb}Initializes the calculator with a starting value.
:param value: The starting value of the calculator (default is 0).
\end{DoxyVerb}
\doxysubsection{Member Function Documentation}
\mbox{\Hypertarget{classtest_1_1Calculator_a3b0de864b2501e6cbe51d374023d9485}\label{classtest_1_1Calculator_a3b0de864b2501e6cbe51d374023d9485}}
\index{test.Calculator@{test.Calculator}!add@{add}}
\index{add@{add}!test.Calculator@{test.Calculator}}
\doxysubsubsection{\texorpdfstring{add()}{add()}}
{\footnotesize\ttfamily def test.\+Calculator.\+add (\begin{DoxyParamCaption}\item[{}]{self, }\item[{}]{number }\end{DoxyParamCaption})}
\begin{DoxyVerb}Adds a number to the current value.
:param number: The number to add.
:return: The updated value after addition.
\end{DoxyVerb}
\mbox{\Hypertarget{classtest_1_1Calculator_aef3f4068440573b93e3c5fb556964223}\label{classtest_1_1Calculator_aef3f4068440573b93e3c5fb556964223}}
\index{test.Calculator@{test.Calculator}!clear@{clear}}
\index{clear@{clear}!test.Calculator@{test.Calculator}}
\doxysubsubsection{\texorpdfstring{clear()}{clear()}}
{\footnotesize\ttfamily def test.\+Calculator.\+clear (\begin{DoxyParamCaption}\item[{}]{self }\end{DoxyParamCaption})}
\begin{DoxyVerb}Resets the calculator to its initial value (0).
:return: The reset value (0).
\end{DoxyVerb}
\mbox{\Hypertarget{classtest_1_1Calculator_a39ad2dc1258dd50fd2970d7627f14219}\label{classtest_1_1Calculator_a39ad2dc1258dd50fd2970d7627f14219}}
\index{test.Calculator@{test.Calculator}!divide@{divide}}
\index{divide@{divide}!test.Calculator@{test.Calculator}}
\doxysubsubsection{\texorpdfstring{divide()}{divide()}}
{\footnotesize\ttfamily def test.\+Calculator.\+divide (\begin{DoxyParamCaption}\item[{}]{self, }\item[{}]{number }\end{DoxyParamCaption})}
\begin{DoxyVerb}Divides the current value by the given number.
:param number: The number to divide by.
:return: The updated value after division.
:raises ZeroDivisionError: If the number is zero.
\end{DoxyVerb}
\mbox{\Hypertarget{classtest_1_1Calculator_a4ebb4c4221c4e2b12dc417a1704dc79b}\label{classtest_1_1Calculator_a4ebb4c4221c4e2b12dc417a1704dc79b}}
\index{test.Calculator@{test.Calculator}!multiply@{multiply}}
\index{multiply@{multiply}!test.Calculator@{test.Calculator}}
\doxysubsubsection{\texorpdfstring{multiply()}{multiply()}}
{\footnotesize\ttfamily def test.\+Calculator.\+multiply (\begin{DoxyParamCaption}\item[{}]{self, }\item[{}]{number }\end{DoxyParamCaption})}
\begin{DoxyVerb}Multiplies the current value by a given number.
:param number: The number to multiply with.
:return: The updated value after multiplication.
\end{DoxyVerb}
\mbox{\Hypertarget{classtest_1_1Calculator_a398ce099422193d3a814a23df307af40}\label{classtest_1_1Calculator_a398ce099422193d3a814a23df307af40}}
\index{test.Calculator@{test.Calculator}!subtract@{subtract}}
\index{subtract@{subtract}!test.Calculator@{test.Calculator}}
\doxysubsubsection{\texorpdfstring{subtract()}{subtract()}}
{\footnotesize\ttfamily def test.\+Calculator.\+subtract (\begin{DoxyParamCaption}\item[{}]{self, }\item[{}]{number }\end{DoxyParamCaption})}
\begin{DoxyVerb}Subtracts a number from the current value.
:param number: The number to subtract.
:return: The updated value after subtraction.
\end{DoxyVerb}
The documentation for this class was generated from the following file\+:\begin{DoxyCompactItemize}
\item
src/test.\+py\end{DoxyCompactItemize}