CudaTools/docs/source/core.rst

76 lines
1.2 KiB
ReStructuredText
Raw Normal View History

======
Core.h
======
2023-05-24 00:17:39 -05:00
The ``Core.h`` header file defines some useful types and some macros along with
a few core classes.
2023-05-24 00:17:39 -05:00
Types
=====
2023-05-24 00:17:39 -05:00
.. doxygentypedef:: real32
.. doxygentypedef:: real64
.. doxygentypedef:: complex64
.. doxygentypedef:: complex128
Macro Definitions
=================
Device Indicators
-----------------
.. doxygendefine:: CUDACC
.. doxygendefine:: DEVICE
Host-Device Automation
----------------------
.. doxygendefine:: HD
.. doxygendefine:: SHARED
Compilation Options
-------------------
.. doxygendefine:: CUDATOOLS_ARRAY_MAX_AXES
2023-05-24 00:17:39 -05:00
Macro Functions
===============
Kernel
------
.. doxygendefine:: DECLARE_KERNEL
.. doxygendefine:: DEFINE_KERNEL
.. doxygendefine:: KERNEL
Device Helpers
--------------
.. doxygendefine:: BASIC_LOOP
Device Class
------------
.. doxygendefine:: DEVICE_CLASS
Classes and Structs
===================
CudaTools::StreamID
-------------------
.. doxygenstruct:: CudaTools::StreamID
CudaTools::Manager
------------------
.. doxygenclass:: CudaTools::Manager
:members:
CudaTools::Kernel::Settings
---------------------------
.. doxygenstruct:: CudaTools::Kernel::Settings
:members:
CudaTools::Kernel::Basic
------------------------
.. doxygenfunction:: CudaTools::Kernel::basic