2D Binned element. More...

#include <JElement.hh>

Inheritance diagram for JTOOLS::JBin2D< 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
	JBin2D ()
	Default constructor. More...

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

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

abscissa_type	getBinCenter () const
	Get bin center. More...

ordinate_type	getBinContent () const
	Get bin content. More...

ordinate_type	getBinError () const
	Get bin error. More...

JBin2D &	add (const JBin2D &bin)
	Add bin. More...

JBin2D &	mul (const double value)
	Scale contents. More...

JBin2D &	div (const double value)
	Scale contents. More...

abscissa_type	getX () const
	Get abscissa value. More...

const ordinate_type &	getY () const
	Get ordinate value. More...

ordinate_type &	getY ()
	Get ordinate value. More...

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

Protected Attributes
ordinate_type	__z

ordinate_type	__w2

abscissa_type	__x

ordinate_type	__y

Detailed Description

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

2D Binned element.

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 351 of file JElement.hh.

Member Typedef Documentation

◆ element_type

template<class JAbscissa_t , class JOrdinate_t >

typedef JElement2D<JAbscissa_t, JOrdinate_t> JTOOLS::JBin2D< JAbscissa_t, JOrdinate_t >::element_type

Definition at line 356 of file JElement.hh.

◆ abscissa_type

template<class JAbscissa_t , class JOrdinate_t >

typedef element_type::abscissa_type JTOOLS::JBin2D< JAbscissa_t, JOrdinate_t >::abscissa_type

Definition at line 357 of file JElement.hh.

◆ ordinate_type

template<class JAbscissa_t , class JOrdinate_t >

typedef element_type::ordinate_type JTOOLS::JBin2D< JAbscissa_t, JOrdinate_t >::ordinate_type

Definition at line 358 of file JElement.hh.

Constructor & Destructor Documentation

◆ JBin2D() [1/2]

template<class JAbscissa_t , class JOrdinate_t >

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

inline

Default constructor.

Definition at line 364 of file JElement.hh.

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

◆ JBin2D() [2/2]

template<class JAbscissa_t , class JOrdinate_t >

JTOOLS::JBin2D< JAbscissa_t, JOrdinate_t >::JBin2D	(	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

Definition at line 377 of file JElement.hh.

                                                                :
       element_type(x,y),
       __z (getZero<ordinate_type>()),
       __w2(getZero<ordinate_type>())
     {}

Member Function Documentation

◆ fill()

template<class JAbscissa_t , class JOrdinate_t >

void JTOOLS::JBin2D< 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 391 of file JElement.hh.

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

◆ getBinCenter()

template<class JAbscissa_t , class JOrdinate_t >

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

inline

Get bin center.

Returns: center

Definition at line 405 of file JElement.hh.

     { 
       if (this->__y != 0) 
         return this->__z / this->__y;
       else
         return this->__x;
     }

◆ getBinContent()

template<class JAbscissa_t , class JOrdinate_t >

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

inline

Get bin content.

Returns: content

Definition at line 419 of file JElement.hh.

     { 
       return this->__y;
     }

◆ getBinError()

template<class JAbscissa_t , class JOrdinate_t >

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

inline

Get bin error.

Returns: error

Definition at line 430 of file JElement.hh.

     { 
       return sqrt(this->__w2);
     }

◆ add()

template<class JAbscissa_t , class JOrdinate_t >

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

inline

Add bin.

Parameters

bin bin

Returns: this bin

Definition at line 442 of file JElement.hh.

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

◆ mul() [1/2]

template<class JAbscissa_t , class JOrdinate_t >

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

inline

Scale contents.

Parameters

value multiplication factor

Returns: this bin

Definition at line 458 of file JElement.hh.

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

◆ div()

template<class JAbscissa_t , class JOrdinate_t >

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

inline

Scale contents.

Parameters

value division factor

Returns: this bin

Definition at line 474 of file JElement.hh.

     {
       this->__y  /= value;
       this->__z  /= value;
       this->__w2 /= value*value;
  
       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 79 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 90 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 101 of file JElement.hh.

     { 
       return __y;
     }

◆ mul() [2/2]

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

◆ __z

template<class JAbscissa_t , class JOrdinate_t >

ordinate_type JTOOLS::JBin2D< JAbscissa_t, JOrdinate_t >::__z

protected

Definition at line 485 of file JElement.hh.

◆ __w2

template<class JAbscissa_t , class JOrdinate_t >

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

protected

Definition at line 486 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 140 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 141 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

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

Member Typedef Documentation

◆ element_type

◆ abscissa_type

◆ ordinate_type

Constructor & Destructor Documentation

◆ JBin2D() [1/2]

◆ JBin2D() [2/2]

Member Function Documentation

◆ fill()

◆ getBinCenter()

◆ getBinContent()

◆ getBinError()

◆ add()

◆ mul() [1/2]

◆ div()

◆ getX()

◆ getY() [1/2]

◆ getY() [2/2]

◆ mul() [2/2]

Member Data Documentation

◆ __z

◆ __w2

◆ __x

◆ __y

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