TFCS1DFunction_HistogramBinEdges< T, Trandom > Class Template Reference

#include <TFCS1DFunctionTemplateHelpers.h>

Collaboration diagram for TFCS1DFunction_HistogramBinEdges< T, Trandom >:

Public Types
typedef TFCS1DFunction_size_t	size_t
typedef T	value_type
typedef Trandom	random_type

Public Member Functions
	TFCS1DFunction_HistogramBinEdges (size_t nbins=0)
	~TFCS1DFunction_HistogramBinEdges ()
std::size_t	MemorySizeArray () const
std::size_t	MemorySize () const
void	set_nbins (size_t nbins)
	set number of bins More...
size_t	get_nbins () const
	return number of bins More...
void	SetBinLowEdge (size_t pos, const T &value)
	set position of lower edge of bins More...
const T &	GetBinLowEdge (size_t pos) const
	get position of lower edge of bins More...
const T	GetBinLength (size_t pos) const
	get the length of a bin More...
void	SetMin (const T &value)
	set and get minimum More...
const T &	GetMin () const
void	SetMax (const T &value)
	set and get maximum More...
const T &	GetMax () const
void	SetMinMax (const T &valuemin, const T &valuemax)
	set minimum and maximum More...
const T	Length () const
	Get length of interval of all bins. More...
T	position (size_t pos, const Trandom &drnd) const
	return linear interpolated position for bin pos. More...
T	position_lin (size_t pos, Trandom m, const Trandom &drnd) const
	return linearly interpolated position for bin pos, such that histograming the position gives a linear slope m, where m is in units of the bin width for bin pos. More...
T	position_exp (size_t pos, Trandom beta, const Trandom &drnd) const
	return exponetially interpolated position for bin pos, such that histograming the position gives a linear slope m, where m is in units of the bin width for bin pos. More...

Private Member Functions
size_t	size () const

Private Attributes
TFCS1DFunction_Array< T >	m_array

Detailed Description

template<typename T, typename Trandom = float>
class TFCS1DFunction_HistogramBinEdges< T, Trandom >

Definition at line 254 of file TFCS1DFunctionTemplateHelpers.h.

Member Typedef Documentation

random_type

template<typename T , typename Trandom = float>

typedef Trandom TFCS1DFunction_HistogramBinEdges< T, Trandom >::random_type

Definition at line 258 of file TFCS1DFunctionTemplateHelpers.h.

size_t

template<typename T , typename Trandom = float>

typedef TFCS1DFunction_size_t TFCS1DFunction_HistogramBinEdges< T, Trandom >::size_t

Definition at line 256 of file TFCS1DFunctionTemplateHelpers.h.

value_type

template<typename T , typename Trandom = float>

typedef T TFCS1DFunction_HistogramBinEdges< T, Trandom >::value_type

Definition at line 257 of file TFCS1DFunctionTemplateHelpers.h.

Constructor & Destructor Documentation

TFCS1DFunction_HistogramBinEdges()

template<typename T , typename Trandom = float>

TFCS1DFunction_HistogramBinEdges< T, Trandom >::TFCS1DFunction_HistogramBinEdges ( size_t  nbins = 0 )

inline

Definition at line 260 of file TFCS1DFunctionTemplateHelpers.h.

: m_array(nbins + 1){};

~TFCS1DFunction_HistogramBinEdges()

template<typename T , typename Trandom = float>

TFCS1DFunction_HistogramBinEdges< T, Trandom >::~TFCS1DFunction_HistogramBinEdges ( )

inline

Definition at line 261 of file TFCS1DFunctionTemplateHelpers.h.

{};

Member Function Documentation

get_nbins()

template<typename T , typename Trandom = float>

size_t TFCS1DFunction_HistogramBinEdges< T, Trandom >::get_nbins ( ) const

inline

return number of bins

Definition at line 270 of file TFCS1DFunctionTemplateHelpers.h.

{ return size() - 1; };

GetBinLength()

template<typename T , typename Trandom = float>

const T TFCS1DFunction_HistogramBinEdges< T, Trandom >::GetBinLength ( size_t  pos ) const

inline

get the length of a bin

Definition at line 279 of file TFCS1DFunctionTemplateHelpers.h.

                                                {
    return GetBinLowEdge(pos + 1) - GetBinLowEdge(pos);
  };

GetBinLowEdge()

template<typename T , typename Trandom = float>

const T& TFCS1DFunction_HistogramBinEdges< T, Trandom >::GetBinLowEdge ( size_t  pos ) const

inline

get position of lower edge of bins

Definition at line 276 of file TFCS1DFunctionTemplateHelpers.h.

{ return m_array[pos]; };

GetMax()

template<typename T , typename Trandom = float>

const T& TFCS1DFunction_HistogramBinEdges< T, Trandom >::GetMax ( ) const

inline

Definition at line 289 of file TFCS1DFunctionTemplateHelpers.h.

{ return m_array[get_nbins()]; };

GetMin()

template<typename T , typename Trandom = float>

const T& TFCS1DFunction_HistogramBinEdges< T, Trandom >::GetMin ( ) const

inline

Definition at line 285 of file TFCS1DFunctionTemplateHelpers.h.

{ return m_array[0]; };

Length()

template<typename T , typename Trandom = float>

const T TFCS1DFunction_HistogramBinEdges< T, Trandom >::Length ( ) const

inline

Get length of interval of all bins.

Definition at line 298 of file TFCS1DFunctionTemplateHelpers.h.

{ return GetMax() - GetMin(); };

MemorySize()

template<typename T , typename Trandom = float>

std::size_t TFCS1DFunction_HistogramBinEdges< T, Trandom >::MemorySize ( ) const

inline

Definition at line 264 of file TFCS1DFunctionTemplateHelpers.h.

{ return sizeof(*this) + MemorySizeArray(); };

MemorySizeArray()

template<typename T , typename Trandom = float>

std::size_t TFCS1DFunction_HistogramBinEdges< T, Trandom >::MemorySizeArray ( ) const

inline

Definition at line 263 of file TFCS1DFunctionTemplateHelpers.h.

{ return m_array.MemorySizeArray(); };

position()

template<typename T , typename Trandom = float>

T TFCS1DFunction_HistogramBinEdges< T, Trandom >::position ( size_t  pos, const Trandom &  drnd  ) const

inline

return linear interpolated position for bin pos.

Interpolation is done with a random value in the range [0,1]

Definition at line 302 of file TFCS1DFunctionTemplateHelpers.h.

                                                           {
    return (1 - drnd) * m_array[pos] + drnd * m_array[pos + 1];
  };

position_exp()

template<typename T , typename Trandom = float>

T TFCS1DFunction_HistogramBinEdges< T, Trandom >::position_exp ( size_t  pos, Trandom  beta, const Trandom &  drnd  ) const

inline

return exponetially interpolated position for bin pos, such that histograming the position gives a linear slope m, where m is in units of the bin width for bin pos.

Interpolation is done with a random value in the range [0,1]

(m_array[pos+1] - m_array[pos]);

Definition at line 325 of file TFCS1DFunctionTemplateHelpers.h.

                                                                             {
    Trandom z = drnd; 
    T pos1 = GetBinLowEdge(pos);
    T pos2 = GetBinLowEdge(pos + 1);
    if (fabs(beta) < 1.0e-8)
      return (1 - z) * pos1 + z * pos2;
    else {
      T deltax = m_array[pos + 1] - m_array[pos];
      if (deltax == 0)
        return m_array[pos];
      else {
        z = 1 / beta * log(1.0 + drnd * (exp(beta * deltax) - 1.0)) / deltax;
      }
    }
 
    return (1 - z) * pos1 + z * pos2;
  };

position_lin()

template<typename T , typename Trandom = float>

T TFCS1DFunction_HistogramBinEdges< T, Trandom >::position_lin ( size_t  pos, Trandom  m, const Trandom &  drnd  ) const

inline

return linearly interpolated position for bin pos, such that histograming the position gives a linear slope m, where m is in units of the bin width for bin pos.

Interpolation is done with a random value in the range [0,1]

Definition at line 309 of file TFCS1DFunctionTemplateHelpers.h.

                                                                          {
    if (m > 2)
      m = 2;
    if (m < -2)
      m = -2;
    Trandom x =
        fabs(m) > 0.001
            ? (0.5 * std::sqrt(m * (m + 8 * drnd - 4) + 4) - 1) / m + 0.5
            : drnd;
    return (1 - x) * m_array[pos] + x * m_array[pos + 1];
  };

set_nbins()

template<typename T , typename Trandom = float>

void TFCS1DFunction_HistogramBinEdges< T, Trandom >::set_nbins ( size_t  nbins )

inline

set number of bins

Definition at line 267 of file TFCS1DFunctionTemplateHelpers.h.

{ m_array.resize(nbins + 1); };

SetBinLowEdge()

template<typename T , typename Trandom = float>

void TFCS1DFunction_HistogramBinEdges< T, Trandom >::SetBinLowEdge ( size_t  pos, const T &  value  )

inline

set position of lower edge of bins

Definition at line 273 of file TFCS1DFunctionTemplateHelpers.h.

{ m_array[pos] = value; };

SetMax()

template<typename T , typename Trandom = float>

void TFCS1DFunction_HistogramBinEdges< T, Trandom >::SetMax ( const T &  value )

inline

set and get maximum

Definition at line 288 of file TFCS1DFunctionTemplateHelpers.h.

{ m_array[get_nbins()] = value; };

SetMin()

template<typename T , typename Trandom = float>

void TFCS1DFunction_HistogramBinEdges< T, Trandom >::SetMin ( const T &  value )

inline

set and get minimum

Definition at line 284 of file TFCS1DFunctionTemplateHelpers.h.

{ m_array[0] = value; };

SetMinMax()

template<typename T , typename Trandom = float>

void TFCS1DFunction_HistogramBinEdges< T, Trandom >::SetMinMax ( const T &  valuemin, const T &  valuemax  )

inline

set minimum and maximum

Definition at line 292 of file TFCS1DFunctionTemplateHelpers.h.

                                                       {
    SetMin(valuemin);
    SetMax(valuemax);
  };

size()

template<typename T , typename Trandom = float>

size_t TFCS1DFunction_HistogramBinEdges< T, Trandom >::size ( ) const

inlineprivate

Definition at line 345 of file TFCS1DFunctionTemplateHelpers.h.

{ return m_array.size(); };

Member Data Documentation

m_array

template<typename T , typename Trandom = float>

TFCS1DFunction_Array<T> TFCS1DFunction_HistogramBinEdges< T, Trandom >::m_array

private

Definition at line 344 of file TFCS1DFunctionTemplateHelpers.h.

---

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

• TFCS1DFunctionTemplateHelpers.h