Skip to content

Commit 79decc2

Browse files
committed
Update README
Document new directory structure. Specify required compiler versions.
1 parent 080801d commit 79decc2

File tree

1 file changed

+29
-1
lines changed

1 file changed

+29
-1
lines changed

README

Lines changed: 29 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,14 +17,35 @@ release is v24.05.
1717
Source code layout:
1818

1919
build/ - build directory (created by make).
20-
math/ - math subproject sources.
20+
math/ - math subproject sources for generic scalar
21+
subroutines and sources shared with
22+
subdirectories of math/.
23+
All math routines should meet the quality
24+
requirements stated in math/README.contributors,
25+
routines that fail to do so are located in an
26+
experimental/ directory.
27+
math/aarch64/ - math subproject AArch64-specific sources
28+
and sources shared with subdirectories.
29+
math/aarch64/advsimd - AdvSIMD-specific math sources.
30+
math/aarch64/experimental - Experimental math sources do not
31+
meet quality requirements stated in
32+
math/README.contributors.
33+
math/aarch64/sve - SVE-specific math sources.
2134
math/include/ - math library public headers.
2235
math/test/ - math test and benchmark related sources.
2336
math/tools/ - tools used for designing the algorithms.
2437
networking/ - networking subproject sources.
2538
networking/include/ - networking library public headers.
2639
networking/test/ - networking test and benchmark related sources.
2740
string/ - string routines subproject sources.
41+
All string routines should meet the quality
42+
requirements stated in string/README.contributors,
43+
routines that fail to do so are located in an
44+
experimental/ directory.
45+
string/<arch> - <arch>-specific string routines sources for
46+
<arch>=aarch64, and arm.
47+
string/aarch64/experimental - Experimental string routines which
48+
may not be fully optimized yet.
2849
string/include/ - string library public headers.
2950
string/test/ - string test and benchmark related sources.
3051

@@ -49,6 +70,13 @@ Or building and testing the math subproject only:
4970
make all-math
5071
make check-math
5172

73+
Note on compiler compability/requirement:
74+
75+
SVE routines are always built by default - this means that on AArch64
76+
GCC >= 10 or LLVM >= 5 are always required for SVE ACLE compatibility.
77+
There is no explicit check for compatible compiler, therefore the SVE
78+
routines will fail to build if CC is too old.
79+
5280
The test system requires libmpfr and libmpc.
5381
For example on debian linux they can be installed as:
5482

0 commit comments

Comments
 (0)