Arrayfire Rust Bindings
ArrayFire is a high performance library for parallel computing with an easy-to-use API. It enables users to write scientific computing code that is portable across CUDA, OpenCL and CPU devices. This project provides Rust bindings for the ArrayFire library. Given below table shows the rust bindings compatability with ArrayFire. If you find any bugs, please report them here.
| arrayfire-rust | ArrayFire |
|---|---|
| M.m.p1 | M.m.p2 |
Only, Major(M) & Minor(m) version numbers need to match. p1 and p2 are patch/fix updates for arrayfire-rust & ArrayFire respectively, and they don't need to match.
Supported platforms
Linux, Windows and OSX. Rust 1.31 or newer is required.
Use from Crates.io 
To use the rust bindings for ArrayFire from crates.io, the following requirements are to be met first.
- Download and install ArrayFire binaries based on your operating system. Depending on the method of your installation for Linux, steps (2) & (3) may not be required. If that is the case, proceed to step (4) directly.
- Set the evironment variable
AF_PATHto point to ArrayFire installation root folder. - Make sure to add the path to lib files to your path environment variables.
- On Linux: do
export LD_LIBRARY_PATH=$LD_LIBRARY_PATH:$AF_PATH/lib64 - On OSX: do
export DYLD_LIBRARY_PATH=$DYLD_LIBRARY_PATH:$AF_PATH/lib64 - On Windows: Add
%AF_PATH%\libto your PATH environment variable.
- On Linux: do
- Add
arrayfire = "3.8"to the dependencies section of your project's Cargo.toml file. Make sure to change the version to latest available.
Once step (4) is over, you should be able to use ArrayFire in your Rust project. If you find any bugs, please report them here.
Build from Source
Edit build.conf to modify the build flags. The structure is a simple JSON blob. Currently Rust does not allow key:value pairs to be passed from the CLI. To use an existing ArrayFire installation modify the first three JSON values. You can install ArrayFire using one of the following two ways.
To build arrayfire submodule available in the rust wrapper repository, you have to do the following.
git submodule update --init --recursive
cargo build // use --all to build all crates in the workspace
This is recommended way to build Rust wrapper since the submodule points to the most compatible version of ArrayFire the Rust wrapper has been tested with. You can find the ArrayFire dependencies below.
Example
let num_rows: u64 = 5;
let num_cols: u64 = 3;
let dims = Dim4::new(&[num_rows, num_cols, 1, 1]);
let a = randu::<f32>(dims);
af_print!("Create a 5-by-3 matrix of random floats on the GPU", a);
Sample output
~/p/arrayfire_rust> cargo run --example helloworld
...
Create a 5-by-3 matrix of random floats on the GPU
[5 3 1 1]
0.7402 0.4464 0.7762
0.9210 0.6673 0.2948
0.0390 0.1099 0.7140
0.9690 0.4702 0.3585
0.9251 0.5132 0.6814
...
Troubleshooting
If the build command fails with undefined references errors even after taking care of environment variables, we recommend doing a cargo clean and re-running cargo build or cargo test.
You can also use some environment variables mentioned in our book, such as AF_PRINT_ERRORS to print more elaborate error messages to console.
Acknowledgements
The ArrayFire library is written by developers at ArrayFire LLC with contributions from several individuals. The developers at ArrayFire LLC have received partial financial support from several grants and institutions. Those that wish to receive public acknowledgement are listed below:
Grants
This material is based upon work supported by the DARPA SBIR Program Office under Contract Numbers W31P4Q-14-C-0012 and W31P4Q-15-C-0008. Any opinions, findings and conclusions or recommendations expressed in this material are those of the author(s) and do not necessarily reflect the views of the DARPA SBIR Program Office.
1.3k Dec 30, 2022
101 Dec 12, 2022
32 Dec 1, 2022
80 Dec 31, 2022
3.1k Jan 1, 2023
546 Jan 3, 2023
3.6k Jan 3, 2023
18 Feb 13, 2021
220 Dec 26, 2022
14 Nov 28, 2021
12 Jul 17, 2022
14 Sep 5, 2022
20 Dec 13, 2022
126 Dec 30, 2022
43 Jan 4, 2023
29 Nov 26, 2022
22 Nov 20, 2022
28 Aug 5, 2022
8 Nov 19, 2022
77 Oct 8, 2022
37 Nov 5, 2022
242 Dec 16, 2022
384 Dec 27, 2022
47 Sep 23, 2022
1.5k Dec 30, 2022
294 Dec 23, 2022
47 May 4, 2022
336 Jan 2, 2023
628 Jan 7, 2023