X-Git-Url: http://git.maemo.org/git/?p=speedfreak;a=blobdiff_plain;f=Client%2Fmovingaverage.cpp;fp=Client%2Fmovingaverage.cpp;h=ea83f0e460d7f5125aeec6215698f851f2fe1a47;hp=645f34a5dab581f62df574c8e48bfd87178097a4;hb=59a7180931986f4d9420f6b4f1beb85f078fd309;hpb=eb8665a8c4b6a15a9d5a9f5b348432293d171ae6;ds=sidebyside diff --git a/Client/movingaverage.cpp b/Client/movingaverage.cpp index 645f34a..ea83f0e 100644 --- a/Client/movingaverage.cpp +++ b/Client/movingaverage.cpp @@ -1,7 +1,8 @@ /* * Class for moving average of acceleration data. * - * @author Kai Rasilainen + * @author Kai Rasilainen + * @author Toni Jussila * @copyright (c) 2010 Speed Freak team * @license http://opensource.org/licenses/gpl-license.php GNU Public License */ @@ -9,11 +10,21 @@ #include "movingaverage.h" #include +/** + * Constructor of this class. + * + * @param int size limit + */ MovingAverage::MovingAverage(int sizeLimit) { SizeLimit = sizeLimit; } +/** + * Average. + * + * @return double average + */ double MovingAverage::Average() { double sum = 0; @@ -30,6 +41,11 @@ double MovingAverage::Average() return sum / queue.count(); } +/** + * Resize. + * + * @param int size limit + */ void MovingAverage::Resize(int sizeLimit) { SizeLimit = sizeLimit; @@ -39,11 +55,14 @@ void MovingAverage::Resize(int sizeLimit) } } +/** + * Enqueue. + * + * @param double item + */ void MovingAverage::Enqueue(double item) { queue.enqueue(item); if (queue.count() > SizeLimit) queue.dequeue(); } - -