XrDiscreteRV.rvs#
- XrDiscreteRV.rvs(*args, size=1, random_state=None, dims=None, apply_kwargs=None, **kwargs)#
Method wrapping
scipy.stats.rv_discrete.rvs
withxarray.apply_ufunc
Usage examples available at Probability distributions.
- Parameters:
- argsscalar or array_like, optional
Passed to the scipy distribution after broadcasting.
- size
int
of sequence ofints
, optional The number of samples to draw per array element. If the distribution parameters broadcast to a
(4, 10, 6)
shape andsize=(5, 3)
then the output shape is(5, 3, 4, 10, 6)
. This differs from the scipy implementation. Here, all broadcasting and alignment is done for you, you give the dimensions the right names, and broadcasting just happens. Ifsize
followed scipy behaviour, you’d be forced to broadcast to provide a valid value which would defeat thexarray_einstats
goal of handling all alignment and broadcasting for you.- random_stateoptional
Passed as is to the wrapped scipy distribution
- dims
str
or sequence ofstr
, optional Dimension names for the dimensions created due to
size
. If present it must have the same length assize
.- apply_kwargs
dict
, optional Passed to
xarray.apply_ufunc
- kwargs
dict
, optional Passed to the scipy distribution after broadcasting using the same key.