Back to home page

Project CMSSW displayed by LXR

 
 

    


Warning, /HeterogeneousTest/AlpakaOpaque/README.md is written in an unsupported language. File is not indexed.

0001 # Introduction
0002 
0003 The packages `HeterogeneousTest/AlpakaDevice`, `HeterogeneousTest/AlpakaKernel`,
0004 `HeterogeneousTest/AlpakaWrapper` and `HeterogeneousTest/AlpakaOpaque` implement a set of libraries,
0005 plugins and tests to exercise the build rules for Alpaka.
0006 In particular, these tests show what is supported and what are the limitations implementing
0007 Alpaka-based libraries, and using them from multiple plugins.
0008 
0009 
0010 # `HeterogeneousTest/AlpakaOpaque`
0011 
0012 The package `HeterogeneousTest/AlpakaOpaque` implements a non-Alpaka aware library, with functions
0013 that call the wrappers defined in the `HeterogeneousTest/AlpakaWrapper` library:
0014 ```c++
0015 namespace ALPAKA_ACCELERATOR_NAMESPACE::test {
0016 
0017   void opaque_add_vectors_f(...);
0018   void opaque_add_vectors_d(...);
0019 
0020 }  // namespace ALPAKA_ACCELERATOR_NAMESPACE::test
0021 ```
0022 
0023 The `plugins` directory implements the `AlpakaTestOpqaueAdditionModule` `EDAnalyzer` that calls the 
0024 function defined in this library. This plugin shows how the function can be used directly from a 
0025 host-only, non-Alpaka aware plugin.
0026 
0027 The `test` directory implements the `testAlpakaDeviceAdditionOpqaue` test binary that calls the
0028 function defined in this library, and shows how they can be used directly from a host-only,
0029 non-Alpaka aware application.
0030 It also contains the `testAlpakaTestOpqaueAdditionModule.py` python configuration to exercise the
0031 `AlpakaTestOpqaueAdditionModule` module.
0032 
0033 
0034 # Other packages
0035 
0036 For various ways in which this library and plugin can be tested, see also the other
0037 `HeterogeneousTest/Alpaka...` packages:
0038   - [`HeterogeneousTest/AlpakaDevice/README.md`](../../HeterogeneousTest/AlpakaDevice/README.md)
0039   - [`HeterogeneousTest/AlpakaKernel/README.md`](../../HeterogeneousTest/AlpakaKernel/README.md)
0040   - [`HeterogeneousTest/AlpakaWrapper/README.md`](../../HeterogeneousTest/AlpakaWrapper/README.md)
0041 
0042 
0043 # Combining plugins
0044 
0045 `HeterogeneousTest/AlpakaOpaque/test` contains also the `testAlpakaTestAdditionModules.py` python
0046 configuration that exercise all four plugins in a single application.