Profile.h

 
#pragma once

 
#if defined(Profile_RECURSES)
#error Recursive header files inclusion detected in Profile.h
#else // defined(Profile_RECURSES)
#define Profile_RECURSES
 
#if !defined Profile_h
#define Profile_h

// Inclusions
#include <iostream>
#include <vector>
#include "DGtal/math/Statistic.h"
 
#include "DGtal/base/Common.h"
 
namespace DGtal
{

  // class Profile
 
  template<typename TValueFunctor = functors::Identity, typename TValue = double >
  class Profile
  {
    // ----------------------- Standard services ------------------------------
  public:

    enum ProfileType{MEAN, MAX, MIN, MEDIAN};

    typedef TValueFunctor Functor;

    typedef TValue Value;
 
    BOOST_CONCEPT_ASSERT(( concepts::CUnaryFunctor<Functor, Value, Value>  ));
 

    ~Profile();

    Profile();
 

    Profile(ProfileType type);
 

    Profile( const Profile & other );
 

    Profile & operator= ( const Profile & other );
 
 

    void clear();
 
 

    template <typename Iterator>
    void init(  Iterator beginXvalues,  Iterator endXvalues,
                const bool storeValsInStats=false );
 
 

    void init( const unsigned int nb, const bool storeValsInStats=false );
 

    void addValue( const unsigned int indexX, const TValue value );
 

    void addStatistic( const unsigned int indexX, const Statistic<Value> & stat );
 
 

    void stopStatsSaving() ;
 
 
 
 
    // ----------------------- Profile services --------------------------------
  public:

    void setType(const ProfileType type);
 
 

    void getProfile( std::vector<Value> & x,
                     std::vector<Value> & y ) const;
 
 
 
 
 
 
    // ----------------------- Interface --------------------------------------
  public:

    void selfDisplay ( std::ostream & out ) const;

    bool isValid() const;
 
    // ------------------------- Protected Data ------------------------------
  private:
    // ------------------------- Private Data --------------------------------
  private:
 
    Functor myFunctor;

    std::vector<Value>* myXsamples;

    std::vector< Statistic<Value> >* myStats;

    ProfileType myProfileDef;
 
 

    bool myStoreValInStats;
 
 
 
    // ------------------------- Hidden services ------------------------------
  protected:
 
 
  private:
 
 
 
 
    // ------------------------- Internals ------------------------------------
  private:
 
  }; // end of class Profile
 

  template< typename TValueFunctor, typename TValue >
  std::ostream&
  operator<< ( std::ostream & out, const Profile<TValueFunctor, TValue> & object );
 
 
} // namespace DGtal
 

// Includes inline functions.
#if !defined(BUILD_INLINE)
#include "DGtal/math/Profile.ih"
#endif
 
 
//                                                                           //
 
#endif // !defined Profile_h
 
#undef Profile_RECURSES
#endif // else defined(Profile_RECURSES)