Skip to content

Commit 6985bb6

Browse files
committed
Add ipp information to readme
1 parent e895511 commit 6985bb6

1 file changed

Lines changed: 10 additions & 1 deletion

File tree

README.md

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@ As the original C++ implementation, this library implements:
88

99
- Partitioned convolution algorithm (using uniform block sizes)
1010
- Optional support for non-uniform block sizes (`TwoStageFFTConvolver`)
11+
- An optimised version of the convolvers using Intel IPP (if the `ipp` feature is enabled)
1112

1213
On top of that it implements:
1314

@@ -16,9 +17,17 @@ On top of that it implements:
1617

1718
Compared to the original C++ implementation, this implementation does _not_ provide:
1819

19-
- Its own FFT implementation (it currently uses the rustfft crate)
20+
- Its own FFT implementation (it currently uses the rustfft crate by default or the IPP library if the `ipp` feature is enabled)
2021
- The option to use SSE instructions in the `FFTConvolver`
2122

2223
## Prerequisites:
2324

2425
- rust >=1.72.0
26+
27+
#### Optional dependencies:
28+
29+
- Intel IPP (if the `ipp` feature is enabled)
30+
31+
When building with the `ipp` feature, the `ipp-sys` crate is used to link against the IPP library. To build with the `ipp` feature, you need to have the IPP library installed and the `IPPROOT` environment variable set to the root directory of the IPP installation. On Linux this is achieved by running:
32+
33+
- `source /opt/intel/oneapi/setvars.sh`

0 commit comments

Comments
 (0)