Skip to content

Commit

Permalink
Deploying to gh-pages from @ 6689642 🚀
Browse files Browse the repository at this point in the history
  • Loading branch information
stress-tess committed May 20, 2024
1 parent 27bd2cb commit 6567c90
Show file tree
Hide file tree
Showing 8 changed files with 458 additions and 139 deletions.
135 changes: 103 additions & 32 deletions _modules/arkouda/numeric.html

Large diffs are not rendered by default.

49 changes: 49 additions & 0 deletions _sources/autoapi/arkouda/index.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -179,6 +179,7 @@ Functions
arkouda.corr
arkouda.cos
arkouda.cosh
arkouda.count_nonzero
arkouda.cov
arkouda.create_pdarray
arkouda.create_pdarray
Expand Down Expand Up @@ -269,6 +270,7 @@ Functions
arkouda.max
arkouda.maxk
arkouda.mean
arkouda.median
arkouda.merge
arkouda.min
arkouda.mink
Expand Down Expand Up @@ -28088,6 +28090,29 @@ Attributes
:raises TypeError: Raised if the parameter is not a pdarray


.. py:function:: count_nonzero(pda)

Compute the nonzero count of a given array. 1D case only, for now.

:param pda: The input data, in pdarray form, numeric, bool, or str
:type pda: pdarray

:returns: The nonzero count of the entire pdarray
:rtype: np.int64

.. rubric:: Examples

>>> pda = ak.array([0,4,7,8,1,3,5,2,-1])
>>> ak.count_nonzero(pda)
9
>>> pda = ak.array([False,True,False,True,False])
>>> ak.count_nonzero(pda)
3
>>> pda = ak.array(["hello","","there"])
>>> ak.count_nonzero(pda)
2


.. py:function:: cov(x: pdarray, y: pdarray) -> numpy.float64

Return the covariance of x and y
Expand Down Expand Up @@ -30270,6 +30295,30 @@ Attributes
:raises RuntimeError: Raised if there's a server-side error thrown


.. py:function:: median(pda)

Compute the median of a given array. 1d case only, for now.

:param pda: The input data, in pdarray form, numeric type or boolean
:type pda: pdarray

:returns: The median of the entire pdarray
The array is sorted, and then if the number of elements is odd,
the return value is the middle element. If even, then the
mean of the two middle elements.
:rtype: np.float64

.. rubric:: Examples

>>> import arkouda as ak
>>> arkouda.connect()
>>> pda = ak.array ([0,4,7,8,1,3,5,2,-1])
>>> ak.median(pda)
3
>>> pda = ak.array([0,1,3,3,1,2,3,4,2,3])
2.5


.. py:function:: merge(left: DataFrame, right: DataFrame, on: Optional[Union[str, List[str]]] = None, how: str = 'inner', left_suffix: str = '_x', right_suffix: str = '_y', convert_ints: bool = True, sort: bool = True) -> DataFrame

Merge Arkouda DataFrames with a database-style join.
Expand Down
49 changes: 49 additions & 0 deletions _sources/autoapi/arkouda/numeric/index.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,7 @@ Functions
arkouda.numeric.clip
arkouda.numeric.cos
arkouda.numeric.cosh
arkouda.numeric.count_nonzero
arkouda.numeric.cumprod
arkouda.numeric.cumsum
arkouda.numeric.deg2rad
Expand All @@ -51,6 +52,7 @@ Functions
arkouda.numeric.log10
arkouda.numeric.log1p
arkouda.numeric.log2
arkouda.numeric.median
arkouda.numeric.rad2deg
arkouda.numeric.round
arkouda.numeric.sign
Expand Down Expand Up @@ -399,6 +401,29 @@ Functions
:raises TypeError: Raised if the parameter is not a pdarray


.. py:function:: count_nonzero(pda)
Compute the nonzero count of a given array. 1D case only, for now.

:param pda: The input data, in pdarray form, numeric, bool, or str
:type pda: pdarray

:returns: The nonzero count of the entire pdarray
:rtype: np.int64

.. rubric:: Examples

>>> pda = ak.array([0,4,7,8,1,3,5,2,-1])
>>> ak.count_nonzero(pda)
9
>>> pda = ak.array([False,True,False,True,False])
>>> ak.count_nonzero(pda)
3
>>> pda = ak.array(["hello","","there"])
>>> ak.count_nonzero(pda)
2


.. py:function:: cumprod(pda: arkouda.pdarrayclass.pdarray) -> arkouda.pdarrayclass.pdarray
Return the cumulative product over the array.
Expand Down Expand Up @@ -830,6 +855,30 @@ Functions
:rtype: pdarray contain values of the base 2 log


.. py:function:: median(pda)
Compute the median of a given array. 1d case only, for now.

:param pda: The input data, in pdarray form, numeric type or boolean
:type pda: pdarray

:returns: The median of the entire pdarray
The array is sorted, and then if the number of elements is odd,
the return value is the middle element. If even, then the
mean of the two middle elements.
:rtype: np.float64

.. rubric:: Examples

>>> import arkouda as ak
>>> arkouda.connect()
>>> pda = ak.array ([0,4,7,8,1,3,5,2,-1])
>>> ak.median(pda)
3
>>> pda = ak.array([0,1,3,3,1,2,3,4,2,3])
2.5


.. py:function:: rad2deg(pda: arkouda.pdarrayclass.pdarray, where: Union[bool, arkouda.pdarrayclass.pdarray] = True) -> arkouda.pdarrayclass.pdarray
Converts angles element-wise from radians to degrees.
Expand Down
248 changes: 159 additions & 89 deletions autoapi/arkouda/index.html

Large diffs are not rendered by default.

104 changes: 87 additions & 17 deletions autoapi/arkouda/numeric/index.html

Large diffs are not rendered by default.

10 changes: 10 additions & 0 deletions genindex.html
Original file line number Diff line number Diff line change
Expand Up @@ -1681,6 +1681,12 @@ <h2>C</h2>
<li><a href="autoapi/arkouda/index.html#arkouda.GroupBy.count">(arkouda.GroupBy method)</a>, <a href="autoapi/arkouda/index.html#id252">[1]</a>, <a href="autoapi/arkouda/index.html#id297">[2]</a>, <a href="autoapi/arkouda/index.html#id342">[3]</a>, <a href="autoapi/arkouda/index.html#id387">[4]</a>, <a href="autoapi/arkouda/index.html#id432">[5]</a>, <a href="usage/groupby.html#arkouda.GroupBy.count">[6]</a>
</li>
<li><a href="autoapi/arkouda/groupbyclass/index.html#arkouda.groupbyclass.GroupBy.count">(arkouda.groupbyclass.GroupBy method)</a>
</li>
</ul></li>
<li><a href="autoapi/arkouda/index.html#arkouda.count_nonzero">count_nonzero() (in module arkouda)</a>

<ul>
<li><a href="autoapi/arkouda/numeric/index.html#arkouda.numeric.count_nonzero">(in module arkouda.numeric)</a>
</li>
</ul></li>
<li><a href="autoapi/arkouda/array_api/_set_functions/index.html#arkouda.array_api._set_functions.UniqueAllResult.counts">counts (arkouda.array_api._set_functions.UniqueAllResult attribute)</a>
Expand Down Expand Up @@ -3561,6 +3567,10 @@ <h2>M</h2>
<li><a href="autoapi/arkouda/index.html#arkouda.GroupBy.median">(arkouda.GroupBy method)</a>, <a href="autoapi/arkouda/index.html#id258">[1]</a>, <a href="autoapi/arkouda/index.html#id303">[2]</a>, <a href="autoapi/arkouda/index.html#id348">[3]</a>, <a href="autoapi/arkouda/index.html#id393">[4]</a>, <a href="autoapi/arkouda/index.html#id438">[5]</a>, <a href="usage/groupby.html#arkouda.GroupBy.median">[6]</a>
</li>
<li><a href="autoapi/arkouda/groupbyclass/index.html#arkouda.groupbyclass.GroupBy.median">(arkouda.groupbyclass.GroupBy method)</a>
</li>
<li><a href="autoapi/arkouda/index.html#arkouda.median">(in module arkouda)</a>
</li>
<li><a href="autoapi/arkouda/numeric/index.html#arkouda.numeric.median">(in module arkouda.numeric)</a>
</li>
</ul></li>
<li><a href="autoapi/arkouda/index.html#arkouda.DataFrame.memory_usage">memory_usage() (arkouda.DataFrame method)</a>, <a href="autoapi/arkouda/index.html#id137">[1]</a>
Expand Down
Binary file modified objects.inv
Binary file not shown.
2 changes: 1 addition & 1 deletion searchindex.js

Large diffs are not rendered by default.

0 comments on commit 6567c90

Please sign in to comment.