1D Binned element with bin centering. More...

#include <JElement.hh>

Inheritance diagram for JTOOLS::JBin1D< JAbscissa_t, JOrdinate_t >:

Public Types
typedef JElement2D< JAbscissa_t, JOrdinate_t >	element_type

typedef element_type::abscissa_type	abscissa_type

typedef element_type::ordinate_type	ordinate_type

Public Member Functions
	JBin1D ()
	Default constructor.

	JBin1D (typename JLANG::JClass< abscissa_type >::argument_type x, typename JLANG::JClass< ordinate_type >::argument_type y, typename JLANG::JClass< abscissa_type >::argument_type u, typename JLANG::JClass< ordinate_type >::argument_type w2)
	Constructor.

	JBin1D (typename JLANG::JClass< abscissa_type >::argument_type x, typename JLANG::JClass< ordinate_type >::argument_type y)
	Constructor.

void	fill (typename JLANG::JClass< abscissa_type >::argument_type x, typename JLANG::JClass< ordinate_type >::argument_type w)
	Add abscissa value.

abscissa_type	getBinCenter () const
	Get bin center.

ordinate_type	getBinContent () const
	Get bin content.

ordinate_type	getBinError () const
	Get bin error.

ordinate_type	getEffectiveBinContent () const
	Get effective bin content.

JBin1D &	negate ()
	Negate bin.

JBin1D &	add (const JBin1D &bin)
	Add bin.

JBin1D &	sub (const JBin1D &bin)
	Subtract bin.

JBin1D &	mul (const double value)
	Scale contents.

JBin1D &	div (const double value)
	Divide contents.

JBin1D &	mul (const JBin1D &bin)
	Multiply bins.

abscissa_type	getX () const
	Get abscissa value.

const ordinate_type &	getY () const
	Get ordinate value.

ordinate_type &	getY ()
	Get ordinate value.

JFirst_t &	mul (const JSecond_t &object)
	Multiply with object.

Protected Attributes
abscissa_type	__u
	Sum of weighted abscissa values.

ordinate_type	__w2
	Sum of squared weights.

abscissa_type	__x

ordinate_type	__y

Detailed Description

template<class JAbscissa_t, class JOrdinate_t>
struct JTOOLS::JBin1D< JAbscissa_t, JOrdinate_t >

1D Binned element with bin centering.

Note that the internal data members needed for the calculation of the bin center are not subject to I/O, i.e. the I/O of this class is identical to that of the JElement2D class.

Definition at line 352 of file JElement.hh.

Member Typedef Documentation

◆ element_type

template<class JAbscissa_t , class JOrdinate_t >

JElement2D<JAbscissa_t, JOrdinate_t> JTOOLS::JBin1D< JAbscissa_t, JOrdinate_t >::element_type

Definition at line 357 of file JElement.hh.

◆ abscissa_type

template<class JAbscissa_t , class JOrdinate_t >

element_type::abscissa_type JTOOLS::JBin1D< JAbscissa_t, JOrdinate_t >::abscissa_type

Definition at line 359 of file JElement.hh.

◆ ordinate_type

template<class JAbscissa_t , class JOrdinate_t >

element_type::ordinate_type JTOOLS::JBin1D< JAbscissa_t, JOrdinate_t >::ordinate_type

Definition at line 360 of file JElement.hh.

Constructor & Destructor Documentation

◆ JBin1D() [1/3]

template<class JAbscissa_t , class JOrdinate_t >

JTOOLS::JBin1D< JAbscissa_t, JOrdinate_t >::JBin1D ( )

inline

Default constructor.

Definition at line 366 of file JElement.hh.

             :
      element_type(),
      __u (getZero<ordinate_type>()),
      __w2(getZero<ordinate_type>())
    {}

◆ JBin1D() [2/3]

template<class JAbscissa_t , class JOrdinate_t >

JTOOLS::JBin1D< JAbscissa_t, JOrdinate_t >::JBin1D	(	typename JLANG::JClass< abscissa_type >::argument_type	x,
		typename JLANG::JClass< ordinate_type >::argument_type	y,
		typename JLANG::JClass< abscissa_type >::argument_type	u,
		typename JLANG::JClass< ordinate_type >::argument_type	w2 )

inline

Constructor.

Parameters

x	abscissa value
y	ordinate value (sum of weights)
u	sum of weighted abscissa values
w2	sum of squared weights

Definition at line 381 of file JElement.hh.

                                                                :
      element_type(x,y),
      __u (u),
      __w2(w2)
    {
      using namespace JPP;
      
      if (w2 < getZero<ordinate_type>()) {
        THROW(JValueOutOfRange, "JBin1D::JBin1D(): Invalid sum of squared weights " << w2);
      }
    }

◆ JBin1D() [3/3]

template<class JAbscissa_t , class JOrdinate_t >

JTOOLS::JBin1D< JAbscissa_t, JOrdinate_t >::JBin1D	(	typename JLANG::JClass< abscissa_type >::argument_type	x,
		typename JLANG::JClass< ordinate_type >::argument_type	y )

inline

Constructor.

Parameters

x	abscissa value
y	ordinate value (sum of weights)

Definition at line 403 of file JElement.hh.

                                                               :
      JBin1D(x, y, x*y, y)
    {}

Member Function Documentation

◆ fill()

template<class JAbscissa_t , class JOrdinate_t >

void JTOOLS::JBin1D< JAbscissa_t, JOrdinate_t >::fill	(	typename JLANG::JClass< abscissa_type >::argument_type	x,
		typename JLANG::JClass< ordinate_type >::argument_type	w )

inline

Add abscissa value.

Parameters

x	abscissa value
w	weight

Definition at line 415 of file JElement.hh.

    { 
      this->__y  += w;
      this->__u  += w * x;
      this->__w2 += w * w;
    }

◆ getBinCenter()

template<class JAbscissa_t , class JOrdinate_t >

abscissa_type JTOOLS::JBin1D< JAbscissa_t, JOrdinate_t >::getBinCenter ( ) const

inline

Get bin center.

Returns: center

Definition at line 429 of file JElement.hh.

    { 
      if (this->__y != getZero<ordinate_type>())
        return this->__u / this->__y;
      else
        return this->__x;
    }

◆ getBinContent()

template<class JAbscissa_t , class JOrdinate_t >

ordinate_type JTOOLS::JBin1D< JAbscissa_t, JOrdinate_t >::getBinContent ( ) const

inline

Get bin content.

Returns: content

Definition at line 443 of file JElement.hh.

    { 
      return this->__y;
    }

◆ getBinError()

template<class JAbscissa_t , class JOrdinate_t >

ordinate_type JTOOLS::JBin1D< JAbscissa_t, JOrdinate_t >::getBinError ( ) const

inline

Get bin error.

Returns: error

Definition at line 454 of file JElement.hh.

    { 
      return sqrt(this->__w2);
    }

◆ getEffectiveBinContent()

template<class JAbscissa_t , class JOrdinate_t >

ordinate_type JTOOLS::JBin1D< JAbscissa_t, JOrdinate_t >::getEffectiveBinContent ( ) const

inline

Get effective bin content.

For a bin filled with identical weights the return value of this function
corresponds to a Poisson count with equivalent relative error.

Returns: effective bin content

Definition at line 467 of file JElement.hh.

    {
      using namespace JPP;
      
      const ordinate_type y  = getBinContent();
      const ordinate_type ey = getBinError();
 
      if (ey > getZero<ordinate_type>()) {
        return y*y/ey/ey;
      } else {
        THROW(JDivisionByZero, "JBin1D::getEffectiveBinContent(): Invalid effective bin content (bin content error is zero)");
      }
    }

◆ negate()

template<class JAbscissa_t , class JOrdinate_t >

JBin1D & JTOOLS::JBin1D< JAbscissa_t, JOrdinate_t >::negate ( )

inline

Negate bin.

Note: This method should only be used for binned elements which can hold negative weights.

Returns: this bin

Definition at line 488 of file JElement.hh.

    {
      this->__y = -this->__y;
 
      return *this;
    }

◆ add()

template<class JAbscissa_t , class JOrdinate_t >

JBin1D & JTOOLS::JBin1D< JAbscissa_t, JOrdinate_t >::add ( const JBin1D< JAbscissa_t, JOrdinate_t > & bin )

inline

Add bin.

Parameters

bin bin

Returns: this bin

Definition at line 502 of file JElement.hh.

    {
      this->__y  += bin.__y;
      this->__u  += bin.__u;
      this->__w2 += bin.__w2;
 
      return *this;
    }

◆ sub()

template<class JAbscissa_t , class JOrdinate_t >

JBin1D & JTOOLS::JBin1D< JAbscissa_t, JOrdinate_t >::sub ( const JBin1D< JAbscissa_t, JOrdinate_t > & bin )

inline

Subtract bin.

Parameters

bin bin

Returns: this bin

Definition at line 518 of file JElement.hh.

    {
      this->__y  -= bin.__y;
      this->__u  -= bin.__u;
      this->__w2 += bin.__w2;
 
      return *this;
    }

◆ mul() [1/3]

template<class JAbscissa_t , class JOrdinate_t >

JBin1D & JTOOLS::JBin1D< JAbscissa_t, JOrdinate_t >::mul ( const double value )

inline

Scale contents.

Parameters

value multiplication factor

Returns: this bin

Definition at line 534 of file JElement.hh.

    {
      this->__y  *= value;
      this->__u  *= value;
      this->__w2 *= value*value;
 
      return *this;
    }

◆ div()

template<class JAbscissa_t , class JOrdinate_t >

JBin1D & JTOOLS::JBin1D< JAbscissa_t, JOrdinate_t >::div ( const double value )

inline

Divide contents.

Parameters

value division factor

Returns: this bin

Definition at line 550 of file JElement.hh.

    {
      this->__y  /= value;
      this->__u  /= value;
      this->__w2 /= value*value;
 
      return *this;
    }

◆ mul() [2/3]

template<class JAbscissa_t , class JOrdinate_t >

JBin1D & JTOOLS::JBin1D< JAbscissa_t, JOrdinate_t >::mul ( const JBin1D< JAbscissa_t, JOrdinate_t > & bin )

inline

Multiply bins.

Parameters

bin bin

Returns: this bin

Definition at line 566 of file JElement.hh.

    {
      const double y1  = this->getBinContent();
      const double ey1 = this->getBinError();
      
      const double y2  = bin.getBinContent();
      const double ey2 = bin.getBinError();
 
      this->__y *= y2;
      this->__u *= y2;
      this->__w2 = ((ey1 * ey1 * y2 * y2) +
                    (ey2 * ey2 * y1 * y1));
      
      return *this;
    }

◆ getX()

template<class JAbscissa_t , class JOrdinate_t >

abscissa_type JTOOLS::JElement2D< JAbscissa_t, JOrdinate_t >::getX ( ) const

inlineinherited

Get abscissa value.

Returns: abscissa value

Definition at line 80 of file JElement.hh.

    { 
      return __x;
    }

◆ getY() [1/2]

template<class JAbscissa_t , class JOrdinate_t >

const ordinate_type & JTOOLS::JElement2D< JAbscissa_t, JOrdinate_t >::getY ( ) const

inlineinherited

Get ordinate value.

Returns: ordinate value

Definition at line 91 of file JElement.hh.

    { 
      return __y;
    }

◆ getY() [2/2]

template<class JAbscissa_t , class JOrdinate_t >

ordinate_type & JTOOLS::JElement2D< JAbscissa_t, JOrdinate_t >::getY ( )

inlineinherited

Get ordinate value.

Returns: ordinate value

Definition at line 102 of file JElement.hh.

    { 
      return __y;
    }

◆ mul() [3/3]

template<class JFirst_t , class JSecond_t >

JFirst_t & JMATH::JMath< JFirst_t, JSecond_t >::mul ( const JSecond_t & object )

inlineinherited

Multiply with object.

Parameters

object object

Returns: result object

Definition at line 354 of file JMath.hh.

    {
      return static_cast<JFirst_t&>(*this) = JFirst_t().mul(static_cast<const JFirst_t&>(*this), object);
    }

Member Data Documentation

◆ __u

template<class JAbscissa_t , class JOrdinate_t >

abscissa_type JTOOLS::JBin1D< JAbscissa_t, JOrdinate_t >::__u

protected

Sum of weighted abscissa values.

Definition at line 584 of file JElement.hh.

◆ __w2

template<class JAbscissa_t , class JOrdinate_t >

ordinate_type JTOOLS::JBin1D< JAbscissa_t, JOrdinate_t >::__w2

protected

Sum of squared weights.

Definition at line 585 of file JElement.hh.

◆ __x

template<class JAbscissa_t , class JOrdinate_t >

abscissa_type JTOOLS::JElement2D< JAbscissa_t, JOrdinate_t >::__x

protectedinherited

Definition at line 141 of file JElement.hh.

◆ __y

template<class JAbscissa_t , class JOrdinate_t >

ordinate_type JTOOLS::JElement2D< JAbscissa_t, JOrdinate_t >::__y

protectedinherited

Definition at line 142 of file JElement.hh.

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

JElement.hh

Public Types

Public Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

◆ element_type

◆ abscissa_type

◆ ordinate_type

Constructor & Destructor Documentation

◆ JBin1D() [1/3]

◆ JBin1D() [2/3]

◆ JBin1D() [3/3]

Member Function Documentation

◆ fill()

◆ getBinCenter()

◆ getBinContent()

◆ getBinError()

◆ getEffectiveBinContent()

◆ negate()

◆ add()

◆ sub()

◆ mul() [1/3]

◆ div()

◆ mul() [2/3]

◆ getX()

◆ getY() [1/2]

◆ getY() [2/2]

◆ mul() [3/3]

Member Data Documentation

◆ __u

◆ __w2

◆ __x

◆ __y