stf::parInfo Struct Reference

Information about parameters used in storedFunc. More...

#include <stfmath.h>

Collaboration diagram for stf::parInfo:

List of all members.

Public Member Functions
	parInfo ()
	Default constructor.
	parInfo (const std::string &desc_, bool toFit_, bool constrained_=false, double constr_lb_=0, double constr_ub_=0, Scale scale_=noscale, Scale unscale_=noscale)
	Constructor.
Public Attributes
std::string	desc
bool	toFit
bool	constrained
double	constr_lb
double	constr_ub
Scale	scale
Scale	unscale

---

Detailed Description

Information about parameters used in storedFunc.

Contains information about a function's parameters used in storedFunc (see below). The client supplies a description (desc) and determines whether the parameter is to be fitted (toFit==true) or to be kept constant (toFit==false).

---

Constructor & Destructor Documentation

stf::parInfo::parInfo	(	const std::string &	desc_,
		bool	toFit_,
		bool	constrained_ = false,
		double	constr_lb_ = 0,
		double	constr_ub_ = 0,
		Scale	scale_ = noscale,
		Scale	unscale_ = noscale
	)		[inline]

Constructor.

Parameters:

desc_	Parameter description string
toFit_	true if this parameter should be fitted, false if it should be kept fixed.
constrained_	true if this is a constrained fit
constr_lb_	lower bound for constrained fit
constr_ub_	upper bound for constrained fit
scale_	scaling function
unscale_	unscaling function

---

Member Data Documentation

double stf::parInfo::constr_lb

Lower boundary for box-constrained fits

double stf::parInfo::constr_ub

Upper boundary for box-constrained fits

bool stf::parInfo::constrained

true if this parameter should be constrained

std::string stf::parInfo::desc

Parameter description string

Scale stf::parInfo::scale

Scaling function for this parameter

bool stf::parInfo::toFit

true if this parameter should be fitted, false if it should be kept fixed.

Scale stf::parInfo::unscale

Unscaling function for this parameter

---

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

• src/stimfit/math/stfmath.h