105 lines
5.1 KiB
TeX
105 lines
5.1 KiB
TeX
\doxysection{test.\+Calculator Class Reference}
|
|
\hypertarget{classtest_1_1Calculator}{}\label{classtest_1_1Calculator}\index{test.Calculator@{test.Calculator}}
|
|
\doxysubsubsection*{Public Member Functions}
|
|
\begin{DoxyCompactItemize}
|
|
\item
|
|
\mbox{\hyperlink{classtest_1_1Calculator_a8c185a7535165af0112843a7f90591d0}{\+\_\+\+\_\+init\+\_\+\+\_\+}} (self, value=0)
|
|
\item
|
|
\mbox{\hyperlink{classtest_1_1Calculator_a51380d9f2eec6a681756eae123305b20}{add}} (self, number)
|
|
\item
|
|
\mbox{\hyperlink{classtest_1_1Calculator_ac880e047baec7af0fab457854361b85a}{subtract}} (self, number)
|
|
\item
|
|
\mbox{\hyperlink{classtest_1_1Calculator_ad8b5873a8477abcafd093a2471875c10}{multiply}} (self, number)
|
|
\item
|
|
\mbox{\hyperlink{classtest_1_1Calculator_ad86df66a089c89fb9ff2f982289ccbb3}{divide}} (self, number)
|
|
\item
|
|
\mbox{\hyperlink{classtest_1_1Calculator_a50984c3a86c450965b48ee0a3ac536d5}{clear}} (self)
|
|
\end{DoxyCompactItemize}
|
|
\doxysubsubsection*{Public Attributes}
|
|
\begin{DoxyCompactItemize}
|
|
\item
|
|
\Hypertarget{classtest_1_1Calculator_ab35d98546e4ad522f5b85254c435e7ae}\label{classtest_1_1Calculator_ab35d98546e4ad522f5b85254c435e7ae}
|
|
{\bfseries value}
|
|
\end{DoxyCompactItemize}
|
|
|
|
|
|
\doxysubsection{Detailed Description}
|
|
\begin{DoxyVerb}A kk kk simple calculator class to perform basic arithmetic operations.
|
|
\end{DoxyVerb}
|
|
|
|
|
|
\doxysubsection{Constructor \& Destructor Documentation}
|
|
\Hypertarget{classtest_1_1Calculator_a8c185a7535165af0112843a7f90591d0}\label{classtest_1_1Calculator_a8c185a7535165af0112843a7f90591d0}
|
|
\index{test.Calculator@{test.Calculator}!\_\_init\_\_@{\_\_init\_\_}}
|
|
\index{\_\_init\_\_@{\_\_init\_\_}!test.Calculator@{test.Calculator}}
|
|
\doxysubsubsection{\texorpdfstring{\_\_init\_\_()}{\_\_init\_\_()}}
|
|
{\footnotesize\ttfamily 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}
|
|
\Hypertarget{classtest_1_1Calculator_a51380d9f2eec6a681756eae123305b20}\label{classtest_1_1Calculator_a51380d9f2eec6a681756eae123305b20}
|
|
\index{test.Calculator@{test.Calculator}!add@{add}}
|
|
\index{add@{add}!test.Calculator@{test.Calculator}}
|
|
\doxysubsubsection{\texorpdfstring{add()}{add()}}
|
|
{\footnotesize\ttfamily 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}
|
|
\Hypertarget{classtest_1_1Calculator_a50984c3a86c450965b48ee0a3ac536d5}\label{classtest_1_1Calculator_a50984c3a86c450965b48ee0a3ac536d5}
|
|
\index{test.Calculator@{test.Calculator}!clear@{clear}}
|
|
\index{clear@{clear}!test.Calculator@{test.Calculator}}
|
|
\doxysubsubsection{\texorpdfstring{clear()}{clear()}}
|
|
{\footnotesize\ttfamily 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}
|
|
\Hypertarget{classtest_1_1Calculator_ad86df66a089c89fb9ff2f982289ccbb3}\label{classtest_1_1Calculator_ad86df66a089c89fb9ff2f982289ccbb3}
|
|
\index{test.Calculator@{test.Calculator}!divide@{divide}}
|
|
\index{divide@{divide}!test.Calculator@{test.Calculator}}
|
|
\doxysubsubsection{\texorpdfstring{divide()}{divide()}}
|
|
{\footnotesize\ttfamily 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}
|
|
\Hypertarget{classtest_1_1Calculator_ad8b5873a8477abcafd093a2471875c10}\label{classtest_1_1Calculator_ad8b5873a8477abcafd093a2471875c10}
|
|
\index{test.Calculator@{test.Calculator}!multiply@{multiply}}
|
|
\index{multiply@{multiply}!test.Calculator@{test.Calculator}}
|
|
\doxysubsubsection{\texorpdfstring{multiply()}{multiply()}}
|
|
{\footnotesize\ttfamily 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}
|
|
\Hypertarget{classtest_1_1Calculator_ac880e047baec7af0fab457854361b85a}\label{classtest_1_1Calculator_ac880e047baec7af0fab457854361b85a}
|
|
\index{test.Calculator@{test.Calculator}!subtract@{subtract}}
|
|
\index{subtract@{subtract}!test.Calculator@{test.Calculator}}
|
|
\doxysubsubsection{\texorpdfstring{subtract()}{subtract()}}
|
|
{\footnotesize\ttfamily 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}
|