File: api.rst

package info (click to toggle)
mpich 4.0.2-3
  • links: PTS, VCS
  • area: main
  • in suites: bookworm
  • size: 423,384 kB
  • sloc: ansic: 1,088,434; cpp: 71,364; javascript: 40,763; f90: 22,829; sh: 17,463; perl: 14,773; xml: 14,418; python: 10,265; makefile: 9,246; fortran: 8,008; java: 4,355; asm: 324; ruby: 176; lisp: 19; php: 8; sed: 4
file content (67 lines) | stat: -rw-r--r-- 1,346 bytes parent folder | download | duplicates (3)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
..
.. Copyright (C) Arm Ltd. 2021.  ALL RIGHTS RESERVED.
..
.. See file LICENSE for terms.
..

API Documentation
=================

*  The full API specification can be found here : `HTML <https://openucx.github.io/ucx/api/v{VERSION}/html/index.html>`_ `PDF <https://openucx.github.io/ucx/api/v{VERSION}/ucx-v{VERSION}.pdf>`_
* `Code examples <https://github.com/openucx/ucx/tree/v{VERSION}.x/examples>`_

.. contents::
   :local:
   :depth: 3

Application Context routines
********************************
.. doxygengroup:: UCP_CONTEXT
    :project: openucx

Worker routines
*******************
.. doxygengroup:: UCP_WORKER
    :project: openucx

Endpoint routines
*********************
.. doxygengroup:: UCP_ENDPOINT
    :project: openucx

Data type routines
**********************
.. doxygengroup:: UCP_DATATYPE
    :project: openucx

Memory routines
*******************
.. doxygengroup:: UCP_MEM
    :project: openucx

Configuration routines
**************************
.. doxygengroup:: UCP_CONFIG
    :project: openucx

Communication routines
**************************
.. doxygengroup:: UCP_COMM
    :project: openucx

Wake-up routines
********************
.. doxygengroup:: UCP_WAKEUP
    :project: openucx

Resources
*************
.. doxygengroup:: UCS_RESOURCE
    :project: openucx

Index
*************
.. toctree::
   :glob:

   api/*