TFCS1DFunction_HistogramCompactBinEdges< T, Tint, Trandom > Class Template Reference

#include <TFCS1DFunctionTemplateHelpers.h>

Collaboration diagram for TFCS1DFunction_HistogramCompactBinEdges< T, Tint, Trandom >:

Public Types
typedef TFCS1DFunction_size_t	size_t
typedef T	value_type
typedef Trandom	random_type
typedef Tint	internal_storage_type

Public Member Functions
	TFCS1DFunction_HistogramCompactBinEdges (size_t nbins=0)
	~TFCS1DFunction_HistogramCompactBinEdges ()
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 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 exponentially 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< Tint >	m_array
T	m_Min {0}
T	m_Max {0}

Detailed Description

template<typename T, typename Tint, typename Trandom = float>
class TFCS1DFunction_HistogramCompactBinEdges< T, Tint, Trandom >

Definition at line 376 of file TFCS1DFunctionTemplateHelpers.h.

Member Typedef Documentation

internal_storage_type

template<typename T , typename Tint , typename Trandom = float>

typedef Tint TFCS1DFunction_HistogramCompactBinEdges< T, Tint, Trandom >::internal_storage_type

Definition at line 381 of file TFCS1DFunctionTemplateHelpers.h.

random_type

template<typename T , typename Tint , typename Trandom = float>

typedef Trandom TFCS1DFunction_HistogramCompactBinEdges< T, Tint, Trandom >::random_type

Definition at line 380 of file TFCS1DFunctionTemplateHelpers.h.

size_t

template<typename T , typename Tint , typename Trandom = float>

typedef TFCS1DFunction_size_t TFCS1DFunction_HistogramCompactBinEdges< T, Tint, Trandom >::size_t

Definition at line 378 of file TFCS1DFunctionTemplateHelpers.h.

value_type

template<typename T , typename Tint , typename Trandom = float>

typedef T TFCS1DFunction_HistogramCompactBinEdges< T, Tint, Trandom >::value_type

Definition at line 379 of file TFCS1DFunctionTemplateHelpers.h.

Constructor & Destructor Documentation

TFCS1DFunction_HistogramCompactBinEdges()

template<typename T , typename Tint , typename Trandom = float>

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

inline

Definition at line 383 of file TFCS1DFunctionTemplateHelpers.h.

      : m_array(nbins >= 1 ? nbins - 1 : 0){};

~TFCS1DFunction_HistogramCompactBinEdges()

template<typename T , typename Tint , typename Trandom = float>

TFCS1DFunction_HistogramCompactBinEdges< T, Tint, Trandom >::~TFCS1DFunction_HistogramCompactBinEdges ( )

inline

Definition at line 385 of file TFCS1DFunctionTemplateHelpers.h.

{};

Member Function Documentation

get_nbins()

template<typename T , typename Tint , typename Trandom = float>

size_t TFCS1DFunction_HistogramCompactBinEdges< T, Tint, Trandom >::get_nbins ( ) const

inline

return number of bins

Definition at line 394 of file TFCS1DFunctionTemplateHelpers.h.

{ return size() + 1; };

GetBinLength()

template<typename T , typename Tint , typename Trandom = float>

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

inline

get the length of a bin

Definition at line 424 of file TFCS1DFunctionTemplateHelpers.h.

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

GetBinLowEdge()

template<typename T , typename Tint , typename Trandom = float>

const T TFCS1DFunction_HistogramCompactBinEdges< T, Tint, Trandom >::GetBinLowEdge ( size_t  pos ) const

inline

get position of lower edge of bins.

Requires GetMin() and GetMax() to be set and may not be changed!

Definition at line 413 of file TFCS1DFunctionTemplateHelpers.h.

                                                 {
    if (pos == 0)
      return GetMin();
    if (pos >= get_nbins())
      return GetMax();
    return GetMin() +
           Length() * TFCS1DFunction_Numeric<Tint, T>::ToNormalizedRange(
                          m_array[pos - 1]);
  };

GetMax()

template<typename T , typename Tint , typename Trandom = float>

const T& TFCS1DFunction_HistogramCompactBinEdges< T, Tint, Trandom >::GetMax ( ) const

inline

Definition at line 434 of file TFCS1DFunctionTemplateHelpers.h.

{ return m_Max; };

GetMin()

template<typename T , typename Tint , typename Trandom = float>

const T& TFCS1DFunction_HistogramCompactBinEdges< T, Tint, Trandom >::GetMin ( ) const

inline

Definition at line 430 of file TFCS1DFunctionTemplateHelpers.h.

{ return m_Min; };

Length()

template<typename T , typename Tint , typename Trandom = float>

const T TFCS1DFunction_HistogramCompactBinEdges< T, Tint, Trandom >::Length ( ) const

inline

Get length of interval of all bins.

Definition at line 443 of file TFCS1DFunctionTemplateHelpers.h.

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

MemorySize()

template<typename T , typename Tint , typename Trandom = float>

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

inline

Definition at line 388 of file TFCS1DFunctionTemplateHelpers.h.

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

MemorySizeArray()

template<typename T , typename Tint , typename Trandom = float>

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

inline

Definition at line 387 of file TFCS1DFunctionTemplateHelpers.h.

{ return m_array.MemorySizeArray(); };

position()

template<typename T , typename Tint , typename Trandom = float>

T TFCS1DFunction_HistogramCompactBinEdges< T, Tint, 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 447 of file TFCS1DFunctionTemplateHelpers.h.

                                                           {
    T pos1 = GetBinLowEdge(pos);
    T pos2 = GetBinLowEdge(pos + 1);
    return (1 - drnd) * pos1 + drnd * pos2;
  };

position_exp()

template<typename T , typename Tint , typename Trandom = float>

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

inline

return exponentially 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 478 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 Tint , typename Trandom = float>

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

inline

return 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] 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 460 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;
    T pos1 = GetBinLowEdge(pos);
    T pos2 = GetBinLowEdge(pos + 1);
    return (1 - x) * pos1 + x * pos2;
  };

set_nbins()

template<typename T , typename Tint , typename Trandom = float>

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

inline

set number of bins

Definition at line 391 of file TFCS1DFunctionTemplateHelpers.h.

{ m_array.resize(nbins >= 1 ? nbins - 1 : 0); };

SetBinLowEdge()

template<typename T , typename Tint , typename Trandom = float>

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

inline

set position of lower edge of bins.

Requires GetMin() and GetMax() to be set and may not be changed!

Definition at line 398 of file TFCS1DFunctionTemplateHelpers.h.

                                                 {
    if (pos == 0) {
      SetMin(value);
      return;
    }
    if (pos >= get_nbins()) {
      SetMax(value);
      return;
    }
    m_array[pos - 1] = TFCS1DFunction_Numeric<Tint, T>::ExpandToMaxRange(
        (value - GetMin()) / Length());
  };

SetMax()

template<typename T , typename Tint , typename Trandom = float>

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

inline

set and get maximum

Definition at line 433 of file TFCS1DFunctionTemplateHelpers.h.

{ m_Max = value; };

SetMin()

template<typename T , typename Tint , typename Trandom = float>

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

inline

set and get minimum

Definition at line 429 of file TFCS1DFunctionTemplateHelpers.h.

{ m_Min = value; };

SetMinMax()

template<typename T , typename Tint , typename Trandom = float>

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

inline

set minimum and maximum

Definition at line 437 of file TFCS1DFunctionTemplateHelpers.h.

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

size()

template<typename T , typename Tint , typename Trandom = float>

size_t TFCS1DFunction_HistogramCompactBinEdges< T, Tint, Trandom >::size ( ) const

inlineprivate

Definition at line 498 of file TFCS1DFunctionTemplateHelpers.h.

{ return m_array.size(); };

Member Data Documentation

m_array

template<typename T , typename Tint , typename Trandom = float>

TFCS1DFunction_Array<Tint> TFCS1DFunction_HistogramCompactBinEdges< T, Tint, Trandom >::m_array

private

Definition at line 497 of file TFCS1DFunctionTemplateHelpers.h.

m_Max

template<typename T , typename Tint , typename Trandom = float>

T TFCS1DFunction_HistogramCompactBinEdges< T, Tint, Trandom >::m_Max {0}

private

Definition at line 500 of file TFCS1DFunctionTemplateHelpers.h.

m_Min

template<typename T , typename Tint , typename Trandom = float>

T TFCS1DFunction_HistogramCompactBinEdges< T, Tint, Trandom >::m_Min {0}

private

Definition at line 499 of file TFCS1DFunctionTemplateHelpers.h.

---

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

• TFCS1DFunctionTemplateHelpers.h