diff --git a/doc/misc.rst b/doc/misc.rst index f977fffd50a5d30bca50700bf213a8e968bb46e1..ac1ea388b87790f6217c7c88dfc0c266254a9d92 100644 --- a/doc/misc.rst +++ b/doc/misc.rst @@ -1,6 +1,8 @@ Misc Tools ========== +.. automodule:: sumpy.tools + .. automodule:: sumpy.derivative_taker .. automodule:: sumpy.symbolic diff --git a/sumpy/tools.py b/sumpy/tools.py index 32b4d3eecb0268263e2f631d17b7beacbc6d90a9..daad385301a6be0d5a4cecbff9f26b83b94f5d0a 100644 --- a/sumpy/tools.py +++ b/sumpy/tools.py @@ -45,6 +45,65 @@ if TYPE_CHECKING: from sumpy.kernel import Kernel +logger = logging.getLogger(__name__) + + +__doc__ = """ +Tools +===== + +.. autofunction:: to_complex_dtype +.. autofunction:: is_obj_array_like +.. autofunction:: vector_to_device +.. autofunction:: vector_from_device +.. autoclass:: OrderedSet + +Multi-index Helpers +------------------- + +.. autofunction:: add_mi +.. autofunction:: mi_factorial +.. autofunction:: mi_increment_axis +.. autofunction:: mi_set_axis +.. autofunction:: mi_power + +Symbolic Helpers +---------------- + +.. autofunction:: add_to_sac +.. autofunction:: gather_arguments +.. autofunction:: gather_source_arguments +.. autofunction:: gather_loopy_arguments +.. autofunction:: gather_loopy_source_arguments + +.. autoclass:: ScalingAssignmentTag +.. autoclass:: KernelComputation +.. autoclass:: KernelCacheMixin + +.. autofunction:: reduced_row_echelon_form +.. autofunction:: nullspace + +FFT +--- + +.. autofunction:: fft +.. autofunction:: fft_toeplitz_upper_triangular +.. autofunction:: matvec_toeplitz_upper_triangular + +.. autoclass:: FFTBackend +.. autofunction:: loopy_fft +.. autofunction:: get_opencl_fft_app +.. autofunction:: run_opencl_fft + +Profiling +--------- + +.. autofunction:: get_native_event +.. autoclass:: ProfileGetter +.. autoclass:: AggregateProfilingEvent +.. autoclass:: MarkerBasedProfilingEvent +""" + # {{{ multi_index helpers