JASTRONOMY::JQuantile< T > Struct Template Reference

Auxiliary container for statistical analysis of a large number of values. More...

#include <JAstronomyToolkit.hh>

Inheritance diagram for JASTRONOMY::JQuantile< T >:

Public Types
typedef std::map< int, std::vector< T > >	map_type
typedef map_type::value_type	value_type
typedef map_type::const_iterator	const_iterator
typedef map_type::const_reverse_iterator	const_reverse_iterator

Public Member Functions
	JQuantile (const double factor)
	Constructor.
size_t	getN () const
	Get total number of values.
T	getMin () const
	Get minimal value.
T	getMax () const
	Get maximal value.
int	getKey (const T value) const
	Get key of given value.
void	put (const T value)
	Add value to container.
T	getValue (const double P) const
	Get minimal value corresponding given maximal probability.
double	getProbability (const double value) const
	Get maximal probability corresponding given minimal value.

Public Attributes
const T	factor
	scaling factor for rounding value

Detailed Description

template<class T>
struct JASTRONOMY::JQuantile< T >

Auxiliary container for statistical analysis of a large number of values.

The data are organised in groups according to a numerical key so that the computation involving quantiles can be speed up.
The numerical key is obtained by scaling the value with a given factor and then taking the floor of the result.
The quantiles correspond to a distribution with ascending values.

Definition at line 36 of file JAstronomyToolkit.hh.

Member Typedef Documentation

map_type

template<class T >

std::map<int, std::vector<T> > JASTRONOMY::JQuantile< T >::map_type

Definition at line 39 of file JAstronomyToolkit.hh.

value_type

template<class T >

map_type::value_type JASTRONOMY::JQuantile< T >::value_type

Definition at line 40 of file JAstronomyToolkit.hh.

const_iterator

template<class T >

map_type::const_iterator JASTRONOMY::JQuantile< T >::const_iterator

Definition at line 41 of file JAstronomyToolkit.hh.

const_reverse_iterator

template<class T >

map_type::const_reverse_iterator JASTRONOMY::JQuantile< T >::const_reverse_iterator

Definition at line 42 of file JAstronomyToolkit.hh.

Constructor & Destructor Documentation

JQuantile()

template<class T >

JASTRONOMY::JQuantile< T >::JQuantile ( const double factor )

inline

Constructor.

Parameters

factor

factor

Definition at line 50 of file JAstronomyToolkit.hh.

                                   :
      factor(factor)
    {}

Member Function Documentation

getN()

template<class T >

size_t JASTRONOMY::JQuantile< T >::getN ( ) const

inline

Get total number of values.

Returns

number of values

Definition at line 60 of file JAstronomyToolkit.hh.

    {
      return std::accumulate(this->begin(), this->end(), 0, [](const size_t n, const value_type& i) { return n + i.second.size(); });
    }

getMin()

template<class T >

T JASTRONOMY::JQuantile< T >::getMin ( ) const

inline

Get minimal value.

Returns

value

Definition at line 71 of file JAstronomyToolkit.hh.

    {
      for (const_iterator i = this->begin(); i != this->end(); ++i) {
        if (!i->second.empty()) {
          return *std::min_element(i->second.begin(), i->second.end());
        }
      }
 
      THROW(JEmptyCollection, "Missing data.");
    }

getMax()

template<class T >

T JASTRONOMY::JQuantile< T >::getMax ( ) const

inline

Get maximal value.

Returns

value

Definition at line 88 of file JAstronomyToolkit.hh.

    {
      for (const_reverse_iterator i = this->rbegin(); i != this->rend(); ++i) {
        if (!i->second.empty()) {
          return *std::max_element(i->second.begin(), i->second.end());
        }
      }
 
      THROW(JEmptyCollection, "Missing data.");
    }

getKey()

template<class T >

int JASTRONOMY::JQuantile< T >::getKey ( const T value ) const

inline

Get key of given value.

Parameters

value

value

Returns

key

Definition at line 106 of file JAstronomyToolkit.hh.

    {
      return floor(value * factor);
    }

put()

template<class T >

void JASTRONOMY::JQuantile< T >::put ( const T value )

inline

Add value to container.

Parameters

value

value

Definition at line 117 of file JAstronomyToolkit.hh.

    {
      (*this)[getKey(value)].push_back(value);
    }

getValue()

template<class T >

T JASTRONOMY::JQuantile< T >::getValue ( const double P ) const

inline

Get minimal value corresponding given maximal probability.

Parameters

P	probability [0,1>

Returns

value

Definition at line 129 of file JAstronomyToolkit.hh.

    {
      using namespace std;
 
      if (P < 0.0 || P > 1.0) {
        THROW(JValueOutOfRange, "Invalid probability " << P);
      }
 
      const size_t N = this->getN();
      const size_t M = N - (size_t) (P * N);
 
      if (N == 0) {
        THROW(JEmptyCollection, "Missing data.");
      }
 
      if (M == N) { return this->getMax(); }
      if (M == 0) { return this->getMin(); }
 
      size_t n = N;
        
      for (const_reverse_iterator p = this->rbegin(); p != this->rend(); ++p) {
 
        n -= p->second.size();
 
        if (n <= M) {
 
          vector<T> buffer(p->second.begin(), p->second.end());
 
          sort(buffer.begin(), buffer.end());
 
          return buffer[M - n];
        }
      }
 
      THROW(JValueOutOfRange, "Invalid index " << M << ' ' << N);
    }

getProbability()

template<class T >

double JASTRONOMY::JQuantile< T >::getProbability ( const double value ) const

inline

Get maximal probability corresponding given minimal value.

Parameters

value

value

Returns

probability

Definition at line 173 of file JAstronomyToolkit.hh.

    {
      const int M = getKey(value);
      size_t    n = 0;
 
      const_reverse_iterator i = this->rbegin();
 
      for ( ; i != this->rend() && i->first > M; ++i) {
        n += i->second.size();
      }
        
      if (i != this->rend()) {
        for (T x : i->second) {
          if (x >= value) {
            n += 1;
          }
        }
      }
 
      return (double) n / (double) this->getN();
    }

Member Data Documentation

factor

template<class T >

const T JASTRONOMY::JQuantile< T >::factor

scaling factor for rounding value

Definition at line 196 of file JAstronomyToolkit.hh.

---

The documentation for this struct was generated from the following file:

• JAstronomyToolkit.hh