Hold on to parameters for the Chisq_Constrainer class. More...

#include <Chisq_Constrainer.h>

Public Member Functions
const Base_Constrainer_Args &	base_constrainer_args () const

	Chisq_Constrainer_Args (const Defaults &defs)
	Constructor, creates an instance of Chisq_Constrainer_Args from a Defaults object. More...

double	chisq_diff_eps () const

double	chisq_test_eps () const

double	constraint_sum_eps () const

double	cutsize () const

unsigned	max_cut () const

unsigned	maxit () const

double	min_tot_cutsize () const

bool	printfit () const

bool	use_G () const

Private Attributes
const Base_Constrainer_Args	_base_constrainer_args

double	_chisq_diff_eps

double	_chisq_test_eps

double	_constraint_sum_eps

double	_cutsize

int	_max_cut

int	_maxit

double	_min_tot_cutsize

bool	_printfit

bool	_use_G

Detailed Description

Hold on to parameters for the Chisq_Constrainer class.

Definition at line 80 of file Chisq_Constrainer.h.

Constructor & Destructor Documentation

◆ Chisq_Constrainer_Args()

hitfit::Chisq_Constrainer_Args::Chisq_Constrainer_Args ( const Defaults & defs )

Constructor, creates an instance of Chisq_Constrainer_Args from a Defaults object.

Parameters

defs	The Defaults instance from which to instantiate. The instance must contain variables of type and name: bool use_G. bool printfit. double constraint_sum_eps. double chisq_diff_eps. int maxit. int max_cut. double cutsize. double min_tot_cutsize. double chisq_test_eps.

Definition at line 57 of file Chisq_Constrainer.cc.

       : _base_constrainer_args(defs) {
     _use_G = defs.get_bool("use_G");
     _printfit = defs.get_bool("printfit");
     _constraint_sum_eps = defs.get_float("constraint_sum_eps");
     _chisq_diff_eps = defs.get_float("chisq_diff_eps");
     _maxit = defs.get_int("maxit");
     _max_cut = defs.get_int("maxcut");
     _cutsize = defs.get_float("cutsize");
     _min_tot_cutsize = defs.get_float("min_tot_cutsize");
     _chisq_test_eps = defs.get_float("chisq_test_eps");
   }

References _chisq_diff_eps, _chisq_test_eps, _constraint_sum_eps, _cutsize, _max_cut, _maxit, _min_tot_cutsize, _printfit, _use_G, hitfit::Defaults::get_bool(), hitfit::Defaults::get_float(), and hitfit::Defaults::get_int().

Member Function Documentation

◆ base_constrainer_args()

const Base_Constrainer_Args & hitfit::Chisq_Constrainer_Args::base_constrainer_args ( ) const

Return the argument for the Base_Constrainer class.

Definition at line 157 of file Chisq_Constrainer.cc.

   {
     return _base_constrainer_args;
   }

References _base_constrainer_args.

◆ chisq_diff_eps()

double hitfit::Chisq_Constrainer_Args::chisq_diff_eps ( ) const

Return the chisq_diff_eps parameter.

Definition at line 103 of file Chisq_Constrainer.cc.

   {
     return _chisq_diff_eps;
   }

References _chisq_diff_eps.

Referenced by hitfit::Chisq_Constrainer::fit().

◆ chisq_test_eps()

double hitfit::Chisq_Constrainer_Args::chisq_test_eps ( ) const

Return the chisq_test_eps parameter.

Definition at line 148 of file Chisq_Constrainer.cc.

   {
     return _chisq_test_eps;
   }

References _chisq_test_eps.

Referenced by hitfit::Chisq_Constrainer::fit().

◆ constraint_sum_eps()

double hitfit::Chisq_Constrainer_Args::constraint_sum_eps ( ) const

Return the constraint_sum_eps parameter.

Definition at line 94 of file Chisq_Constrainer.cc.

   {
     return _constraint_sum_eps;
   }

References _constraint_sum_eps.

Referenced by hitfit::Chisq_Constrainer::fit().

◆ cutsize()

double hitfit::Chisq_Constrainer_Args::cutsize ( ) const

Return the cutsize parameter.

Definition at line 130 of file Chisq_Constrainer.cc.

   {
     return _cutsize;
   }

References _cutsize.

Referenced by hitfit::Chisq_Constrainer::fit().

◆ max_cut()

unsigned hitfit::Chisq_Constrainer_Args::max_cut ( ) const

Return the max_cut parameter.

Definition at line 121 of file Chisq_Constrainer.cc.

   {
     return _max_cut;
   }

References _max_cut.

Referenced by hitfit::Chisq_Constrainer::fit().

◆ maxit()

unsigned hitfit::Chisq_Constrainer_Args::maxit ( ) const

Return the maxit parameter.

Definition at line 112 of file Chisq_Constrainer.cc.

   {
     return _maxit;
   }

References _maxit.

Referenced by hitfit::Chisq_Constrainer::fit().

◆ min_tot_cutsize()

double hitfit::Chisq_Constrainer_Args::min_tot_cutsize ( ) const

Return the min_tot_cutsize parameter.

Definition at line 139 of file Chisq_Constrainer.cc.

   {
     return _min_tot_cutsize;
   }

References _min_tot_cutsize.

Referenced by hitfit::Chisq_Constrainer::fit().

◆ printfit()

bool hitfit::Chisq_Constrainer_Args::printfit ( ) const

Return the printfit parameter.

Definition at line 76 of file Chisq_Constrainer.cc.

   {
     return _printfit;
   }

References _printfit.

Referenced by hitfit::Chisq_Constrainer::fit().

◆ use_G()

bool hitfit::Chisq_Constrainer_Args::use_G ( ) const

Return the use_G parameter.

Definition at line 85 of file Chisq_Constrainer.cc.

   {
     return _use_G;
   }

References _use_G.

Referenced by hitfit::Chisq_Constrainer::fit().

Member Data Documentation

◆ _base_constrainer_args

const Base_Constrainer_Args hitfit::Chisq_Constrainer_Args::_base_constrainer_args

private

Parameters for the underlying base class Base_Constrainer.

Definition at line 234 of file Chisq_Constrainer.h.

Referenced by base_constrainer_args().

◆ _chisq_diff_eps

double hitfit::Chisq_Constrainer_Args::_chisq_diff_eps

private

Convergence threshold for change in $\chi^{2}$ .

Definition at line 203 of file Chisq_Constrainer.h.

Referenced by Chisq_Constrainer_Args(), and chisq_diff_eps().

◆ _chisq_test_eps

double hitfit::Chisq_Constrainer_Args::_chisq_test_eps

private

When use_G is true, the maximum relative difference between the $\chi^{2}$ calculations.

Definition at line 229 of file Chisq_Constrainer.h.

Referenced by Chisq_Constrainer_Args(), and chisq_test_eps().

◆ _constraint_sum_eps

double hitfit::Chisq_Constrainer_Args::_constraint_sum_eps

private

Convergence threshold for sum of constraints.

Definition at line 198 of file Chisq_Constrainer.h.

Referenced by Chisq_Constrainer_Args(), and constraint_sum_eps().

◆ _cutsize

double hitfit::Chisq_Constrainer_Args::_cutsize

private

Fraction by which to cut steps.

Definition at line 218 of file Chisq_Constrainer.h.

Referenced by Chisq_Constrainer_Args(), and cutsize().

◆ _max_cut

int hitfit::Chisq_Constrainer_Args::_max_cut

private

Maximum number of cut steps permitted.

Definition at line 213 of file Chisq_Constrainer.h.

Referenced by Chisq_Constrainer_Args(), and max_cut().

◆ _maxit

int hitfit::Chisq_Constrainer_Args::_maxit

private

Maxium number of iterations permitted.

Definition at line 208 of file Chisq_Constrainer.h.

Referenced by Chisq_Constrainer_Args(), and maxit().

◆ _min_tot_cutsize

double hitfit::Chisq_Constrainer_Args::_min_tot_cutsize

private

Smallest fractional cut step permitted.

Definition at line 223 of file Chisq_Constrainer.h.

Referenced by Chisq_Constrainer_Args(), and min_tot_cutsize().

◆ _printfit

bool hitfit::Chisq_Constrainer_Args::_printfit

private

If true, print a trace of the fit to std::cout.

Definition at line 186 of file Chisq_Constrainer.h.

Referenced by Chisq_Constrainer_Args(), and printfit().

◆ _use_G

bool hitfit::Chisq_Constrainer_Args::_use_G

private

If true, check the $\chi^{2}$ formula by computing the $\chi^{2}$ directly from ${\bf G}$ . This requires that ${\bf G}_{i}$ be invertible.

Definition at line 193 of file Chisq_Constrainer.h.

Referenced by Chisq_Constrainer_Args(), and use_G().

Public Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ Chisq_Constrainer_Args()

Member Function Documentation

◆ base_constrainer_args()

◆ chisq_diff_eps()

◆ chisq_test_eps()

◆ constraint_sum_eps()

◆ cutsize()

◆ max_cut()

◆ maxit()

◆ min_tot_cutsize()

◆ printfit()

◆ use_G()

Member Data Documentation

◆ _base_constrainer_args

◆ _chisq_diff_eps

◆ _chisq_test_eps

◆ _constraint_sum_eps

◆ _cutsize

◆ _max_cut

◆ _maxit

◆ _min_tot_cutsize

◆ _printfit

◆ _use_G