Once you have installed ArrayFire on your system, the next thing to do is set up your build system. On OSX, you may create ArrayFire project using almost any editor, compiler, or build system. The only requirement is that you can include the ArrayFire header directory, and link with the ArrayFire library you intend to use.
By default, the ArrayFire OSX installer will place several files in your computer's
/opt/arrayfire directory. The installer will populate this directory with files in the following sub-directories:
include/arrayfire.h - Primary ArrayFire include file include/af/*.h - Additional include files lib/libaf* - CPU, CUDA, and OpenCL libraries (.a, .so) lib/libforge* - Visualization library lib/libcu* - CUDA backend dependencies share/ArrayFire/cmake/* - CMake config scripts share/ArrayFire/examples/* - ArrayFire examples
Because ArrayFire follows standard installation practices, you can use basically any build system to create and compile projects that use ArrayFire. Among the many possible build systems on Linux we suggest using ArrayFire with either CMake or Makefiles with CMake being our preferred build system.
The CMake build system can be used to create ArrayFire projects. As discussed above, ArrayFire ships with a series of CMake scripts to make finding and using our library easy.
First create a file called
CMakeLists.txt in your project directory:
cd your-project-directory touch CMakeLists.txt
and populate it with the following code:
find_package(ArrayFire) add_executable(<my_executable> [list your source files here]) # To use Unified backend, do the following. # Unified backend lets you choose the backend at runtime target_link_libraries(<my_executable> ArrayFire::af)
my_executable is the name of the executable you wish to create. See the CMake documentation for more information on how to use CMake. To link with a specific backend directly, replace the
ArrayFire::af with the following for their respective backends.
ArrayFire::afcpufor CPU backend.
ArrayFire::afcudafor CUDA backend.
ArrayFire::afopenclfor OpenCL backend.
Next we need to instruct CMake to create build instructions and then compile. We suggest using CMake's out-of-source build functionality to keep your build and source files cleanly separated. To do this open the CMake GUI.
cd your-project-directory mkdir build cd build cmake .. make
NOTE: If you have installed ArrayFire to a non-standard location, CMake can still help you out. When you execute CMake specify the path to ArrayFire installation root as
For example, if ArrayFire were installed locally to
/home/user/ArrayFire then you would modify the
cmake command above to contain the following definition:
cmake -DArrayFire_DIR=/home/user/ArrayFire ..
You can also specify this information in the
ccmake command-line interface.
Building ArrayFire projects with Makefiles is fairly similar to CMake except you must specify all paths and libraries manually.
As with any make project, you need to specify the include path to the directory containing
arrayfire.h file. This should be
-I /opt/arrayfire/include if you followed our installation instructions.
Similarly, you will need to specify the path to the ArrayFire library using the
-L option (e.g.
-L/opt/arrayfire/lib) followed by the specific ArrayFire library you wish to use using the
-l option (for example
-laf for the CPU, OpenCL, CUDA, and unified backends respectively.
Here is a minimal example Makefile which uses ArrayFire's CPU backend:
LIBS=-lafcpu LIB_PATHS=-L/opt/arrayfire/lib INCLUDES=-I/opt/arrayfire/include CC=g++ $(COMPILER_OPTIONS) COMPILER_OPTIONS=-std=c++11 -g all: main.cpp Makefile $(CC) main.cpp -o test $(INCLUDES) $(LIBS) $(LIB_PATHS)