Gromacs  2024.4
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
List of all members | Public Types | Public Member Functions
gmx::NormalDistribution< RealType >::param_type Class Reference

#include <gromacs/random/normaldistribution.h>

Description

template<class RealType = real>
class gmx::NormalDistribution< RealType >::param_type

Normal distribution parameters.

Public Types

typedef NormalDistribution distribution_type
 Reference back to the distribution class.
 

Public Member Functions

 param_type (result_type mean=0.0, result_type stddev=1.0)
 Construct parameter block. More...
 
result_type mean () const
 Return first parameter.
 
result_type stddev () const
 Return second parameter.
 
bool operator== (const param_type &x) const
 True if two parameter sets will return the same normal distribution. More...
 
bool operator!= (const param_type &x) const
 True if two parameter sets will return different normal distributions. More...
 

Constructor & Destructor Documentation

template<class RealType = real>
gmx::NormalDistribution< RealType >::param_type::param_type ( result_type  mean = 0.0,
result_type  stddev = 1.0 
)
inlineexplicit

Construct parameter block.

Parameters
meanMean of normal distribution
stddevStandard deviation of normal distribution

Member Function Documentation

template<class RealType = real>
bool gmx::NormalDistribution< RealType >::param_type::operator!= ( const param_type x) const
inline

True if two parameter sets will return different normal distributions.

Parameters
xInstance to compare with.
template<class RealType = real>
bool gmx::NormalDistribution< RealType >::param_type::operator== ( const param_type x) const
inline

True if two parameter sets will return the same normal distribution.

Parameters
xInstance to compare with.

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