ref: 51070ac2a18790d7898111d7fce142df77571007
parent: 7cfad8e10b28f1e37c02a0cf8a10e95e96e86488
author: Paul Brossier <piem@piem.org>
date: Wed Oct 31 11:34:03 EDT 2018
[doc] add page py_datatypes
--- /dev/null
+++ b/doc/py_datatypes.rst
@@ -1,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: