sampler.hpp

Go to the documentation of this file.

/*
 *     SocialLedge.com - Copyright (C) 2013
 *
 *     This file is part of free software framework for embedded processors.
 *     You can use it and/or distribute it as long as this copyright header
 *     remains unmodified.  The code is free for personal use and requires
 *     permission to use in a commercial product.
 *
 *      THIS SOFTWARE IS PROVIDED "AS IS".  NO WARRANTIES, WHETHER EXPRESS, IMPLIED
 *      OR STATUTORY, INCLUDING, BUT NOT LIMITED TO, IMPLIED WARRANTIES OF
 *      MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE APPLY TO THIS SOFTWARE.
 *      I SHALL NOT, IN ANY CIRCUMSTANCES, BE LIABLE FOR SPECIAL, INCIDENTAL, OR
 *      CONSEQUENTIAL DAMAGES, FOR ANY REASON WHATSOEVER.
 *
 *     You can reach the author of this software at :
 *          p r e e t . w i k i @ g m a i l . c o m
 */

#ifndef SAMPLER_HPP_
#define SAMPLER_HPP_

template <typename TYPE>
class Sampler
{
    public:
        Sampler(int numSamples) : mSampleArraySize(numSamples), mSampleIndex(0), mAllSamplesReady(false)
        {
            mSamples = new TYPE[numSamples];
            for(int i=0; i < numSamples; i++) {
                mSamples[i] = 0;
            }
        }

        ~Sampler()
        {
            delete [] mSamples;
        }

        void storeSample(const TYPE& sample)
        {
            mSamples[mSampleIndex] = sample;
            if(++mSampleIndex >= mSampleArraySize) {
                mSampleIndex = 0;
                mAllSamplesReady = true;
            }
        }

        TYPE getAverage(void) const
        {
            const int numSamples = mAllSamplesReady ? mSampleArraySize : mSampleIndex;
            TYPE sum = 0;

            for(int i=0; i < numSamples; i++) {
                sum += mSamples[i];
            }

            return (sum / numSamples);
        }

        TYPE getLatest(void) const
        {
            int idx = (0 == mSampleIndex) ? (mSampleArraySize - 1) : (mSampleIndex - 1);
            return mSamples[idx];
        }

        TYPE getHighest(void) const
        {
            const int numSamples = mAllSamplesReady ? mSampleArraySize : mSampleIndex;
            TYPE highest = mSamples[0];

            for(int i=0; i < numSamples; i++) {
                if (highest < mSamples[i]) {
                    highest = mSamples[i];
                }
            }

            return highest;
        }

        TYPE getLowest(void) const
        {
            const int numSamples = mAllSamplesReady ? mSampleArraySize : mSampleIndex;
            TYPE lowest = mSamples[0];

            for(int i=0; i < numSamples; i++) {
                if (lowest > mSamples[i]) {
                    lowest = mSamples[i];
                }
            }

            return lowest;
        }

        inline bool allSamplesReady(void)  const { return mAllSamplesReady; }
        inline int getMaxSampleCount(void) const { return mSampleArraySize; }
        inline int getSampleCount(void)    const { return mAllSamplesReady ? mSampleArraySize : mSampleIndex; }
        inline TYPE getSampleNum(int idx)  const { return idx < mSampleArraySize ? mSamples[idx] : 0;         }

        void clear(void)
        {
            mAllSamplesReady = false;
            mSampleIndex = 0;
        }

    private:
        Sampler() :
            mSampleArraySize(0), mSampleIndex(0),
            mAllSamplesReady(false), mSamples(0)
        {
        }

        const int mSampleArraySize; 
        int mSampleIndex;           
        bool mAllSamplesReady;      
        TYPE* mSamples;             
};

#endif /* SAMPLER_HPP_ */