Chris@49: // Copyright (C) 2009-2011 NICTA (www.nicta.com.au)
Chris@49: // Copyright (C) 2009-2011 Conrad Sanderson
Chris@49: // 
Chris@49: // This Source Code Form is subject to the terms of the Mozilla Public
Chris@49: // License, v. 2.0. If a copy of the MPL was not distributed with this
Chris@49: // file, You can obtain one at http://mozilla.org/MPL/2.0/.
Chris@49: 
Chris@49: 
Chris@49: //! \addtogroup running_stat
Chris@49: //! @{
Chris@49: 
Chris@49: 
Chris@49: 
Chris@49: template<typename eT>
Chris@49: class arma_counter
Chris@49:   {
Chris@49:   public:
Chris@49:   
Chris@49:   inline ~arma_counter();
Chris@49:   inline  arma_counter();
Chris@49:   
Chris@49:   inline const arma_counter& operator++();
Chris@49:   inline void                operator++(int);
Chris@49:   
Chris@49:   inline void reset();
Chris@49:   inline eT   value()         const;
Chris@49:   inline eT   value_plus_1()  const;
Chris@49:   inline eT   value_minus_1() const;
Chris@49:   
Chris@49:   
Chris@49:   private:
Chris@49:   
Chris@49:   arma_aligned eT    d_count;
Chris@49:   arma_aligned uword i_count;
Chris@49:   };
Chris@49: 
Chris@49: 
Chris@49: 
Chris@49: //! Class for keeping statistics of a continuously sampled process / signal.
Chris@49: //! Useful if the storage of individual samples is not necessary or desired.
Chris@49: //! Also useful if the number of samples is not known beforehand or exceeds 
Chris@49: //! available memory.
Chris@49: template<typename eT>
Chris@49: class running_stat
Chris@49:   {
Chris@49:   public:
Chris@49:   
Chris@49:   typedef typename get_pod_type<eT>::result T;
Chris@49:   
Chris@49:   
Chris@49:   inline ~running_stat();
Chris@49:   inline  running_stat();
Chris@49:   
Chris@49:   inline void operator() (const T sample);
Chris@49:   inline void operator() (const std::complex<T>& sample);
Chris@49:   
Chris@49:   inline void reset();
Chris@49:   
Chris@49:   inline eT mean() const;
Chris@49:   
Chris@49:   inline  T var   (const uword norm_type = 0) const;
Chris@49:   inline  T stddev(const uword norm_type = 0) const;
Chris@49:   
Chris@49:   inline eT min()  const;
Chris@49:   inline eT max()  const;
Chris@49:   
Chris@49:   inline T count() const;
Chris@49:   
Chris@49:   //
Chris@49:   //
Chris@49:   
Chris@49:   private:
Chris@49:   
Chris@49:   arma_aligned arma_counter<T> counter;
Chris@49:   
Chris@49:   arma_aligned eT r_mean;
Chris@49:   arma_aligned  T r_var;
Chris@49:   
Chris@49:   arma_aligned eT min_val;
Chris@49:   arma_aligned eT max_val;
Chris@49:   
Chris@49:   arma_aligned  T min_val_norm;
Chris@49:   arma_aligned  T max_val_norm;
Chris@49:   
Chris@49:   
Chris@49:   friend class running_stat_aux;
Chris@49:   };
Chris@49: 
Chris@49: 
Chris@49: 
Chris@49: class running_stat_aux
Chris@49:   {
Chris@49:   public:
Chris@49:   
Chris@49:   template<typename eT>
Chris@49:   inline static void update_stats(running_stat<eT>&               x,  const eT               sample);
Chris@49:   
Chris@49:   template<typename T>
Chris@49:   inline static void update_stats(running_stat< std::complex<T> >& x, const T                sample);
Chris@49:   
Chris@49:   template<typename T>
Chris@49:   inline static void update_stats(running_stat< std::complex<T> >& x, const std::complex<T>& sample);
Chris@49:   
Chris@49:   };
Chris@49: 
Chris@49: 
Chris@49: 
Chris@49: //! @}