From: Paul Brossier <piem@piem.org>
Date: Wed, 31 Oct 2018 14:34:03 +0000 (+0100)
Subject: [doc] add page py_datatypes
X-Git-Tag: 0.4.8~90^2~9
X-Git-Url: https://git.aubio.org/?a=commitdiff_plain;h=51070ac2a18790d7898111d7fce142df77571007;p=aubio.git

[doc] add page py_datatypes
---

diff --git a/doc/py_datatypes.rst b/doc/py_datatypes.rst
new file mode 100644
index 00000000..feae020b
--- /dev/null
+++ b/doc/py_datatypes.rst
@@ -0,0 +1,43 @@
+.. default-domain:: py
+.. currentmodule:: aubio
+
+Data-types
+----------
+
+This section contains the documentation for :data:`float_type`,
+:class:`fvec`, and :class:`cvec`.
+
+.. defined in rst only
+
+.. data:: float_type
+
+    A string constant describing the floating-point representation used in
+    :class:`fvec`, :class:`cvec`, and elsewhere in this module.
+
+    Defaults to `"float32"`.
+
+    If `aubio` was built specifically with the option `--enable-double`, this
+    string will be defined to `"float64"`. See :ref:`doubleprecision` in
+    :ref:`requirements` for more details on building aubio in double
+    precision mode.
+
+    .. rubric:: Examples
+
+    >>> aubio.float_type
+    'float32'
+    >>> numpy.zeros(10).dtype
+    'float64'
+    >>> aubio.fvec(10).dtype
+    'float32'
+    >>> np.arange(10, dtype=aubio.float_type).dtype
+    'float32'
+
+.. defined in `python/lib/aubio/__init__.py`
+
+.. autoclass:: fvec
+  :members:
+
+.. defined in `python/ext/py-cvec.h`
+
+.. autoclass:: cvec
+  :members: