Infinity Engine v0.6.20
C++ API Documentation
Loading...
Searching...
No Matches
Infinity::Engine::UniformRealDistribution< RealType >::param_type Struct Reference

Parameter set for the distribution. More...

#include <PRNGDistribution.hpp>

Public Types

using distribution_type = UniformRealDistribution< RealType >
 

Public Member Functions

 param_type ()
 Default constructor. Creates parameters for uniform distribution over [0, 1).
 
 param_type (RealType a, RealType b=RealType(1))
 Constructs parameters with specified bounds.
 
RealType a () const
 Gets the lower bound.
 
RealType b () const
 Gets the upper bound.
 

Friends

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

Detailed Description

template<typename RealType = double>
struct Infinity::Engine::UniformRealDistribution< RealType >::param_type

Parameter set for the distribution.

Stores the lower and upper bounds of the distribution range. Can be used to change distribution parameters without recreating the distribution object.

Member Typedef Documentation

◆ distribution_type

template<typename RealType = double>
using Infinity::Engine::UniformRealDistribution< RealType >::param_type::distribution_type = UniformRealDistribution<RealType>

Constructor & Destructor Documentation

◆ param_type() [1/2]

template<typename RealType = double>
Infinity::Engine::UniformRealDistribution< RealType >::param_type::param_type ( )
inline

Default constructor. Creates parameters for uniform distribution over [0, 1).

◆ param_type() [2/2]

template<typename RealType = double>
Infinity::Engine::UniformRealDistribution< RealType >::param_type::param_type ( RealType  a,
RealType  b = RealType(1) 
)
inlineexplicit

Constructs parameters with specified bounds.

Parameters
aLower bound (inclusive)
bUpper bound (exclusive)

Member Function Documentation

◆ a()

template<typename RealType = double>
RealType Infinity::Engine::UniformRealDistribution< RealType >::param_type::a ( ) const
inline

Gets the lower bound.

◆ b()

template<typename RealType = double>
RealType Infinity::Engine::UniformRealDistribution< RealType >::param_type::b ( ) const
inline

Gets the upper bound.

Friends And Related Symbol Documentation

◆ operator!=

template<typename RealType = double>
bool operator!= ( const param_type lhs,
const param_type rhs 
)
friend

◆ operator==

template<typename RealType = double>
bool operator== ( const param_type lhs,
const param_type rhs 
)
friend