ActsFatras::LandauDistribution::param_type Struct Reference

Parameter struct that contains all distribution parameters. More...

#include <acts/blob/sPHENIX/Fatras/include/ActsFatras/Utilities/LandauDistribution.hpp>

Public Types
using	distribution_type = LandauDistribution
	Parameters must link back to the host distribution.

Public Member Functions
	param_type (double location_, double scale_)
	Construct from parameters.
	param_type ()=default
	param_type (const param_type &)=default
	param_type (param_type &&)=default
param_type &	operator= (const param_type &)=default
param_type &	operator= (param_type &&)=default

Public Attributes
double	location = 0.0
double	scale = 1.0
	Scale parameter.

Friends
bool	operator== (const param_type &lhs, const param_type &rhs)
	Parameters should be EqualityComparable.
bool	operator!= (const param_type &lhs, const param_type &rhs)

Detailed Description

Parameter struct that contains all distribution parameters.

Definition at line 21 of file LandauDistribution.hpp.

View newest version in sPHENIX GitHub at line 21 of file LandauDistribution.hpp

Member Typedef Documentation

using ActsFatras::LandauDistribution::param_type::distribution_type = LandauDistribution

Parameters must link back to the host distribution.

Definition at line 23 of file LandauDistribution.hpp.

View newest version in sPHENIX GitHub at line 23 of file LandauDistribution.hpp

Constructor & Destructor Documentation

ActsFatras::LandauDistribution::param_type::param_type ( double  location_, double  scale_  )

inline

Construct from parameters.

Definition at line 33 of file LandauDistribution.hpp.

View newest version in sPHENIX GitHub at line 33 of file LandauDistribution.hpp

ActsFatras::LandauDistribution::param_type::param_type ( )

default

ActsFatras::LandauDistribution::param_type::param_type ( const param_type &  )

default

ActsFatras::LandauDistribution::param_type::param_type ( param_type &&  )

default

Member Function Documentation

param_type& ActsFatras::LandauDistribution::param_type::operator= ( const param_type &  )

default

param_type& ActsFatras::LandauDistribution::param_type::operator= ( param_type &&  )

default

Friends And Related Function Documentation

bool operator!= ( const param_type &  lhs, const param_type &  rhs  )

friend

Definition at line 46 of file LandauDistribution.hpp.

View newest version in sPHENIX GitHub at line 46 of file LandauDistribution.hpp

bool operator== ( const param_type &  lhs, const param_type &  rhs  )

friend

Parameters should be EqualityComparable.

Definition at line 43 of file LandauDistribution.hpp.

View newest version in sPHENIX GitHub at line 43 of file LandauDistribution.hpp

Member Data Documentation

double ActsFatras::LandauDistribution::param_type::location = 0.0

Location parameter.

Warning

This is neither the mean nor the most probable value.

Definition at line 28 of file LandauDistribution.hpp.

View newest version in sPHENIX GitHub at line 28 of file LandauDistribution.hpp

Referenced by ActsFatras::LandauDistribution::operator()().

double ActsFatras::LandauDistribution::param_type::scale = 1.0

Scale parameter.

Definition at line 30 of file LandauDistribution.hpp.

View newest version in sPHENIX GitHub at line 30 of file LandauDistribution.hpp

Referenced by ActsFatras::LandauDistribution::operator()().

---

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

• acts/blob/sPHENIX/Fatras/include/ActsFatras/Utilities/LandauDistribution.hpp