---
name: "std::fisher_f_distribution"
section: "3"
platform: "linux"
package: "gcc"
version: "16.2.1+r23+gd564253eb6c8-1"
release: "Arch Linux 2026-11-01"
platforms: ["linux"]
url: "https://new.carta.tech/std::fisher_f_distribution"
---

# std::fisher\_f\_distribution(3)

A fisher\_f\_distribution random number distribution.

## NAME

std::fisher\_f\_distribution\< \_RealType \> - A fisher\_f\_distribution random number distribution.

## SYNOPSIS

\#include \<random\>

### Classes

struct **param\_type**\

### Public Types

typedef \_RealType **result\_type**\

### Public Member Functions

**fisher\_f\_distribution** (\_RealType \_\_m, \_RealType \_\_n=\_RealType(1))\
 **fisher\_f\_distribution** (const **param\_type** &\_\_p)\
 template\<typename \_ForwardIterator, typename \_UniformRandomNumberGenerator\> void **\_\_generate** (\_ForwardIterator \_\_f, \_ForwardIterator \_\_t, \_UniformRandomNumberGenerator &\_\_urng)\
 template\<typename \_ForwardIterator, typename \_UniformRandomNumberGenerator\> void **\_\_generate** (\_ForwardIterator \_\_f, \_ForwardIterator \_\_t, \_UniformRandomNumberGenerator &\_\_urng, const **param\_type** &\_\_p)\
 template\<typename \_UniformRandomNumberGenerator\> void **\_\_generate** (**result\_type** \*\_\_f, **result\_type** \*\_\_t, \_UniformRandomNumberGenerator &\_\_urng)\
 template\<typename \_UniformRandomNumberGenerator\> void **\_\_generate** (**result\_type** \*\_\_f, **result\_type** \*\_\_t, \_UniformRandomNumberGenerator &\_\_urng, const **param\_type** &\_\_p)\
 \_RealType **m** () const\
 **result\_type** **max** () const\
 Returns the least upper bound value of the distribution.  **result\_type** **min** () const\
 Returns the greatest lower bound value of the distribution.  \_RealType **n** () const\
 template\<typename \_UniformRandomNumberGenerator\> **result\_type** **operator()** (\_UniformRandomNumberGenerator &\_\_urng)\
 Generating functions.  template\<typename \_UniformRandomNumberGenerator\> **result\_type** **operator()** (\_UniformRandomNumberGenerator &\_\_urng, const **param\_type** &\_\_p)\
 **param\_type** **param** () const\
 Returns the parameter set of the distribution.  void **param** (const **param\_type** &\_\_param)\
 Sets the parameter set of the distribution.  void **reset** ()\
 Resets the distribution state.

### Friends

template\<typename \_RealType1, typename \_CharT, typename \_Traits\> **std::basic\_ostream**\< \_CharT, \_Traits \> & **operator\<\<** (**std::basic\_ostream**\< \_CharT, \_Traits \> &\_\_os, const **std::fisher\_f\_distribution**\< \_RealType1 \> &\_\_x)\
 Inserts a fisher\_f\_distribution random number distribution \_\_x into the output stream \_\_os.  bool **operator==** (const fisher\_f\_distribution &\_\_d1, const fisher\_f\_distribution &\_\_d2)\
 Return true if two Fisher f distributions have the same parameters and the sequences that would be generated are equal.  template\<typename \_RealType1, typename \_CharT, typename \_Traits\> **std::basic\_istream**\< \_CharT, \_Traits \> & **operator\>\>** (**std::basic\_istream**\< \_CharT, \_Traits \> &\_\_is, **std::fisher\_f\_distribution**\< \_RealType1 \> &\_\_x)\
 Extracts a fisher\_f\_distribution random number distribution \_\_x from the input stream \_\_is.

## Detailed Description

### template\<typename \_RealType = double\>

class std::fisher\_f\_distribution\< \_RealType \>"A fisher\_f\_distribution random number distribution.

The formula for the normal probability mass function is     \
                (ac{m}{n})^{m/2} x^{(m/2)-1}\
                (1 + ac{mx}{n})^{-(m+n)/2} \]

**Since**

C++11

## Member Typedef Documentation

### template\<typename \_RealType = double\> typedef \_RealType std::fisher\_f\_distribution\< \_RealType \>::result\_type

The type of the range of the distribution.

## Member Function Documentation

### template\<typename \_RealType = double\> result\_type std::fisher\_f\_distribution\< \_RealType \>::max () const \[inline\]

Returns the least upper bound value of the distribution.

### template\<typename \_RealType = double\> result\_type std::fisher\_f\_distribution\< \_RealType \>::min () const \[inline\]

Returns the greatest lower bound value of the distribution.

### template\<typename \_RealType = double\> template\<typename \_UniformRandomNumberGenerator\> result\_type std::fisher\_f\_distribution\< \_RealType \>::operator() (\_UniformRandomNumberGenerator & \_\_urng) \[inline\]

Generating functions.

### template\<typename \_RealType = double\> param\_type std::fisher\_f\_distribution\< \_RealType \>::param () const \[inline\]

Returns the parameter set of the distribution.

### template\<typename \_RealType = double\> void std::fisher\_f\_distribution\< \_RealType \>::param (const param\_type & \_\_param) \[inline\]

Sets the parameter set of the distribution.

**Parameters**

*\_\_param* The new parameter set of the distribution.

### template\<typename \_RealType = double\> void std::fisher\_f\_distribution\< \_RealType \>::reset () \[inline\]

Resets the distribution state.

## Friends And Related Symbol Documentation

### template\<typename \_RealType = double\> template\<typename \_RealType1, typename \_CharT, typename \_Traits\> std::basic\_ostream\< \_CharT, \_Traits \> & operator\<\< (std::basic\_ostream\< \_CharT, \_Traits \> & \_\_os, const std::fisher\_f\_distribution\< \_RealType1 \> & \_\_x) \[friend\]

Inserts a fisher\_f\_distribution random number distribution \_\_x into the output stream \_\_os.

**Parameters**

*\_\_os* An output stream. \
 *\_\_x* A fisher\_f\_distribution random number distribution.

**Returns**

The output stream with the state of \_\_x inserted or in an error state.

### template\<typename \_RealType = double\> bool operator== (const fisher\_f\_distribution\< \_RealType \> & \_\_d1, const fisher\_f\_distribution\< \_RealType \> & \_\_d2) \[friend\]

Return true if two Fisher f distributions have the same parameters and the sequences that would be generated are equal.

### template\<typename \_RealType = double\> template\<typename \_RealType1, typename \_CharT, typename \_Traits\> std::basic\_istream\< \_CharT, \_Traits \> & operator\>\> (std::basic\_istream\< \_CharT, \_Traits \> & \_\_is, std::fisher\_f\_distribution\< \_RealType1 \> & \_\_x) \[friend\]

Extracts a fisher\_f\_distribution random number distribution \_\_x from the input stream \_\_is.

**Parameters**

*\_\_is* An input stream. \
 *\_\_x* A fisher\_f\_distribution random number generator engine.

**Returns**

The input stream with \_\_x extracted or in an error state.

## Author

Generated automatically by Doxygen for libstdc++ from the source code.