diff options
author | Thales Lima Oliveira <thaleslima.ufu@gmail.com> | 2017-10-06 17:06:15 -0300 |
---|---|---|
committer | Thales Lima Oliveira <thaleslima.ufu@gmail.com> | 2017-10-06 17:06:15 -0300 |
commit | 89befdb9b259d02249876e39ec6fd28860272439 (patch) | |
tree | 054de50365749426623bed352a10e84299e84cad /Project/Exponential.h | |
parent | bc5a3e8923cb8efedbbd5b88e212eb0e9009cf87 (diff) | |
download | PSP.git-89befdb9b259d02249876e39ec6fd28860272439.tar.gz PSP.git-89befdb9b259d02249876e39ec6fd28860272439.tar.xz PSP.git-89befdb9b259d02249876e39ec6fd28860272439.zip |
A lot of documentation written
Diffstat (limited to 'Project/Exponential.h')
-rw-r--r-- | Project/Exponential.h | 11 |
1 files changed, 9 insertions, 2 deletions
diff --git a/Project/Exponential.h b/Project/Exponential.h index e9fd019..accdd48 100644 --- a/Project/Exponential.h +++ b/Project/Exponential.h @@ -27,7 +27,6 @@ class ExponentialForm; * @author Thales Lima Oliveira <thales@ufu.br> * @date 05/10/2017 * @brief Generates an output following an exponential function. - * \f$ output = A\cdot e^{B\cdot input} \f$ * @file Exponential.h */ class Exponential : public ControlElement @@ -46,7 +45,15 @@ class Exponential : public ControlElement virtual void GetValues(double& aValue, double& bValue); virtual void SetValues(double aValue, double bValue); - + + /** + * @brief Calculates the exponential. + * + * <center>\f$ output = A\cdot e^{B\cdot input} \f$</center> + * @param input Input value. + * @param timeStep Time step. + * @return Aways true. + */ virtual bool Solve(double input, double timeStep); virtual Element* GetCopy(); |