hitfit::Base_Constrainer_Args Class Reference

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

#include <Base_Constrainer.h>

Public Member Functions
	Base_Constrainer_Args (const Defaults &defs)
double	test_eps () const
bool	test_gradient () const
double	test_step () const

Private Attributes
double	_test_eps
bool	_test_gradient
double	_test_step

Detailed Description

Hold on to parameters for the Base_Constrainer class.

Definition at line 54 of file Base_Constrainer.h.

Constructor & Destructor Documentation

Base_Constrainer_Args()

hitfit::Base_Constrainer_Args::Base_Constrainer_Args

(

const Defaults &

defs

)

Instantiate Base_Constrainer_Args from an instance of Defaults object.

Parameters

defs	An instance of Defaults object. The instance must contain the variables of type and name: bool test_gradient. double test_step. double test_eps.

Definition at line 94 of file Base_Constrainer.cc.

      : _test_gradient(defs.get_bool("test_gradient")),
        _test_step(defs.get_float("test_step")),
        _test_eps(defs.get_float("test_eps")) {}

Member Function Documentation

test_eps()

double hitfit::Base_Constrainer_Args::test_eps

(

)

const

Return the _test_eps parameter.

Definition at line 123 of file Base_Constrainer.cc.

References _test_eps.

  {
    return _test_eps;
  }

test_gradient()

bool hitfit::Base_Constrainer_Args::test_gradient

(

)

const

Return the _test_gradient parameter.

Definition at line 105 of file Base_Constrainer.cc.

References _test_gradient.

  {
    return _test_gradient;
  }

test_step()

double hitfit::Base_Constrainer_Args::test_step

(

)

const

Return the _test_step parameter.

Definition at line 114 of file Base_Constrainer.cc.

References _test_step.

  {
    return _test_step;
  }

Member Data Documentation

_test_eps

double hitfit::Base_Constrainer_Args::_test_eps

private

When _test_gradient is true, the maximum relative difference permitted between returned and numerically calculated gradients.

Definition at line 117 of file Base_Constrainer.h.

Referenced by test_eps().

_test_gradient

bool hitfit::Base_Constrainer_Args::_test_gradient

private

If true, check constraint gradient calculation by also doing them numerically.

Definition at line 105 of file Base_Constrainer.h.

Referenced by test_gradient().

_test_step

double hitfit::Base_Constrainer_Args::_test_step

private

When _test_gradient is true, the step size use for numerical differentation.

Definition at line 111 of file Base_Constrainer.h.

Referenced by test_step().