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

#include <gromacs/random/tabulatednormaldistribution.h>

Description

template<class RealType = real, unsigned int tableBits = c_TabulatedNormalDistributionDefaultBits>
class gmx::TabulatedNormalDistribution< RealType, tableBits >::param_type

Normal distribution parameter class (mean and stddev)

Public Types

typedef TabulatedNormalDistribution distribution_type
 The type of distribution the parameters describe.
 

Public Member Functions

 param_type (result_type mean=0.0, result_type stddev=1.0)
 Constructor. Default is classical distr. with mean 0, stddev 1. More...
 
result_type mean () const
 Return mean parameter of normal distribution.
 
result_type stddev () const
 Return standard deviation parameter of normal distribution.
 
bool operator== (const param_type &x) const
 True if two sets of normal distributions parameters are identical. More...
 
bool operator!= (const param_type &x) const
 True if two sets of normal distributions parameters are different. More...
 

Constructor & Destructor Documentation

template<class RealType = real, unsigned int tableBits = c_TabulatedNormalDistributionDefaultBits>
gmx::TabulatedNormalDistribution< RealType, tableBits >::param_type::param_type ( result_type  mean = 0.0,
result_type  stddev = 1.0 
)
inlineexplicit

Constructor. Default is classical distr. with mean 0, stddev 1.

Parameters
meanExpectation value.
stddevStandard deviation.

Member Function Documentation

template<class RealType = real, unsigned int tableBits = c_TabulatedNormalDistributionDefaultBits>
bool gmx::TabulatedNormalDistribution< RealType, tableBits >::param_type::operator!= ( const param_type x) const
inline

True if two sets of normal distributions parameters are different.

Parameters
xInstance to compare with.
template<class RealType = real, unsigned int tableBits = c_TabulatedNormalDistributionDefaultBits>
bool gmx::TabulatedNormalDistribution< RealType, tableBits >::param_type::operator== ( const param_type x) const
inline

True if two sets of normal distributions parameters are identical.

Parameters
xInstance to compare with.

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