std::chi_squared_distribution< _RealType > Class Template Reference [Normal]

A chi_squared_distribution random number distribution. More...

List of all members.

Classes

• struct param_type

Public Types

• typedef _RealType result_type

Public Member Functions

• chi_squared_distribution (_RealType __n=_RealType(1))
• chi_squared_distribution (const param_type &__p)
• result_type max () const
• result_type min () const
• _RealType n () const
• template<typename _UniformRandomNumberGenerator > result_type operator() (_UniformRandomNumberGenerator &__urng)
• template<typename _UniformRandomNumberGenerator > result_type operator() (_UniformRandomNumberGenerator &__urng, const param_type &__p)
• void param (const param_type &__param)
• param_type param () const
• void reset ()

Friends

• template<typename _RealType1 , typename _CharT , typename _Traits > std::basic_ostream< _CharT,
  _Traits > & operator<< (std::basic_ostream< _CharT, _Traits > &, const std::chi_squared_distribution< _RealType1 > &)
• template<typename _RealType1 > bool operator== (const std::chi_squared_distribution< _RealType1 > &__d1, const std::chi_squared_distribution< _RealType1 > &__d2)
• template<typename _RealType1 , typename _CharT , typename _Traits > std::basic_istream< _CharT,
  _Traits > & operator>> (std::basic_istream< _CharT, _Traits > &, std::chi_squared_distribution< _RealType1 > &)

---

Detailed Description

template<typename _RealType = double>
class std::chi_squared_distribution< _RealType >

A chi_squared_distribution random number distribution.

The formula for the normal probability mass function is

Definition at line 2539 of file random.h.

---

Member Typedef Documentation

template<typename _RealType = double>

typedef _RealType std::chi_squared_distribution< _RealType >::result_type

The type of the range of the distribution.

Definition at line 2546 of file random.h.

---

Member Function Documentation

template<typename _RealType = double>

result_type std::chi_squared_distribution< _RealType >::max

(

)

const [inline]

Returns the least upper bound value of the distribution.

Definition at line 2619 of file random.h.

template<typename _RealType = double>

result_type std::chi_squared_distribution< _RealType >::min

(

)

const [inline]

Returns the greatest lower bound value of the distribution.

Definition at line 2612 of file random.h.

template<typename _RealType = double>

template<typename _UniformRandomNumberGenerator >

result_type std::chi_squared_distribution< _RealType >::operator()

(

_UniformRandomNumberGenerator &

__urng

)

[inline]

Generating functions.

Definition at line 2627 of file random.h.

template<typename _RealType = double>

param_type std::chi_squared_distribution< _RealType >::param

(

)

const [inline]

Returns the parameter set of the distribution.

Definition at line 2597 of file random.h.

template<typename _RealType = double>

void std::chi_squared_distribution< _RealType >::param

(

const param_type &

__param

)

[inline]

Sets the parameter set of the distribution.

Parameters:

__param

The new parameter set of the distribution.

Definition at line 2605 of file random.h.

template<typename _RealType = double>

void std::chi_squared_distribution< _RealType >::reset

(

)

[inline]

Resets the distribution state.

Definition at line 2583 of file random.h.

References std::gamma_distribution< _RealType >::reset().

---

Friends And Related Function Documentation

template<typename _RealType = double>

template<typename _RealType1 , typename _CharT , typename _Traits >

std::basic_ostream<_CharT, _Traits>& operator<<	(	std::basic_ostream< _CharT, _Traits > &	,
		const std::chi_squared_distribution< _RealType1 > &
	)			[friend]

Inserts a chi_squared_distribution random number distribution __x into the output stream __os.

Parameters:

	__os	An output stream.
	__x	A chi_squared_distribution random number distribution.

Returns:

The output stream with the state of __x inserted or in an error state.

template<typename _RealType = double>

template<typename _RealType1 >

bool operator==	(	const std::chi_squared_distribution< _RealType1 > &	__d1,
		const std::chi_squared_distribution< _RealType1 > &	__d2
	)			[friend]

Return true if two Chi-squared distributions have the same parameters and the sequences that would be generated are equal.

Definition at line 2647 of file random.h.

template<typename _RealType = double>

template<typename _RealType1 , typename _CharT , typename _Traits >

std::basic_istream<_CharT, _Traits>& operator>>	(	std::basic_istream< _CharT, _Traits > &	,
		std::chi_squared_distribution< _RealType1 > &
	)			[friend]

Extracts a chi_squared_distribution random number distribution __x from the input stream __is.

Parameters:

	__is	An input stream.
	__x	A chi_squared_distribution random number generator engine.

Returns:

The input stream with __x extracted or in an error state.

---

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

• random.h