-
Notifications
You must be signed in to change notification settings - Fork 0
/
INSTALL
87 lines (64 loc) · 4.35 KB
/
INSTALL
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
Installation instructions
*************************
Since Blaze is a header-only library, setting up the Blaze library on a particular system is
a fairly easy two step process. In the following, this two step process is explained in detail,
preceded only by a short summary of the requirements.
Requirements
************
In order for Blaze to work properly, the Boost library must be installed on the system. It is
recommended to use the newest Boost library available, but Blaze requires at minimum the Boost
version 1.54.0. If you don't have Boost installed on your system, you can download it for free
from 'www.boost.org'.
Additionally, for maximum performance Blaze expects you to have a BLAS library installed (Intel
MKL, ACML, Atlas, Goto, ...). If you don't have a BLAS library installed on your system, Blaze
will still work and will not be reduced in functionality, but performance may be limited. Thus
it is strongly recommended to install a BLAS library.
Furthermore, for computing the determinant of a dense matrix and for the dense matrix inversion
Blaze requires LAPACK. When either of these features is used it is necessary to link the LAPACK
library to the final executable. If no LAPACK library is available the use of these features will
result in a linker error.
Step 1: Installation
********************
Linux/MacOSX Users
------------------
The first step is the installation of the header files. Since Blaze only consists of header
files, the './blaze' subdirectory can be simply copied to a standard include directory (note
that this requires root privileges):
cp -r ./blaze /usr/local/include
Alternatively, on Unix-based machines (which includes Linux and Mac OS X) the 'CPLUS_INCLUDE_PATH'
environment variable can be set. The specified directory will be searched after any directories
specified on the command line with the option \c -I and before the standard default directories
(such as '/usr/local/include' and ‘/usr/include'). Assuming a user named 'Jon', the environment
variable can be set as follows:
CPLUS_INCLUDE_PATH=/usr/home/jon/blaze
export CPLUS_INCLUDE_PATH
Last but not least, the './blaze' subdirectory can be explicitly specified on the command line.
The following example demonstrates this by means of the GNU C++ compiler:
g++ -I/usr/home/jon/blaze -o BlazeTest BlazeTest.cpp
Windows Users
-------------
Windows doesn't have a standard include directory. Therefore the Blaze header files can be copied
to any other directory or simply left in the default Blaze directory. However, the chosen include
directory has to be explicitly specified as include path. In Visual Studio, this is done via the
project property pages, configuration properties, C/C++, General settings. Here the additional
include directories can be specified.
Step 2: Configuration
*********************
The second step is the configuration and customization of the Blaze library. Many aspects of
Blaze can be adapted to specific requirements, environments and architectures by customizing
the header files in the './blaze/config/' subdirectory. Since the default settings are
reasonable for most systems this step can also be skipped. However, in order to achieve maximum
performance a customization of at least the following configuration files is required:
- './blaze/config/BLAS.h': Via this configuration file Blaze can be enabled to use a third-party
BLAS library for several basic linear algebra functions (such as for instance dense matrix
multiplications). In case no BLAS library is used, all linear algebra functions use the default
implementations of the \b Blaze library and therefore BLAS is not a requirement for the
compilation process. However, please note that performance may be limited.
- './blaze/config/CacheSize.h': This file contains the hardware specific cache settings. Blaze
uses this information to optimize its cache usage. For maximum performance it is recommended
to adapt these setting to a specific target architecture.
- './blaze/config/Thresholds.h': This file contains all thresholds for the customization of the
Blaze compute kernels. In order to tune the kernels for a specific architecture and to maximize
performance it can be necessary to adjust the thresholds, especially for a parallel execution.
For an overview of other customization options and more details, please see the Blaze wiki at
https://bitbucket.org/blaze-lib/blaze/wiki/Home.