jax.random.triangular#
- jax.random.triangular(key, left, mode, right, shape=None, dtype=<class 'float'>)[source]#
Sample Triangular random values with given shape and float dtype.
The values are returned according to the probability density function:
\[\begin{split}f(x; a, b, c) = \frac{2}{c-a} \left\{ \begin{array}{ll} \frac{x-a}{b-a} & a \leq x \leq b \\ \frac{c-x}{c-b} & b \leq x \leq c \end{array} \right.\end{split}\]on the domain \(a \leq x \leq c\).
- Parameters:
key (
Union
[Array
,ndarray
,bool_
,number
,bool
,int
,float
,complex
]) – a PRNG key used as the random key.left (
Union
[Array
,ndarray
,bool_
,number
,bool
,int
,float
,complex
]) – a float or array of floats broadcast-compatible withshape
representing the lower limit parameter of the distribution.mode (
Union
[Array
,ndarray
,bool_
,number
,bool
,int
,float
,complex
]) – a float or array of floats broadcast-compatible withshape
representing the peak value parameter of the distribution, value must fulfill the conditionleft <= mode <= right
.right (
Union
[Array
,ndarray
,bool_
,number
,bool
,int
,float
,complex
]) – a float or array of floats broadcast-compatible withshape
representing the upper limit parameter of the distribution, must be larger thanleft
.shape (
Optional
[Sequence
[int
]]) – optional, a tuple of nonnegative integers specifying the result shape. Must be broadcast-compatible withleft
,``mode`` andright
. The default (None) produces a result shape equal toleft.shape
,mode.shape
andright.shape
.dtype (
Union
[str
,type
[Any
],dtype
,SupportsDType
]) – optional, a float dtype for the returned values (default float64 if jax_enable_x64 is true, otherwise float32).
- Return type:
- Returns:
A random array with the specified dtype and with shape given by
shape
ifshape
is not None, or else byleft.shape
,mode.shape
andright.shape
.