Changeset 6d4802f


Ignore:
Timestamp:
Oct 31, 2018, 5:12:21 PM (14 months ago)
Author:
Paul Brossier <piem@piem.org>
Branches:
feature/autosink, feature/constantq, feature/pitchshift, feature/pydocstrings, feature/timestretch, master
Children:
dc3f68d
Parents:
a4a00a5
Message:

[doc] add a note about building the module in double precision

Location:
doc
Files:
4 edited

Legend:

Unmodified
Added
Removed
  • doc/py_datatypes.rst

    ra4a00a5 r6d4802f  
    1818
    1919    If `aubio` was built specifically with the option `--enable-double`, this
    20     string will be defined to `"float64"`. See :ref:`doubleprecision` in
    21     :ref:`requirements` for more details on building aubio in double
     20    string will be defined to `"float64"`. See :ref:`py-doubleprecision` in
     21    :ref:`python-install` for more details on building aubio in double
    2222    precision mode.
    2323
  • doc/py_utils.rst

    ra4a00a5 r6d4802f  
    55---------
    66
    7 This section documents various helpers functions included in the aubio library.
     7This section documents various helper functions included in the aubio library.
    88
    99Note name conversion
  • doc/python_module.rst

    ra4a00a5 r6d4802f  
    2626    $ sudo ./setup.py install
    2727
     28
     29.. _py-doubleprecision:
     30
     31Double precision
     32----------------
     33
     34This module can be compiled in double-precision mode, in which case the
     35default type for floating-point samples will be 64-bit. The default is
     36single precision mode (32-bit, recommended).
     37
     38To build the aubio module with double precision, use the option
     39`--enable-double` of the `build_ext` subcommand:
     40
     41.. code:: bash
     42
     43    $ ./setup.py clean
     44    $ ./setup.py build_ext --enable-double
     45    $ pip install -v .
     46
     47**Note**: If linking against `libaubio`, make sure the library was also
     48compiled in :ref:`doubleprecision` mode.
     49
     50
    2851Checking your installation
    2952--------------------------
  • doc/requirements.rst

    ra4a00a5 r6d4802f  
    298298                uninstall clean distclean dist distcheck
    299299
     300.. _doubleprecision:
     301
    300302Double precision
    301303................
     
    303305To compile aubio in double precision mode, configure with ``--enable-double``.
    304306
    305 To compile aubio in single precision mode, use ``--disable-double`` (default).
     307To compile aubio in single precision mode, use ``--disable-double`` (default,
     308recommended).
    306309
    307310Disabling the tests
Note: See TracChangeset for help on using the changeset viewer.