Auxiliary class for fit parameter with optional limits. More...

#include <JFitK40.hh>

Inheritance diagram for JCALIBRATE::JParameter_t:

Public Types
enum	FIT_t { FREE_t = 0 , FIXED_t }
	Fit options. More...

typedef JTOOLS::JRange< double >	range_type
	Type definition for range of parameter values.

Public Member Functions
	JParameter_t ()
	Default constructor.

	JParameter_t (const double value, const range_type &range=range_type::DEFAULT_RANGE())
	Constructor.

JParameter_t &	negate ()
	Negate parameter.

JParameter_t &	add (const JParameter_t &parameter)
	Add parameter.

JParameter_t &	sub (const JParameter_t &parameter)
	Subtract parameter.

JParameter_t &	mul (const double factor)
	Scale parameter.

JParameter_t &	div (const double factor)
	Scale parameter.

JParameter_t &	mul (const JParameter_t &first, const JParameter_t &second)
	Scale parameter.

bool	isFree () const
	Check if parameter is free.

bool	isFixed () const
	Check if parameter is fixed.

bool	isBound () const
	Check if parameter is bound.

void	set ()
	Set current value.

void	fix ()
	Fix current value.

double	get () const
	Get value.

void	set (const double value)
	Set value.

void	setLimits (const double xmin, const double xmax)
	Set limits.

void	relax ()
	Relax limits.

bool	atLimit (const double precision) const
	Check if parameter is at limit.

void	fix (const double value)
	Fix value.

double	getDerivative () const
	Get derivative of value.

double	operator() () const
	Type conversion operator.

	operator double () const
	Type conversion operator.

JParameter_t &	operator= (double value)
	Assignment operator.

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

Public Attributes
double	value = 0.0

FIT_t	option = FREE_t

range_type	range = range_type::DEFAULT_RANGE()

Friends
std::istream &	operator>> (std::istream &in, JParameter_t &object)
	Read parameter from input stream.

std::ostream &	operator<< (std::ostream &out, const JParameter_t &object)
	Write parameter to output stream.

Detailed Description

Auxiliary class for fit parameter with optional limits.

Definition at line 113 of file JFitK40.hh.

Member Typedef Documentation

◆ range_type

JTOOLS::JRange<double> JCALIBRATE::JParameter_t::range_type

Type definition for range of parameter values.

Definition at line 129 of file JFitK40.hh.

Member Enumeration Documentation

◆ FIT_t

enum JCALIBRATE::JParameter_t::FIT_t

Fit options.

Enumerator
FREE_t	free
FIXED_t	fixed

Definition at line 120 of file JFitK40.hh.

               {
      FREE_t  =  0,                    //!< free
      FIXED_t                          //!< fixed
    };

Constructor & Destructor Documentation

◆ JParameter_t() [1/2]

JCALIBRATE::JParameter_t::JParameter_t ( )

inline

Default constructor.

Definition at line 135 of file JFitK40.hh.

    {
      set(0.0);
    }

◆ JParameter_t() [2/2]

JCALIBRATE::JParameter_t::JParameter_t	(	const double	value,
		const range_type &	range = range_type::DEFAULT_RANGE() )

inline

Constructor.

Parameters

value	value
range	range

Definition at line 147 of file JFitK40.hh.

                                                                      :
      range(range)
    {
      set(value);
    }

Member Function Documentation

◆ negate()

JParameter_t & JCALIBRATE::JParameter_t::negate ( )

inline

Negate parameter.

Returns: this parameter

Definition at line 160 of file JFitK40.hh.

    {
      set(-get());
 
      return *this;
    }

◆ add()

JParameter_t & JCALIBRATE::JParameter_t::add ( const JParameter_t & parameter )

inline

Add parameter.

Parameters

parameter parameter

Returns: this parameter

Definition at line 174 of file JFitK40.hh.

    {
      set(get() + parameter.get());
 
      return *this;
    }

◆ sub()

JParameter_t & JCALIBRATE::JParameter_t::sub ( const JParameter_t & parameter )

inline

Subtract parameter.

Parameters

parameter parameter

Returns: this parameter

Definition at line 188 of file JFitK40.hh.

    {
      set(get() - parameter.get());
 
      return *this;
    }

◆ mul() [1/3]

JParameter_t & JCALIBRATE::JParameter_t::mul ( const double factor )

inline

Scale parameter.

Parameters

factor multiplication factor

Returns: this parameter

Definition at line 202 of file JFitK40.hh.

    {
      set(get() * factor);
 
      return *this;
    }

◆ div()

JParameter_t & JCALIBRATE::JParameter_t::div ( const double factor )

inline

Scale parameter.

Parameters

factor division factor

Returns: this parameter

Definition at line 216 of file JFitK40.hh.

    {
      set(get() / factor);
 
      return *this;
    }

◆ mul() [2/3]

JParameter_t & JCALIBRATE::JParameter_t::mul	(	const JParameter_t &	first,
		const JParameter_t &	second )

inline

Scale parameter.

Parameters

first	first parameter
second	second parameter

Returns: this parameter

Definition at line 231 of file JFitK40.hh.

    {
      set(first.get() * second.get());
 
      return *this;
    }

◆ isFree()

bool JCALIBRATE::JParameter_t::isFree ( ) const

inline

Check if parameter is free.

Returns: true if free; else false

Definition at line 244 of file JFitK40.hh.

    {
      return option == FREE_t;
    }

◆ isFixed()

bool JCALIBRATE::JParameter_t::isFixed ( ) const

inline

Check if parameter is fixed.

Returns: true if fixed; else false

Definition at line 255 of file JFitK40.hh.

    {
      return option == FIXED_t;
    }

◆ isBound()

bool JCALIBRATE::JParameter_t::isBound ( ) const

inline

Check if parameter is bound.

Returns: true if bound; else false

Definition at line 266 of file JFitK40.hh.

    {
      return range.is_valid();
    }

◆ set() [1/2]

void JCALIBRATE::JParameter_t::set ( )

inline

Set current value.

Definition at line 275 of file JFitK40.hh.

    {
      option = FREE_t;
    }

◆ fix() [1/2]

void JCALIBRATE::JParameter_t::fix ( )

inline

Fix current value.

Definition at line 284 of file JFitK40.hh.

    {
      option = FIXED_t;
    }

◆ get()

double JCALIBRATE::JParameter_t::get ( ) const

inline

Get value.

Returns: value

Definition at line 295 of file JFitK40.hh.

    {
      if (isBound()) 
        return range.getLowerLimit()  +  0.5 * range.getLength() * (sin(value) + 1.0);
      else
        return value;
    }

◆ set() [2/2]

void JCALIBRATE::JParameter_t::set ( const double value )

inline

Set value.

Parameters

value value

Definition at line 309 of file JFitK40.hh.

    {
      if (isBound()) 
        this->value = asin(2.0 * (range.constrain(value) - range.getLowerLimit()) / range.getLength() - 1.0);
      else
        this->value = value;
 
      set();
    }

◆ setLimits()

void JCALIBRATE::JParameter_t::setLimits	(	const double	xmin,
		const double	xmax )

inline

Set limits.

Parameters

xmin	minimal value
xmax	maximal value

Definition at line 326 of file JFitK40.hh.

    {
      const double x = get();
 
      range = range_type(xmin, xmax);
 
      set(x);
    }

◆ relax()

void JCALIBRATE::JParameter_t::relax ( )

inline

Relax limits.

Definition at line 339 of file JFitK40.hh.

    {
      const double x = get();
 
      range = range_type::DEFAULT_RANGE();
 
      set(x);
    }

◆ atLimit()

bool JCALIBRATE::JParameter_t::atLimit ( const double precision ) const

inline

Check if parameter is at limit.

Parameters

precision precision

Returns: true if at limit; else false

Definition at line 355 of file JFitK40.hh.

    {
      if (isBound())
        return (get() - range.getLowerLimit() <= precision ||
                range.getUpperLimit() - get() <= precision);
      else
        return false;
    }

◆ fix() [2/2]

void JCALIBRATE::JParameter_t::fix ( const double value )

inline

Fix value.

Parameters

value value

Definition at line 370 of file JFitK40.hh.

    {
      set(value);
 
      fix();
    }

◆ getDerivative()

double JCALIBRATE::JParameter_t::getDerivative ( ) const

inline

Get derivative of value.

Returns: derivative of value

Definition at line 383 of file JFitK40.hh.

    {
      if (isBound())
        return 1.0 / (0.5 * range.getLength() * cos(value));
      else
        return 1.0;
    }

◆ operator()()

double JCALIBRATE::JParameter_t::operator() ( ) const

inline

Type conversion operator.

Returns: value

Definition at line 397 of file JFitK40.hh.

    {
      return get();
    }

◆ operator double()

JCALIBRATE::JParameter_t::operator double ( ) const

inline

Type conversion operator.

Returns: value

Definition at line 408 of file JFitK40.hh.

    {
      return get();
    }

◆ operator=()

JParameter_t & JCALIBRATE::JParameter_t::operator= ( double value )

inline

Assignment operator.

Parameters

value value

Returns: this parameter

Definition at line 420 of file JFitK40.hh.

    {
      set(value);
 
      return *this;
    }

◆ mul() [3/3]

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);
    }

Friends And Related Symbol Documentation

◆ operator>>

std::istream & operator>>	(	std::istream &	in,
		JParameter_t &	object )

friend

Read parameter from input stream.

Parameters

in	input stream
object	parameter

Returns: input stream

Definition at line 435 of file JFitK40.hh.

    {
      return in >> object.value;
    }

◆ operator<<

std::ostream & operator<<	(	std::ostream &	out,
		const JParameter_t &	object )

friend

Write parameter to output stream.

Parameters

out	output stream
object	parameter

Returns: output stream

Definition at line 448 of file JFitK40.hh.

    {
      using namespace std;
 
      out << FIXED(12,6) <<  object.get()                       << ' '
          << setw(5)     << (object.isFixed() ? "fixed" : " ")  << ' ';
 
      if (object.isBound()) {
        out << "[" << FIXED(12,6) << object.range.getLowerLimit() << "," << FIXED(12,6) << object.range.getUpperLimit() << "]";
      }
 
      return out;
    }

Member Data Documentation

◆ value

double JCALIBRATE::JParameter_t::value = 0.0

Definition at line 463 of file JFitK40.hh.

◆ option

FIT_t JCALIBRATE::JParameter_t::option = FREE_t

Definition at line 464 of file JFitK40.hh.

◆ range

range_type JCALIBRATE::JParameter_t::range = range_type::DEFAULT_RANGE()

Definition at line 465 of file JFitK40.hh.

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

JFitK40.hh

Public Types

Public Member Functions

Public Attributes

Friends

Detailed Description

Member Typedef Documentation

◆ range_type

Member Enumeration Documentation

◆ FIT_t

Constructor & Destructor Documentation

◆ JParameter_t() [1/2]

◆ JParameter_t() [2/2]

Member Function Documentation

◆ negate()

◆ add()

◆ sub()

◆ mul() [1/3]

◆ div()

◆ mul() [2/3]

◆ isFree()

◆ isFixed()

◆ isBound()

◆ set() [1/2]

◆ fix() [1/2]

◆ get()

◆ set() [2/2]

◆ setLimits()

◆ relax()

◆ atLimit()

◆ fix() [2/2]

◆ getDerivative()

◆ operator()()

◆ operator double()

◆ operator=()

◆ mul() [3/3]

Friends And Related Symbol Documentation

◆ operator>>

◆ operator<<

Member Data Documentation

◆ value

◆ option

◆ range