C++ API
=======

.. _fftx_apis:

FFTX interfaces
---------------

The FFTX interfaces operate on constructs in
``namespace fftx``.
A multi-dimensional array is represented by an instance of
:ref:`struct array_t <fftx_array_t>`,
which is defined by its domain as an instance of
:ref:`struct box_t <fftx_box_t>`,
which in turn is defined by its corners, which are instances of
:ref:`struct point_t <fftx_point_t>`.
An array instance also contains a pointer to the data, an instance of
:ref:`class global_ptr <fftx_global_ptr>`.

The class :ref:`FFTXProblem <FFTXProblem>` defines an FFTX problem
of a particular transform type of a particular size.

The documentation below is generated by `doxygen <https://www.doxygen.nl>`_.

.. _fftx_point_t:

fftx::point_t
-------------

.. doxygenstruct:: fftx::point_t
   :members:
..   :allow-dot-graphs:

.. _fftx_box_t:

fftx::box_t
-----------

.. doxygenstruct:: fftx::box_t
   :members:
..   :allow-dot-graphs:

.. _fftx_array_t:

fftx::array_t
-------------

.. doxygenstruct:: fftx::array_t
   :members:
..   :allow-dot-graphs:

.. _fftx_global_ptr:

fftx::global_ptr
----------------

.. doxygenclass:: fftx::global_ptr
   :members:
..   :allow-dot-graphs:

.. _FFTXProblem:

FFTXProblem
-----------

.. doxygenclass:: FFTXProblem
   :members:
..   :allow-dot-graphs:

.. AVOID .. doxygengroup:: docTitleCmdGroup
.. AVOID    :project: FFTX
.. AVOID .. doxygenpage:: dotgraphs because "dotgraphs" can't be found.
.. AVOID .. doxygenindex:: because it writes out too much.