From 72f9ac7b5e4fffc29bf5c0234e5b1ed885f75ebe Mon Sep 17 00:00:00 2001 From: stress-tess <48131946+stress-tess@users.noreply.github.com> Date: Tue, 21 May 2024 21:38:07 +0000 Subject: [PATCH] =?UTF-8?q?Deploying=20to=20gh-pages=20from=20@=20Bears-R-?= =?UTF-8?q?Us/arkouda@af41bb8715c88b2ccd6d934d63e2996a72933ba6=20?= =?UTF-8?q?=F0=9F=9A=80?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- _modules/arkouda/random/_generator.html | 76 +++++++++- _sources/autoapi/arkouda/index.rst.txt | 40 +++++- _sources/autoapi/arkouda/random/index.rst.txt | 40 +++++- _sources/usage/random.rst.txt | 16 +++ autoapi/arkouda/index.html | 52 ++++++- autoapi/arkouda/random/index.html | 52 ++++++- genindex.html | 14 ++ objects.inv | Bin 21588 -> 21590 bytes searchindex.js | 2 +- usage.html | 16 +++ usage/random.html | 135 +++++++++++++++++- 11 files changed, 426 insertions(+), 17 deletions(-) diff --git a/_modules/arkouda/random/_generator.html b/_modules/arkouda/random/_generator.html index 23749eeddd..6c98402e84 100644 --- a/_modules/arkouda/random/_generator.html +++ b/_modules/arkouda/random/_generator.html @@ -566,6 +566,58 @@
return create_pdarray(rep_msg)
[docs]
def standard_normal(self, size=None):
- """
+ r"""
Draw samples from a standard Normal distribution (mean=0, stdev=1).
Parameters
@@ -638,10 +690,14 @@ Source code for arkouda.random._generator
Notes
-----
- For random samples from :math:`N(\\mu, \\sigma^2)`, use:
+ For random samples from :math:`N(\mu, \sigma^2)`, either call `normal` or do:
- ``(sigma * standard_normal(size)) + mu``
+ .. math::
+ (\sigma \cdot \texttt{standard_normal}(size)) + \mu
+ See Also
+ --------
+ normal
Examples
--------
@@ -651,12 +707,20 @@ Source code for arkouda.random._generator
>>> rng.standard_normal(3)
array([0.8797352989638163, -0.7085325853376141, 0.021728052940979934]) # random
"""
- from arkouda.random._legacy import standard_normal
-
if size is None:
# delegate to numpy when return size is 1
return self._np_generator.standard_normal()
- return standard_normal(size=size, seed=self._seed)
+ rep_msg = generic_msg(
+ cmd="standardNormalGenerator",
+ args={
+ "name": self._name_dict[akfloat64],
+ "size": size,
+ "state": self._state,
+ },
+ )
+ # since we generate 2*size uniform samples for box-muller transform
+ self._state += (size * 2)
+ return create_pdarray(rep_msg)
diff --git a/_sources/autoapi/arkouda/index.rst.txt b/_sources/autoapi/arkouda/index.rst.txt
index 3d4b90817e..eca4ec14ec 100644
--- a/_sources/autoapi/arkouda/index.rst.txt
+++ b/_sources/autoapi/arkouda/index.rst.txt
@@ -10068,6 +10068,39 @@ Package Contents
+ .. py:method:: normal(loc=0.0, scale=1.0, size=None)
+
+ Draw samples from a normal (Gaussian) distribution
+
+ :param loc: Mean of the distribution. Default of 0.
+ :type loc: float or pdarray of floats, optional
+ :param scale: Standard deviation of the distribution. Must be non-negative. Default of 1.
+ :type scale: float or pdarray of floats, optional
+ :param size: Output shape. Default is None, in which case a single value is returned.
+ :type size: numeric_scalars, optional
+
+ .. rubric:: Notes
+
+ The probability density for the Gaussian distribution is:
+
+ .. math::
+ p(x) = \frac{1}{\sqrt{2\pi \sigma^2}} e^{-\frac{(x-\mu)^2}{2\sigma^2}}
+
+ where :math:`\mu` is the mean and :math:`\sigma` the standard deviation.
+ The square of the standard deviation, :math:`\sigma^2`, is called the variance.
+
+ :returns: Pdarray of floats (unless size=None, in which case a single float is returned).
+ :rtype: pdarray
+
+ .. seealso:: :obj:`standard_normal`, :obj:`uniform`
+
+ .. rubric:: Examples
+
+ >>> ak.random.default_rng(17).normal(3, 2.5, 10)
+ array([2.3673425816523577 4.0532529435624589 2.0598322696795694])
+
+
+
.. py:method:: permutation(x)
Randomly permute a sequence, or return a permuted range.
@@ -10134,9 +10167,12 @@ Package Contents
.. rubric:: Notes
- For random samples from :math:`N(\mu, \sigma^2)`, use:
+ For random samples from :math:`N(\mu, \sigma^2)`, either call `normal` or do:
+
+ .. math::
+ (\sigma \cdot \texttt{standard_normal}(size)) + \mu
- ``(sigma * standard_normal(size)) + mu``
+ .. seealso:: :obj:`normal`
.. rubric:: Examples
diff --git a/_sources/autoapi/arkouda/random/index.rst.txt b/_sources/autoapi/arkouda/random/index.rst.txt
index 8b9189205d..fb07447f11 100644
--- a/_sources/autoapi/arkouda/random/index.rst.txt
+++ b/_sources/autoapi/arkouda/random/index.rst.txt
@@ -107,6 +107,39 @@ Package Contents
+ .. py:method:: normal(loc=0.0, scale=1.0, size=None)
+
+ Draw samples from a normal (Gaussian) distribution
+
+ :param loc: Mean of the distribution. Default of 0.
+ :type loc: float or pdarray of floats, optional
+ :param scale: Standard deviation of the distribution. Must be non-negative. Default of 1.
+ :type scale: float or pdarray of floats, optional
+ :param size: Output shape. Default is None, in which case a single value is returned.
+ :type size: numeric_scalars, optional
+
+ .. rubric:: Notes
+
+ The probability density for the Gaussian distribution is:
+
+ .. math::
+ p(x) = \frac{1}{\sqrt{2\pi \sigma^2}} e^{-\frac{(x-\mu)^2}{2\sigma^2}}
+
+ where :math:`\mu` is the mean and :math:`\sigma` the standard deviation.
+ The square of the standard deviation, :math:`\sigma^2`, is called the variance.
+
+ :returns: Pdarray of floats (unless size=None, in which case a single float is returned).
+ :rtype: pdarray
+
+ .. seealso:: :obj:`standard_normal`, :obj:`uniform`
+
+ .. rubric:: Examples
+
+ >>> ak.random.default_rng(17).normal(3, 2.5, 10)
+ array([2.3673425816523577 4.0532529435624589 2.0598322696795694])
+
+
+
.. py:method:: permutation(x)
Randomly permute a sequence, or return a permuted range.
@@ -173,9 +206,12 @@ Package Contents
.. rubric:: Notes
- For random samples from :math:`N(\mu, \sigma^2)`, use:
+ For random samples from :math:`N(\mu, \sigma^2)`, either call `normal` or do:
+
+ .. math::
+ (\sigma \cdot \texttt{standard_normal}(size)) + \mu
- ``(sigma * standard_normal(size)) + mu``
+ .. seealso:: :obj:`normal`
.. rubric:: Examples
diff --git a/_sources/usage/random.rst.txt b/_sources/usage/random.rst.txt
index 776cf80060..62feb4fcc0 100644
--- a/_sources/usage/random.rst.txt
+++ b/_sources/usage/random.rst.txt
@@ -17,10 +17,26 @@ To create a ``Generator`` use the ``default_rng`` constructor
Features
==========
+choice
+---------
+.. autofunction:: arkouda.random.Generator.choice
+
integers
---------
.. autofunction:: arkouda.random.Generator.integers
+normal
+---------
+.. autofunction:: arkouda.random.Generator.normal
+
+permutation
+---------
+.. autofunction:: arkouda.random.Generator.permutation
+
+shuffle
+---------
+.. autofunction:: arkouda.random.Generator.shuffle
+
random
---------
.. autofunction:: arkouda.random.Generator.random
diff --git a/autoapi/arkouda/index.html b/autoapi/arkouda/index.html
index d8bf7eab70..929bff7f99 100644
--- a/autoapi/arkouda/index.html
+++ b/autoapi/arkouda/index.html
@@ -16206,6 +16206,46 @@ Package Contents
+
+normal(loc=0.0, scale=1.0, size=None)[source]¶
+Draw samples from a normal (Gaussian) distribution
+
+- Parameters:
+
+loc (float or pdarray of floats, optional) – Mean of the distribution. Default of 0.
+scale (float or pdarray of floats, optional) – Standard deviation of the distribution. Must be non-negative. Default of 1.
+size (numeric_scalars, optional) – Output shape. Default is None, in which case a single value is returned.
+
+
+
+Notes
+The probability density for the Gaussian distribution is:
+
+
+\[p(x) = \frac{1}{\sqrt{2\pi \sigma^2}} e^{-\frac{(x-\mu)^2}{2\sigma^2}}\]
+
+where \(\mu\) is the mean and \(\sigma\) the standard deviation.
+The square of the standard deviation, \(\sigma^2\), is called the variance.
+
+- Returns:
+Pdarray of floats (unless size=None, in which case a single float is returned).
+
+- Return type:
+-
+
+
+
+See also
+
+
+Examples
+>>> ak.random.default_rng(17).normal(3, 2.5, 10)
+array([2.3673425816523577 4.0532529435624589 2.0598322696795694])
+
+
+
+
-
permutation(x)[source]¶
@@ -16289,8 +16329,15 @@ Package ContentsNotes
-For random samples from \(N(\mu, \sigma^2)\), use:
-(sigma * standard_normal(size)) + mu
+For random samples from \(N(\mu, \sigma^2)\), either call normal or do:
+
+
+\[(\sigma \cdot \texttt{standard_normal}(size)) + \mu\]
+
+
+See also
+
+
Examples
>>> rng = ak.random.default_rng()
>>> rng.standard_normal()
@@ -54072,6 +54119,7 @@ Package ContentsGenerator
Generator.choice()
Generator.integers()
+Generator.normal()
Generator.permutation()
Generator.random()
Generator.shuffle()
diff --git a/autoapi/arkouda/random/index.html b/autoapi/arkouda/random/index.html
index bb3d71895c..1ed3e09275 100644
--- a/autoapi/arkouda/random/index.html
+++ b/autoapi/arkouda/random/index.html
@@ -478,6 +478,46 @@ Package Contents
+-
+normal(loc=0.0, scale=1.0, size=None)[source]¶
+Draw samples from a normal (Gaussian) distribution
+
+- Parameters:
+
+loc (float or pdarray of floats, optional) – Mean of the distribution. Default of 0.
+scale (float or pdarray of floats, optional) – Standard deviation of the distribution. Must be non-negative. Default of 1.
+size (numeric_scalars, optional) – Output shape. Default is None, in which case a single value is returned.
+
+
+
+Notes
+The probability density for the Gaussian distribution is:
+
+
+\[p(x) = \frac{1}{\sqrt{2\pi \sigma^2}} e^{-\frac{(x-\mu)^2}{2\sigma^2}}\]
+
+where \(\mu\) is the mean and \(\sigma\) the standard deviation.
+The square of the standard deviation, \(\sigma^2\), is called the variance.
+
+- Returns:
+Pdarray of floats (unless size=None, in which case a single float is returned).
+
+- Return type:
+-
+
+
+
+See also
+
+
+Examples
+>>> ak.random.default_rng(17).normal(3, 2.5, 10)
+array([2.3673425816523577 4.0532529435624589 2.0598322696795694])
+
+
+
+
-
permutation(x)[source]¶
@@ -561,8 +601,15 @@ Package ContentsNotes
-For random samples from \(N(\mu, \sigma^2)\), use:
-(sigma * standard_normal(size)) + mu
+For random samples from \(N(\mu, \sigma^2)\), either call normal or do:
+
+
+\[(\sigma \cdot \texttt{standard_normal}(size)) + \mu\]
+
+
+See also
+
+
Examples
>>> rng = ak.random.default_rng()
>>> rng.standard_normal()
@@ -816,6 +863,7 @@ Package ContentsGenerator
Generator.choice()
Generator.integers()
+Generator.normal()
Generator.permutation()
Generator.random()
Generator.shuffle()
diff --git a/genindex.html b/genindex.html
index 7fae029dbf..e60215e1fb 100644
--- a/genindex.html
+++ b/genindex.html
@@ -1721,6 +1721,8 @@ C
- clear() (in module arkouda)
@@ -5358,6 +5360,14 @@
N
- NonUniqueError, [1]
+ - normal() (arkouda.Generator method)
+
+
- normalize() (arkouda.client_dtypes.IPv4 method)
@@ -5760,6 +5770,8 @@ P
- pi (in module arkouda.numpy)
@@ -6766,6 +6778,8 @@
S
- shutdown() (in module arkouda.client)
diff --git a/objects.inv b/objects.inv
index 3d55c5e3d0852420e46085ba3052023f77cd4e9c..43e9f69edfdc60e4337fc5a17b7ee427a1a17ed4 100644
GIT binary patch
delta 19614
zcmV)vK$XALr~%ff0kB&Le
IB^DRgpA4>5)?zoelv1}MuA3zgaWOxgh!1+w4_X7l@dXiGc;`+C
zEw*zDgcjSs_aRE|9R8st_kA&dCC#dQXyH0Z#qu&lv=0b25)&$_+%
zuDOGuToNCdN>-#^f7+FS0E-#SV1Xs+BeE?SI828bO#r%d&^>E3ABEBg2BW8MO?$?!
zxX03ftFKR|gbR%>wh%8`-xJityK2Lr%Q2eb?J1pT71R)@a*(F5ODMGlz!OESLD7Q<
z_Qk33*ZT4fq1PIOTjap2-jH>AU%EQ*^g)m5g9Q)x+8!(?e}2}8fHeE%m!XbNw{ZZt
z$0BS&NFP8GfE4`60HT=m>|;_XAL|_dN!MXcuax3Yw@(>GVxo4U;{w$D*=aRw{)}xeZ2TWTn`4$r^^rD|8Rv|-rlyt
zK^Mr?_2(N`#=kFauZfI5>$FPtjwtBDloQLSH2&B!D(tZ1PbkjY{+Q;v_m5ck1Hh=T
z>qb68Iql{nj@y<#0=X=PBMfPK9+h|4BBvDMnmmP2e>cl1#bL*sg6P}kh~u{JjX_SE
z-?hxXH`1NP)BS^M@TPdXw*7KvL?s`e2UUo&Wt4=%5S$u+|)wP>`g
zl8B0Jmy0e^Bl10Ohjo;k52HmCjeHmT?UML(;<9`zp9wEn?x}9E<#$x5*y2AN%bRtvXbR0xcUzujqq{9X1oqq8qe}I5%`>*rL78N$
zRFENL3*iZZW-q!$pyK!$5!>^o10r|(o^7NuH-r|Nt@ZX6khkk8EZ0$R-7#*0yn(e+
zC$qm>zbwjd)x}eht*VD0b75qwB3zd)guD>Tf8<3tG0J-B#?Y!3HT`Ml_W^^6)Ncd~
z28z@dalTs(Buor5Bfxbvq#E*X0gh`aHgdliBC`M)z|qX1Td5BWx69>#Q4^M7zodE*
z41gxS8u7L=g3#|yBgk4li9mNtSdrHtsvLa_aN7}7@jg%rv3TcjKq^ghJ4
z``q)3FplZ9IbBi)0Cih!0Tp#4?26OxHx0n$cGCc;!KC`)PIc4e?;Sy1tWtQCR1<*X
z3e%48uWMFnPD+@Cx!d$Fp%X~~6e+M)!yt4`5e&X*qPV*WQIN4mhrpk~SfNM9Z
z@|_Uu;0TynZgypf)+9q|mj#)AOX`Zdsla-S)7a_rnvp*qD)jSAdAH$*w6!)6^7w$F
z*RlxF?@~>1w^LSwaInSc36p5W*dDOOC$<%@T>7u9iXe<47XtPA)0Cc#t895|f32MD
z%oryxoi+p6@hz#4B
z_eRQWYGrGGh^#7b(aX-xO<#AZo(YpNFpr`IWIyK`kdApBHLF3)2h}GV}cCdLc&P}XrUaW7>W&1Tnqf6Lx|Yy=^@*fbqdZI$>)*(k_6%vNQNI5?Q*pefb81!J0n
zlvupy$EHb`3qd-BIHZn0KQRrBye?Kczqiv_{QSf;C-Fg6&reK~vY>VrE~D4^iD?d&
zA}nZw*O(OEGU!Z0#grJ{f-z0sGEb9=^d5)OwF62M7Y+RY=9u%wf3!)J^*yQX`kr*o
z$8H{POv4?UnC$$`shNU`Byj%bt(k(6#c9l$8FSE%!P>8cTx92OOe;7(6WRG2)1;(?
zkUl>>I!Fq-e!%A-J3loo?UaBL=cgw|67DoJNf-HT90VLB1Uo-HHI-k4_n19t5`AV1
znFgZ*Us)zeBe%3Tf7~EB=SB|o;xb7dxy6kVNg$i|-pJeLTEO8ZsU){J!rYl8lH8I=
zjXE)-91<>^zkOq7R+x|Z);#P{X&cVpzMX-P^ERBnJ+mO`i5t$}oj%ym&t^y=+qwe3H`a>(ie37-a
zjmT`Sk5u@+e=d@R4AL=@$VPo33%QFa8;jBt8>n9+RbbcNkg!&L4vCs%$FUD8TyI3J
zKze94_=-lvTWk(VRFKmdjSLW})4g0}{%T7gELi4zR_rpI=?f9FntXgg?Rfc}F9o*MZw_eYmR
zLN(rRznir)ENp-dfy%XN6{ui{$u5-*(Lqqz<t3n&g)aqGPdeA-u_l;S6wl>8Lt_%&)1W?%i<;}{bmRlds(Xb6f(7H?
zo{&f+XY)#KtuVrG63=8*q0)US2~~hREb&}ce;p^n6BEy5)tMr^Gzm;j9W2V56HPtf
z+sVSV#T3Rv4gR3+P?)DEjmxdqKI}#6jD`7^lCThOQxX{BdrAU>JW)wxkY6gE%xC8S
z_E|*}y;vfE{aNuue)$&0*OdgddA<^$5IKC%T$Kd*(tpGca!4k2#6?rJ~8@!tdXV1
zE}dbTtTJMU>!RAq`LN?+|CG&hv40NiXJ`UjiBO#q4NmYiq*jFTHl$So@;4-+e*x+;
z8X4hpNUQ+lbx36c{SL`^fL4yihUw90Y?$VY#)kSII?$n-8d?^Dbk4(19^2lhAM2}1d$@R!|knbXq4w4l9jWPCSepeG*ekA9aUE*%b!oLG6Gb4eW%j-Kl9xr%y48x8NaS<2FmN!$
zxfV_1H-*4B*b=C$S0V=|TS_G`H(LUkS*4G0wIxuQjRY|6wiGI_f7t=fw4GnX{rLkd-xCAz*xeweK7ti!$
zjsthdB`|%6zfexOG_2Jvmx2X3=90j6*IWt~;G9dr0=zycSb&2r1q<-bp*+UU6%mnwaCM|?BdCGA5sF-m&Ka1<1W4`Zn+S`c^41mw1UGp
z@DixZMrkM~UINzc#!G;*8-^iVc_~nOgFv|X!l4jnR20tUUW$U%f1EUc^C||X#{Noh@&^A&
z9^k#YIky&2?tM2g1>2uSAd+Pht(y;;ie(iruNB-cE;GUSeMWKH8T7>+jbC5fgKzT7pMJ=U3abIh
zXP7)7Sq+n?f7C}GSU#J>DV4vmtd|kPLrx4_UgcJg?&aDGF*w@^;z~ojmso5mI=xzOv5&0u|06^q;M+#LxiF1E#@LNqQLrb1C9
zsqv7TvJd3KWs
- Features
+- choice
+choice()
+
+
- integers
+- normal
+normal()
+
+
+- permutation
+
+- shuffle
+shuffle()
+
+
- random
diff --git a/usage/random.html b/usage/random.html
index 9f85ebb1d4..2f911ac069 100644
--- a/usage/random.html
+++ b/usage/random.html
@@ -417,6 +417,33 @@
Creation
Features¶
+
+choice¶
+
+-
+arkouda.random.Generator.choice(self, a, size=None, replace=True, p=None)¶
+Generates a randomly sample from a.
+
+- Parameters:
+
+a (int or pdarray) – If a is an integer, randomly sample from ak.arange(a).
+If a is a pdarray, randomly sample from a.
+size (int, optional) – Number of elements to be sampled
+replace (bool, optional) – If True, sample with replacement. Otherwise sample without replacement.
+Defaults to True
+p (pdarray, optional) – p is the probabilities or weights associated with each element of a
+
+
+- Returns:
+A pdarray containing the sampled values or a single random value if size not provided.
+
+- Return type:
+pdarray, numeric_scalar
+
+
+
+
+
integers¶
+
+
+normal¶
+
+-
+arkouda.random.Generator.normal(self, loc=0.0, scale=1.0, size=None)¶
+Draw samples from a normal (Gaussian) distribution
+
+- Parameters:
+
+loc (float or pdarray of floats, optional) – Mean of the distribution. Default of 0.
+scale (float or pdarray of floats, optional) – Standard deviation of the distribution. Must be non-negative. Default of 1.
+size (numeric_scalars, optional) – Output shape. Default is None, in which case a single value is returned.
+
+
+
+Notes
+The probability density for the Gaussian distribution is:
+
+
+\[p(x) = \frac{1}{\sqrt{2\pi \sigma^2}} e^{-\frac{(x-\mu)^2}{2\sigma^2}}\]
+
+where \(\mu\) is the mean and \(\sigma\) the standard deviation.
+The square of the standard deviation, \(\sigma^2\), is called the variance.
+
+- Returns:
+Pdarray of floats (unless size=None, in which case a single float is returned).
+
+- Return type:
+-
+
+
+
+See also
+
+
+Examples
+>>> ak.random.default_rng(17).normal(3, 2.5, 10)
+array([2.3673425816523577 4.0532529435624589 2.0598322696795694])
+
+
+
+
+
+
+permutation¶
+
+-
+arkouda.random.Generator.permutation(self, x)¶
+Randomly permute a sequence, or return a permuted range.
+
+
+
+
+
+shuffle¶
+
+
random¶
@@ -514,8 +622,15 @@ standard_normalNotes
-For random samples from \(N(\mu, \sigma^2)\), use:
-(sigma * standard_normal(size)) + mu
+For random samples from \(N(\mu, \sigma^2)\), either call normal or do:
+
+
+\[(\sigma \cdot \texttt{standard_normal}(size)) + \mu\]
+
+
+See also
+
+
Examples