You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: source/elements/oneDAL/source/common_interface/header_files_and_namespaces.rst
+12-10Lines changed: 12 additions & 10 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -10,20 +10,21 @@ oneDAL public identifiers are represented in the following header files:
10
10
11
11
* - Header file
12
12
- Description
13
-
* - ``onedal/onedal.hpp``
13
+
* - ``oneapi/dal.hpp``
14
14
- The main header file of oneDAL library.
15
-
* - ``onedal/algo/%ALGO%/%ALGO%.hpp``
15
+
* - ``oneapi/dal/algo/%ALGO%.hpp``
16
16
- A header file for a particular algorithm.
17
+
The folder for the algorithm itself is ``oneapi/dal/algo/%ALGO%/``.
17
18
18
19
The string %ALGO% should be substituted with the name of the algorithm, for example, ``kmeans`` or ``knn``.
19
20
20
-
* - ``onedal/algo/misc/%FUNC%/%FUNC%.hpp``
21
+
* - ``oneapi/dal/algo/misc/%FUNC%.hpp``
21
22
- A header file for miscellaneous data types and functionality that is intended to be used by oneDAL algorithms and applications
22
23
of the analytical pipeline.
23
24
24
25
The string %FUNC% should be substituted with the functionality name, for example, ``mt19937`` or ``cross_enthropy_loss``.
25
26
26
-
* - ``onedal/util/%UTIL%.hpp```
27
+
* - ``oneapi/dal/util/%UTIL%.hpp```
27
28
- A header file for auxiliary functionality, such as memory allocators or type traits, that is intended to be used for the design of classes and implementation of various methods.
28
29
29
30
The string %UTIL% should be substituted with the auxiliary functionality name, for example, ``usm_allocator`` or ``type_traits``.
@@ -43,23 +44,24 @@ oneDAL functionality is represented with a system of C++ namespaces described be
43
44
44
45
* - Namespace
45
46
- oneDAL content
46
-
* - ``onedal``
47
-
- The namespace of the library that contains externally exposed data types, processing and service functionality of oneDAL.
48
-
* - ``onedal::%ALGORITHM%``
47
+
* - ``oneapi::dal``
48
+
- The namespace of the library that contains externally exposable data types, processing and service functionality of oneDAL.
49
+
* - ``oneapi::dal::%ALGORITHM%``
50
+
49
51
- The namespace of the algorithm.
50
52
All classes and structures related to that algorithm shall be defined within a particular namespace.
51
53
52
54
To define a specific algorithm, the string %ALGORITHM% should be substituted with its name,
53
-
for example, ``onedal::kmeans`` or ``onedal::knn``.
55
+
for example, ``oneapi::dal::kmeans`` or ``oneapi::dal::knn``.
54
56
55
-
* - ``onedal::misc``
57
+
* - ``oneapi::dal::misc``
56
58
- The namespace that contains miscellaneous data types and functionality intended to be used by oneDAL algorithms
57
59
and applications for algorithm customization and optimization on various stages of the analytical pipeline.
58
60
* - ``%PARENT%::detail``
59
61
- The namespace that contains implementation details of the data types and functionality for the parent namespace.
60
62
The namespace can be on any level in the namespace hierarchy.
61
63
62
64
To define a specific namespace, the string %PARENT% should be substituted with the namespace for which the details are provided,
63
-
for example, ``onedal::detail`` or ``onedal::kmeans::detail``.
65
+
for example, ``oneapi::dal::detail`` or ``oneapi::dal::kmeans::detail``.
64
66
65
67
The application shall not use any data types nor call any functionality located in the ``detail`` namespaces.
0 commit comments