- <?xml version='1.0' encoding='UTF-8'?>
- <!DOCTYPE gdd SYSTEM 'gdd.dtd'>
- <gdd>
- <package name='TbEvent'>
- <class
- name = 'ChiSquare'
- author = 'Wouter Hulsbergen'
- desc = 'structure holding a chisquare and associated number of dofs'
- allocator = 'NO'
- virtual = 'FALSE'
- >
-
- <constructor
- desc = 'Constructor'
- initList = "m_chi2(chi2),m_nDoF(ndof)">
- <arg type='double' name='chi2' const='TRUE' />
- <arg type='int' name='ndof' />
- </constructor>
-
- <attribute
- type = 'double'
- name = 'chi2'
- desc = 'chi square'
- setMeth = 'FALSE' />
-
- <attribute
- type = 'int'
- name = 'nDoF'
- desc = 'number of degrees of freedom'
- setMeth = 'FALSE' />
-
- <method
- type = 'double'
- name = 'chi2PerDoF'
- desc = 'return chi2/ndof if ndof>0. returns zero otherwise.'
- const = 'TRUE'>
- <code>
- return m_nDoF>0 ? m_chi2/m_nDoF : 0 ;
- </code>
- </method>
-
- <method
- type = 'double'
- name = 'prob'
- desc = 'return chisquare upper tail probability if ndof>0. returns zero otherwise.'
- const = 'TRUE'>
- </method>
-
- <method
- type = 'LHCb::ChiSquare&'
- name = 'operator+='
- desc = 'addition operator' >
- <arg type = 'LHCb::ChiSquare' name='rhs' const='TRUE'/>
- <code>
- m_chi2 += rhs.m_chi2 ;
- m_nDoF += rhs.m_nDoF ;
- return *this ;
- </code>
- </method>
-
- <method
- type = 'LHCb::ChiSquare&'
- name = 'operator-='
- desc = 'subtraction operator' >
- <arg type = 'LHCb::ChiSquare' name='rhs' const='TRUE'/>
- <code>
- m_chi2 -= rhs.m_chi2 ;
- m_nDoF -= rhs.m_nDoF ;
- return *this ;
- </code>
- </method>
-
- <method
- type = 'LHCb::ChiSquare'
- name = 'operator+'
- desc = 'addition operator' >
- <arg type = 'LHCb::ChiSquare' name='rhs' const='TRUE'/>
- <code>
- ChiSquare rc = *this ;
- rc += rhs ;
- return rc ;
- </code>
- </method>
-
- <method
- type = 'LHCb::ChiSquare'
- name = 'operator-'
- desc = 'subtraction operator' >
- <arg type = 'LHCb::ChiSquare' name='rhs' const='TRUE'/>
- <code>
- ChiSquare rc = *this ;
- rc -= rhs ;
- return rc ;
- </code>
- </method>
-
-
- </class>
- </package>
- </gdd>