jax.random.chisquare

Contents

jax.random.chisquare#

jax.random.chisquare(key, df, shape=None, dtype=<class 'float'>)[source]#

Sample Chisquare random values with given shape and float dtype.

The values are distributed according to the probability density function:

\[f(x; \nu) \propto x^{k/2 - 1}e^{-x/2}\]

on the domain \(0 < x < \infty\), where \(\nu > 0\) represents the degrees of freedom, given by the parameter df.

Parameters:
  • key (KeyArrayLike) – a PRNG key used as the random key.

  • df (RealArray) – a float or array of floats broadcast-compatible with shape representing the parameter of the distribution.

  • shape (Shape | None) – optional, a tuple of nonnegative integers specifying the result shape. Must be broadcast-compatible with df. The default (None) produces a result shape equal to df.shape.

  • dtype (DTypeLikeFloat) – optional, a float dtype for the returned values (default float64 if jax_enable_x64 is true, otherwise float32).

Return type:

Array

Returns:

A random array with the specified dtype and with shape given by shape if shape is not None, or else by df.shape.