diff --git a/CHANGES.md b/CHANGES.md new file mode 100644 index 00000000..719df449 --- /dev/null +++ b/CHANGES.md @@ -0,0 +1,6 @@ +# Changes + +## 1.0.1 +- Remove intel- prefix from headers and library name +- Fix CMake variables from 3rd party libraries from leaking +- Fix warnings when HEXL_DEBUG=ON diff --git a/docs/doxygen/html/index.html b/docs/doxygen/html/index.html index c0a3a72a..d4486695 100644 --- a/docs/doxygen/html/index.html +++ b/docs/doxygen/html/index.html @@ -90,7 +90,7 @@
For optimal performance, Intel HEXL does not perform input validation. In many cases the time required for the validation would be longer than the execution of the function itself. To debug Intel HEXL, configure and build Intel HEXL with -DHEXL_DEBUG=ON
(see Compile-time options). This will generate a debug version of the library, e.g. libhexl_debug.a
, that can be used to debug the execution.
Note, enabling HEXL_DEBUG=ON
will result in a significant runtime overhead.
Intel HEXL is single-threaded and thread-safe.
See https://intel.github.io/hexl for Doxygen documentation.
Intel HEXL supports documentation via Doxygen and sphinx. To build documentation, first install doxygen
and graphviz
, e.g.
Then, configure Intel HEXL with -DHEXL_DOCS=ON
(see Compile-time options).
To build Doxygen documentation, after configuring Intel HEXL with -DHEXL_DOCS=ON
, run
To view the generated Doxygen documentation, open the generated build/docs/doxygen/html/index.html
file in a web browser.
To build the sphinx documentation, install sphinx
and required dependencies breathe, m2r2
, e.g.
Then, after configuring Intel HEXL with -DHEXL_DOCS=ON
, run
and make sure pre-commit checks and all unit tests pass.
Public headers reside in the hexl/include
folder. Private headers, e.g. those containing Intel(R) AVX-512 code should not be put in this folder.
Public headers reside in the hexl/include
folder. Private headers, e.g. those containing Intel(R) AVX-512 code should not be put in this folder.
Find published paper at https://arxiv.org/abs/2103.16400.
+To cite Intel HEXL, please use the following BibTeX entry.
+