Skip to content

Commit

Permalink
update API documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
bernhardmgruber committed Dec 14, 2021
1 parent 5f784cc commit 0d0efbe
Showing 1 changed file with 34 additions and 7 deletions.
41 changes: 34 additions & 7 deletions docs/pages/api.rst
Original file line number Diff line number Diff line change
Expand Up @@ -11,20 +11,34 @@ Useful helpers

.. _label-api-array:

.. doxygenstruct:: llama::NrAndOffset
:members:
.. doxygenfunction:: llama::structName
.. doxygentypedef:: CopyConst
.. doxygenstruct:: llama::ProxyRefOpMixin
:members:

Array
^^^^^

.. doxygenstruct:: llama::Array
:members:
.. doxygenfunction:: llama::push_front
.. doxygenfunction:: llama::push_back
.. doxygenfunction:: llama::pop_front(Array<T, N> a)
.. doxygenfunction:: llama::pop_back
.. doxygenfunction:: llama::product

Tuple
^^^^^

.. doxygenstruct:: llama::Tuple
:members:
.. doxygentypedef:: llama::TupleElement
.. doxygenfunction:: llama::get
.. doxygenvariable:: llama::tupleSize
.. doxygenfunction:: llama::tupleCat
.. doxygenfunction:: llama::tupleReplace
.. doxygenfunction:: llama::tupleTransform
.. doxygenfunction:: llama::tupleWithoutFirst(const Tuple<Elements...> &tuple)
.. doxygenstruct:: llama::NrAndOffset
:members:
.. doxygenfunction:: llama::structName
.. doxygenfunction:: llama::pop_front(const Tuple<Elements...> &tuple)

Array dimensions
----------------
Expand Down Expand Up @@ -61,10 +75,14 @@ Record dimension
.. doxygentypedef:: llama::FlatRecordDim
.. doxygenvariable:: llama::flatRecordCoord
.. doxygentypedef:: llama::LeafRecordCoords
.. doxygentypedef:: llama::TransformLeaves
.. doxygentypedef:: llama::MergedRecordDims

.. doxygenfunction:: llama::forEachLeafCoord(Functor &&functor, Tags... baseTags)
.. doxygenfunction:: llama::forEachLeafCoord(Functor &&functor, RecordCoord<Coords...> baseCoord)

.. doxygenfunction:: llama::recordCoordTags

Record coordinates
------------------

Expand Down Expand Up @@ -121,6 +139,14 @@ Mappings
:members:
.. doxygenstruct:: llama::mapping::Heatmap
:members:
.. doxygenstruct:: llama::mapping::Bytesplit
:members:
.. doxygenstruct:: llama::mapping::ChangeType
:members:
.. doxygenstruct:: llama::mapping::BitPackedIntSoA
:members:
.. doxygenstruct:: llama::mapping::BitPackedFloatSoA
:members:

RecordDim flattener
^^^^^^^^^^^^^^^^^^^
Expand Down Expand Up @@ -187,8 +213,9 @@ Macros

.. doxygendefine:: LLAMA_INDEPENDENT_DATA
.. doxygendefine:: LLAMA_FORCE_INLINE
.. doxygendefine:: LLAMA_FORCE_INLINE_RECURSIVE
.. doxygendefine:: LLAMA_UNROLL
.. doxygendefine:: LLAMA_HOST_ACC
.. doxygendefine:: LLAMA_FN_HOST_ACC_INLINE
.. doxygendefine:: LLAMA_LAMBDA_INLINE
.. doxygendefine:: LLAMA_FORCE_INLINE_RECURSIVE
.. doxygendefine:: LLAMA_COPY

0 comments on commit 0d0efbe

Please sign in to comment.