Skip to content

Commit dfd173d

Browse files
authored
FPGA: Add examples about where the include files are used (oneapi-src#1020)
* libraries use case initial commit Signed-off-by: Yohann Uguen <yohann.uguen@intel.com> * use br Signed-off-by: Yohann Uguen <yohann.uguen@intel.com> * fix onchip entry Signed-off-by: Yohann Uguen <yohann.uguen@intel.com> * limiting to 3 entries Signed-off-by: Yohann Uguen <yohann.uguen@intel.com> * update to master Signed-off-by: Yohann Uguen <yohann.uguen@intel.com>
1 parent 90264bd commit dfd173d

File tree

1 file changed

+16
-16
lines changed

1 file changed

+16
-16
lines changed

DirectProgramming/DPC++FPGA/include/README.md

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -5,25 +5,25 @@ This directory contains utility header libraries optimized for SYCL*-compliant F
55

66
### Utilities
77

8-
| Filename | Description
9-
--- |---
10-
| `constexpr_math.hpp` | Defines utilities for statically computing math functions (for example, Log2 and Pow2).
11-
| `memory_utils.hpp` | Generic functions for streaming data from memory to a SYCL pipe and vise versa.
12-
| `metaprogramming_utils.hpp` | Defines various metaprogramming utilities (for example, generating a power of 2 sequence and checking if a type has a subscript operator).
13-
| `onchip_memory_with_cache.hpp` | Class that contains an on-chip memory array with a register backed cache to achieve high performance read-modify-write loops.
14-
| `pipe_utils.hpp` | Utility classes for working with pipes, such as PipeArray.
15-
| `rom_base.hpp` | A generic base class to create ROMs in the FPGA using and initializer lambda or functor.
16-
| `tuple.hpp` | Defines a template to implement tuples.
17-
| `unrolled_loop.hpp` | Defines a templated implementation of unrolled loops.
8+
| Filename | Description | Use case examples
9+
--- |--- |---
10+
| `constexpr_math.hpp` | Defines utilities for statically computing math functions (for example, Log2 and Pow2). | `ReferenceDesigns/merge_sort/`<br> `ReferenceDesigns/qrd`<br> `ReferenceDesigns/qri`
11+
| `memory_utils.hpp` | Generic functions for streaming data from memory to a SYCL pipe and vise versa. | `ReferenceDesigns/decompress/`
12+
| `metaprogramming_utils.hpp` | Defines various metaprogramming utilities (for example, generating a power of 2 sequence and checking if a type has a subscript operator).| `ReferenceDesigns/decompress/`<br> `include/unrolled_loop.hpp`
13+
| `onchip_memory_with_cache.hpp`| Class that contains an on-chip memory array with a register backed cache to achieve high performance read-modify-write loops. | `Tutorials/DesignPatterns/onchip_memory_cache/`<br> `ReferenceDesigns/decompress/`<br> `ReferenceDesigns/db/`
14+
| `pipe_utils.hpp` | Utility classes for working with pipes, such as PipeArray. | `Tutorials/DesignPatterns/pipe_array/`<br> `ReferenceDesigns/merge_sort/`<br> `ReferenceDesigns/gzip/`
15+
| `rom_base.hpp` | A generic base class to create ROMs in the FPGA using and initializer lambda or functor. | `ReferenceDesigns/anr/`
16+
| `tuple.hpp` | Defines a template to implement tuples. | `ReferenceDesigns/cholesky_inversion/`<br> `ReferenceDesigns/qri/`<br> `ReferenceDesigns/cholesky/`
17+
| `unrolled_loop.hpp` | Defines a templated implementation of unrolled loops. | `Tutorials/DesignPatterns/pipe_array/`<br> `ReferenceDesigns/cholesky/`<br> `ReferenceDesigns/anr/`
1818

1919
### Linear Algebra
2020

21-
| Filename | Description
22-
--- |---
23-
| `streaming_qrd.hpp` | QR decomposition of matrices with pipe interfaces.
24-
| `streaming_qri.hpp` | QR-based inversion of matrices with pipe interfaces.
25-
| `streaming_cholesky.hpp` | Cholesky decomposition of matrices with pipe interfaces.
26-
| `streaming_cholesky_inversion.hpp` | Cholesky-based inversion of matrices with pipe interfaces.
21+
| Filename | Description | Use case examples
22+
--- |--- |---
23+
| `streaming_qrd.hpp` | QR decomposition of matrices with pipe interfaces. | `ReferenceDesigns/qrd`
24+
| `streaming_qri.hpp` | QR-based inversion of matrices with pipe interfaces. | `ReferenceDesigns/qri`
25+
| `streaming_cholesky.hpp` | Cholesky decomposition of matrices with pipe interfaces. | `ReferenceDesigns/cholesky`
26+
| `streaming_cholesky_inversion.hpp` | Cholesky-based inversion of matrices with pipe interfaces. | `ReferenceDesigns/cholesky_inversion`
2727

2828
## License
2929

0 commit comments

Comments
 (0)