JASTRONOMY::JGarage< T, factor > Struct Template Reference

Auxiliary container for statistical analysis of a large number of positive (or zero) values. More...

#include <JGarage.hh>

Inheritance diagram for JASTRONOMY::JGarage< T, factor >:

Public Types
typedef std::vector< 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
size_t	getN () const
	Get total number of values.
T	getMin () const
	Get minimal value.
T	getMax () const
	Get maximal value.
void	put (const T value)
	Add value to container.
template<class JFunction_t >
void	put (const size_t N, const JFunction_t &object)
	Add values to container.
template<class JFunction_t >
void	operator() (const JFunction_t &object) const
	For-each method.
T	getValue (const double P) const
	Get minimal value corresponding given maximal probability.
double	getProbability (const T value) const
	Get maximal probability corresponding given minimal value.

Static Public Member Functions
static size_t	getKey (const T value)
	Get hash key corresponding to given value.

Detailed Description

template<class T, const size_t factor = 0>
struct JASTRONOMY::JGarage< T, factor >

Auxiliary container for statistical analysis of a large number of positive (or zero) values.

The data are organised in groups according to a numerical hash key so that the computation involving quantiles can be made faster.
The numerical hash key is obtained by multiplying the input value with the given factor and then taking the integer value of the result.
The computed quantiles correspond to a distribution with ascending values.

Definition at line 28 of file JGarage.hh.

Member Typedef Documentation

map_type

template<class T , const size_t factor = 0>

std::vector< std::vector<T> > JASTRONOMY::JGarage< T, factor >::map_type

Definition at line 31 of file JGarage.hh.

value_type

template<class T , const size_t factor = 0>

map_type::value_type JASTRONOMY::JGarage< T, factor >::value_type

Definition at line 32 of file JGarage.hh.

const_iterator

template<class T , const size_t factor = 0>

map_type::const_iterator JASTRONOMY::JGarage< T, factor >::const_iterator

Definition at line 33 of file JGarage.hh.

const_reverse_iterator

template<class T , const size_t factor = 0>

map_type::const_reverse_iterator JASTRONOMY::JGarage< T, factor >::const_reverse_iterator

Definition at line 34 of file JGarage.hh.

Member Function Documentation

getN()

template<class T , const size_t factor = 0>

size_t JASTRONOMY::JGarage< T, factor >::getN ( ) const

inline

Get total number of values.

Returns

number of values

Definition at line 42 of file JGarage.hh.

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

getMin()

template<class T , const size_t factor = 0>

T JASTRONOMY::JGarage< T, factor >::getMin ( ) const

inline

Get minimal value.

Returns

value

Definition at line 55 of file JGarage.hh.

    {
      using namespace std;
 
      for (const_iterator i = this->begin(); i != this->end(); ++i) {
        if (!i->empty()) {
          return *min_element(i->begin(), i->end());
        }
      }
 
      throw length_error("No data.");
    }

getMax()

template<class T , const size_t factor = 0>

T JASTRONOMY::JGarage< T, factor >::getMax ( ) const

inline

Get maximal value.

Returns

value

Definition at line 74 of file JGarage.hh.

    {
      using namespace std;
 
      for (const_reverse_iterator i = this->rbegin(); i != this->rend(); ++i) {
        if (!i->empty()) {
          return *max_element(i->begin(), i->end());
        }
      }
 
      throw length_error("No data.");
    }

getKey()

template<class T , const size_t factor = 0>

static size_t JASTRONOMY::JGarage< T, factor >::getKey ( const T value )

inlinestatic

Get hash key corresponding to given value.

Parameters

value

value

Returns

key

Definition at line 94 of file JGarage.hh.

    {
      return value * factor;
    }

put() [1/2]

template<class T , const size_t factor = 0>

void JASTRONOMY::JGarage< T, factor >::put ( const T value )

inline

Add value to container.

Parameters

value

value

Definition at line 105 of file JGarage.hh.

    {
      const size_t index = getKey(value);
 
      if (index >= this->size()) {
        this->resize(index + 1);
      }
 
      (*this)[index].push_back(value);
    }

put() [2/2]

template<class T , const size_t factor = 0>

template<class JFunction_t >

void JASTRONOMY::JGarage< T, factor >::put ( const size_t N, const JFunction_t & object )

inline

Add values to container.

Parameters

N	number of values
object	function object returning value

Definition at line 124 of file JGarage.hh.

    {
      for (size_t i = 0; i != N; ++i) {
        this->put(object());
      }
    }

operator()()

template<class T , const size_t factor = 0>

template<class JFunction_t >

void JASTRONOMY::JGarage< T, factor >::operator() ( const JFunction_t & object ) const

inline

For-each method.

Parameters

object

function object

Definition at line 138 of file JGarage.hh.

    {
      for (const_iterator i = this->begin(); i != this->end(); ++i) {
        for (const T x : *i) {
          object(x);
        }
      }
    }

getValue()

template<class T , const size_t factor = 0>

T JASTRONOMY::JGarage< T, factor >::getValue ( const double P ) const

inline

Get minimal value corresponding given maximal probability.

Parameters

P	probability [0,1>

Returns

value

Definition at line 154 of file JGarage.hh.

    {
      using namespace std;
 
      if (P < 0.0 || P > 1.0) {
        throw out_of_range("Invalid probability.");
      }
 
      const size_t N = this->getN();
      const size_t M = N - (P * N);
 
      if (N == 0) {
        throw length_error("No data.");
      }
 
      if (M == 0) { return getMin(); }
      if (M == N) { return getMax(); }
 
      size_t n = N;
 
      const_reverse_iterator q = this->rbegin();
 
      while ((n -= q->size()) > M) {
        ++q;
      }
 
      value_type buffer(q->begin(), q->end());
 
      typename value_type::iterator p = next(buffer.begin(), M - n);
 
      nth_element(buffer.begin(), p, buffer.end());
 
      return *p;
    }

getProbability()

template<class T , const size_t factor = 0>

double JASTRONOMY::JGarage< T, factor >::getProbability ( const T value ) const

inline

Get maximal probability corresponding given minimal value.

Parameters

value

value

Returns

probability

Definition at line 196 of file JGarage.hh.

    {
      using namespace std;
 
      const size_t N = this->getN();
      const int    M = getKey(value);
 
      if (N == 0) {
        throw length_error("No data.");
      }
 
      size_t n = 0;
      int    i = this->size() - 1;
 
      for ( ; i != -1 && i > M; --i) {
        n += (*this)[i].size();
      }
        
      if (i != -1) {
        for (const T x : (*this)[i]) {
          if (x >= value) {
            n += 1;
          }
        }
      }
 
      return (double) n / (double) N;
    }

---

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

• JGarage.hh