Infinity::Engine::FisherFDistribution< RealType >::param_type Struct Reference

Parameter set for the distribution. More...

#include <PRNGDistribution.hpp>

Public Types
using	distribution_type = FisherFDistribution< RealType >

Public Member Functions
	param_type ()
	Default constructor. Creates parameters for F(1, 1).
	param_type (RealType m, RealType n=RealType(1))
	Constructs parameters.
RealType	m () const
	Gets the numerator degrees of freedom.
RealType	n () const
	Gets the denominator degrees of freedom.

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::FisherFDistribution< RealType >::param_type

Parameter set for the distribution.

Stores the degrees of freedom for numerator (m) and denominator (n).

Member Typedef Documentation

distribution_type

template<typename RealType = double>

using Infinity::Engine::FisherFDistribution< RealType >::param_type::distribution_type = FisherFDistribution<RealType>

Constructor & Destructor Documentation

param_type() [1/2]

template<typename RealType = double>

Infinity::Engine::FisherFDistribution< RealType >::param_type::param_type ( )

inline

Default constructor. Creates parameters for F(1, 1).

param_type() [2/2]

template<typename RealType = double>

Infinity::Engine::FisherFDistribution< RealType >::param_type::param_type ( RealType  m, RealType  n = RealType(1)  )

inlineexplicit

Constructs parameters.

Parameters

m	Degrees of freedom for numerator (must be > 0)
n	Degrees of freedom for denominator (must be > 0)

Member Function Documentation

m()

template<typename RealType = double>

RealType Infinity::Engine::FisherFDistribution< RealType >::param_type::m ( ) const

inline

Gets the numerator degrees of freedom.

n()

template<typename RealType = double>

RealType Infinity::Engine::FisherFDistribution< RealType >::param_type::n ( ) const

inline

Gets the denominator degrees of freedom.

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