rand::distributions::gamma::ChiSquared - Rust
Description: API documentation for the Rust `ChiSquared` struct in crate `rand`.
Keywords: rust, rustlang, rust-lang, ChiSquared

# Struct rand::distributions::gamma::ChiSquared [−] [src]

    pub struct ChiSquared { /* fields omitted */ }

The chi-squared distribution `χ²(k)`, where `k` is the degrees of freedom.

For `k > 0` integral, this distribution is the sum of the squares of `k` independent standard normal random variables. For other `k`, this uses the equivalent characterisation `χ²(k) = Gamma(k/2, 2)`.

# Example

    use rand::distributions::{ChiSquared, IndependentSample};

    let chi = ChiSquared::new(11.0);
    let v = chi.ind_sample(&mut rand::thread_rng());
    println!("{} is from a χ²(11) distribution", v)

## Methods

### `impl ChiSquared`
[src]

#### `fn new(k: f64) -> ChiSquared`
[src]

Create a new chi-squared distribution with degrees-of-freedom `k`. Panics if `k < 0`.

## Trait Implementations

### `impl Clone for ChiSquared`
[src]

#### `fn clone(&self) -> ChiSquared`
[src]

Returns a copy of the value. Read more

#### `fn clone_from(&mut self, source: &Self)`
1.0.0
[src]

Performs copy-assignment from `source`. Read more

### `impl Copy for ChiSquared`
[src]

### `impl Debug for ChiSquared`
[src]

#### `fn fmt(&self, __arg_0: &mut Formatter) -> Result`
[src]

Formats the value using the given formatter.

### `impl Sample<f64> for ChiSquared`
[src]

#### `fn sample<R: Rng>(&mut self, rng: &mut R) -> f64`
[src]

Generate a random value of `Support`, using `rng` as the source of randomness. Read more

### `impl IndependentSample<f64> for ChiSquared`
[src]

#### `fn ind_sample<R: Rng>(&self, rng: &mut R) -> f64`
[src]

Generate a random value.

# Help

## Keyboard Shortcuts

?
  Show this help dialog
S
  Focus the search field
⇤
  Move up in search results
⇥
  Move down in search results
⏎
  Go to active search result
+
  Collapse/expand all sections

## Search Tricks

Prefix searches with a type followed by a colon (e.g. `fn:`) to restrict the search to a given type.

Accepted types are: `fn`, `mod`, `struct`, `enum`, `trait`, `type`, `macro`, and `const`.

Search functions by type signature (e.g. `vec -> usize` or `* -> vec`)