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

Auxiliary data structure for discovery calculations. More...

#include <JAstronomyToolkit.hh>

Inheritance diagram for JASTRONOMY::JDiscovery< 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
	JDiscovery (JPseudoExperiment_t &px)
	Constructor.
double	operator() (const double Q, const double P, const size_t numberOfTests, const double precision=1.0e-3)
	Get signal strength for which given likelihood is exceeded with given probability.
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.
void	put (const size_t N, const JFunction_t &object)
	Add values to container.
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.

Protected Member Functions
double	getProbability (const double fS, const double Q, const size_t numberOfTests)
	Run pseudo experiments to get probability corresponding to given minimal likelihood.

Protected Attributes
JPseudoExperiment_t &	px

Detailed Description

template<class T, const size_t factor>
struct JASTRONOMY::JDiscovery< T, factor >

Auxiliary data structure for discovery calculations.

Definition at line 22 of file JAstronomyToolkit.hh.

Member Typedef Documentation

map_type

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

inherited

Definition at line 31 of file JGarage.hh.

value_type

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

inherited

Definition at line 32 of file JGarage.hh.

const_iterator

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

inherited

Definition at line 33 of file JGarage.hh.

const_reverse_iterator

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

inherited

Definition at line 34 of file JGarage.hh.

Constructor & Destructor Documentation

JDiscovery()

template<class T , const size_t factor>

JASTRONOMY::JDiscovery< T, factor >::JDiscovery ( JPseudoExperiment_t & px )

inline

Constructor.

Parameters

px	pseudo experiment

Definition at line 32 of file JAstronomyToolkit.hh.

                                        :
      px(px)
    {}

Member Function Documentation

operator()() [1/2]

template<class T , const size_t factor>

double JASTRONOMY::JDiscovery< T, factor >::operator() ( const double Q, const double P, const size_t numberOfTests, const double precision = 1.0e-3 )

inline

Get signal strength for which given likelihood is exceeded with given probability.

Parameters

Q	likelihood
P	probability [0,1>
numberOfTests	number of tests
precision	precision of signal strength

Returns

signal strength

Definition at line 46 of file JAstronomyToolkit.hh.

    {
      double xmin = 1.0;
      double xmax = 2.0;
 
      while (getProbability(xmin, Q, numberOfTests) > P) {      // set lower limit
        xmax  = xmin;
        xmin *= 0.5;
      }
 
      while (getProbability(xmax, Q, numberOfTests) < P) {      // set upper limit
        xmin  = xmax;
        xmax *= 2.0;
      }
 
      while (xmax - xmin > precision) {                         // bisection
 
        const double x = 0.5 * (xmin + xmax);
 
        if (getProbability(x, Q, numberOfTests) < P)
          xmin = x;
        else
          xmax = x;
      }
 
      return 0.5 * (xmin + xmax);
    }

getProbability() [1/2]

template<class T , const size_t factor>

double JASTRONOMY::JDiscovery< T, factor >::getProbability ( const double fS, const double Q, const size_t numberOfTests )

inlineprotected

Run pseudo experiments to get probability corresponding to given minimal likelihood.

Parameters

fS	signal strength
Q	likelihood
numberOfTests	number of tests

Returns

probability

Definition at line 86 of file JAstronomyToolkit.hh.

    {
      px.set(fS);
 
      this->clear();
 
      for (size_t i = 0; i != numberOfTests; ++i) {
        this->put(px().likelihood);
      }
 
      return this->getProbability(Q);
    }

getN()

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

inlineinherited

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()

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

inlineinherited

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()

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

inlineinherited

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()

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

inlinestaticinherited

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]

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

inlineinherited

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]

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

inlineinherited

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()() [2/2]

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

inlineinherited

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()

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

inlineinherited

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() [2/2]

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

inlineinherited

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;
    }

Member Data Documentation

px

template<class T , const size_t factor>

JPseudoExperiment_t& JASTRONOMY::JDiscovery< T, factor >::px

protected

Definition at line 101 of file JAstronomyToolkit.hh.

---

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

• JAstronomyToolkit.hh