jax.random.geometric

Contents

jax.random.geometric#

jax.random.geometric(key, p, shape=None, dtype=<class 'int'>)[source]#

Sample Geometric random values with given shape and float dtype.

The values are returned according to the probability mass function:

\[f(k;p) = p(1-p)^{k-1}\]

on the domain \(0 < p < 1\).

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

  • p (RealArray) – a float or array of floats broadcast-compatible with shape representing the probability of success of an individual trial.

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

  • dtype (DTypeLikeInt) – optional, a int dtype for the returned values (default int64 if jax_enable_x64 is true, otherwise int32).

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 p.shape.