diff options
author | Damien George <damien.p.george@gmail.com> | 2019-10-22 16:40:58 +1100 |
---|---|---|
committer | Damien George <damien.p.george@gmail.com> | 2019-10-22 16:40:58 +1100 |
commit | a2eea57b1d5456696598703aa4ffdbc7e9fb52ea (patch) | |
tree | 66eb515300bc84a8bef3010233c50233fd2d512b /docs/library/uarray.rst | |
parent | 21a60935a5d5885817881b4f690fdfd3ef009100 (diff) |
docs/library: Rename "array" module to "uarray".
Diffstat (limited to 'docs/library/uarray.rst')
-rw-r--r-- | docs/library/uarray.rst | 29 |
1 files changed, 29 insertions, 0 deletions
diff --git a/docs/library/uarray.rst b/docs/library/uarray.rst new file mode 100644 index 000000000..9fa82ff31 --- /dev/null +++ b/docs/library/uarray.rst @@ -0,0 +1,29 @@ +:mod:`uarray` -- arrays of numeric data +======================================= + +.. module:: uarray + :synopsis: efficient arrays of numeric data + +|see_cpython_module| :mod:`python:array`. + +Supported format codes: ``b``, ``B``, ``h``, ``H``, ``i``, ``I``, ``l``, +``L``, ``q``, ``Q``, ``f``, ``d`` (the latter 2 depending on the +floating-point support). + +Classes +------- + +.. class:: array(typecode, [iterable]) + + Create array with elements of given type. Initial contents of the + array are given by *iterable*. If it is not provided, an empty + array is created. + + .. method:: append(val) + + Append new element *val* to the end of array, growing it. + + .. method:: extend(iterable) + + Append new elements as contained in *iterable* to the end of + array, growing it. |