1 | <?xml version="1.0" encoding="UTF-8"?>
|
---|
2 | <!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
|
---|
3 | "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
|
---|
4 | <!ENTITY % general-entities SYSTEM "../../general.ent">
|
---|
5 | %general-entities;
|
---|
6 |
|
---|
7 | <!ENTITY highway-download-http "https://github.com/google/highway/archive/&highway-version;/highway-&highway-version;.tar.gz">
|
---|
8 | <!ENTITY highway-md5sum "8b3d090a2d081730b40bca5ae0d65f11">
|
---|
9 | <!ENTITY highway-size "2.1 MB">
|
---|
10 | <!ENTITY highway-buildsize "21 MB">
|
---|
11 | <!ENTITY highway-time "0.8 SBU (with parallelism=4)">
|
---|
12 | ]>
|
---|
13 |
|
---|
14 | <sect1 id="highway" xreflabel="highway-&highway-version;">
|
---|
15 | <?dbhtml filename="highway.html"?>
|
---|
16 |
|
---|
17 | <title>highway-&highway-version;</title>
|
---|
18 |
|
---|
19 | <indexterm zone="highway">
|
---|
20 | <primary sortas="a-highway">highway</primary>
|
---|
21 | </indexterm>
|
---|
22 |
|
---|
23 | <sect2 role="package">
|
---|
24 | <title>Introduction to highway</title>
|
---|
25 |
|
---|
26 | <para>
|
---|
27 | The <application>highway</application> package contains a C++ library
|
---|
28 | that provides portable SIMD/vector intrinsics.
|
---|
29 | </para>
|
---|
30 |
|
---|
31 | &lfs122_checked;
|
---|
32 |
|
---|
33 | <bridgehead renderas="sect3">Package Information</bridgehead>
|
---|
34 | <itemizedlist spacing="compact">
|
---|
35 | <listitem>
|
---|
36 | <para>
|
---|
37 | Download (HTTP): <ulink url="&highway-download-http;"/>
|
---|
38 | </para>
|
---|
39 | </listitem>
|
---|
40 | <listitem>
|
---|
41 | <para>
|
---|
42 | Download MD5 sum: &highway-md5sum;
|
---|
43 | </para>
|
---|
44 | </listitem>
|
---|
45 | <listitem>
|
---|
46 | <para>
|
---|
47 | Download size: &highway-size;
|
---|
48 | </para>
|
---|
49 | </listitem>
|
---|
50 | <listitem>
|
---|
51 | <para>
|
---|
52 | Estimated disk space required: &highway-buildsize;
|
---|
53 | </para>
|
---|
54 | </listitem>
|
---|
55 | <listitem>
|
---|
56 | <para>
|
---|
57 | Estimated build time: &highway-time;
|
---|
58 | </para>
|
---|
59 | </listitem>
|
---|
60 | </itemizedlist>
|
---|
61 |
|
---|
62 | <bridgehead renderas="sect3">highway Dependencies</bridgehead>
|
---|
63 |
|
---|
64 | <bridgehead renderas="sect4">Required</bridgehead>
|
---|
65 | <para role="required">
|
---|
66 | <xref linkend="cmake"/>
|
---|
67 | </para>
|
---|
68 |
|
---|
69 | </sect2>
|
---|
70 |
|
---|
71 | <sect2 role="installation">
|
---|
72 | <title>Installation of highway</title>
|
---|
73 |
|
---|
74 | <para>
|
---|
75 | Install <application>highway</application> by running the following
|
---|
76 | commands:
|
---|
77 | </para>
|
---|
78 |
|
---|
79 | <screen><userinput>mkdir build &&
|
---|
80 | cd build &&
|
---|
81 |
|
---|
82 | cmake -D CMAKE_INSTALL_PREFIX=/usr \
|
---|
83 | -D CMAKE_BUILD_TYPE=Release \
|
---|
84 | -D BUILD_TESTING=OFF \
|
---|
85 | -D BUILD_SHARED_LIBS=ON \
|
---|
86 | -G Ninja .. &&
|
---|
87 | ninja</userinput></screen>
|
---|
88 |
|
---|
89 | <para>
|
---|
90 | This package does come with a test suite, but it requires
|
---|
91 | <ulink url="https://github.com/google/googletest">gtest</ulink>, which
|
---|
92 | is not in BLFS.
|
---|
93 | </para>
|
---|
94 |
|
---|
95 | <para>
|
---|
96 | Now, as the &root; user:
|
---|
97 | </para>
|
---|
98 |
|
---|
99 | <screen role="root"><userinput>ninja install</userinput></screen>
|
---|
100 |
|
---|
101 | </sect2>
|
---|
102 |
|
---|
103 | <sect2 role="commands">
|
---|
104 | <title>Command Explanations</title>
|
---|
105 |
|
---|
106 | <para>
|
---|
107 | <parameter>-D BUILD_TESTING=OFF</parameter>: This parameter disables the
|
---|
108 | test suite from being built because
|
---|
109 | <ulink url="https://github.com/google/googletest">gtest</ulink> is not
|
---|
110 | part of BLFS. Without this parameter, CMake will download this package
|
---|
111 | during the configuration process. If you wish to run the tests, install
|
---|
112 | <ulink url="https://github.com/google/googletest">gtest</ulink> and then
|
---|
113 | remove this parameter.
|
---|
114 | </para>
|
---|
115 |
|
---|
116 | <para>
|
---|
117 | <parameter>-D BUILD_SHARED_LIBS=ON</parameter>: This parameter enables
|
---|
118 | building shared versions of the libraries instead of static versions.
|
---|
119 | </para>
|
---|
120 |
|
---|
121 | </sect2>
|
---|
122 |
|
---|
123 | <sect2 role="content">
|
---|
124 | <title>Contents</title>
|
---|
125 |
|
---|
126 | <segmentedlist>
|
---|
127 | <segtitle>Installed Programs</segtitle>
|
---|
128 | <segtitle>Installed Libraries</segtitle>
|
---|
129 | <segtitle>Installed Directories</segtitle>
|
---|
130 |
|
---|
131 | <seglistitem>
|
---|
132 | <seg>
|
---|
133 | None
|
---|
134 | </seg>
|
---|
135 | <seg>
|
---|
136 | libhwy.so,
|
---|
137 | libhwy_contrib.so, and
|
---|
138 | libhwy_test.so
|
---|
139 | </seg>
|
---|
140 | <seg>
|
---|
141 | /usr/include/hwy and
|
---|
142 | /usr/lib/cmake/hwy
|
---|
143 | </seg>
|
---|
144 | </seglistitem>
|
---|
145 | </segmentedlist>
|
---|
146 |
|
---|
147 | <variablelist>
|
---|
148 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
149 | <?dbfo list-presentation="list"?>
|
---|
150 | <?dbhtml list-presentation="table"?>
|
---|
151 |
|
---|
152 | <varlistentry id="libhwy">
|
---|
153 | <term><filename class="libraryfile">libhwy.so</filename></term>
|
---|
154 | <listitem>
|
---|
155 | <para>
|
---|
156 | contains functions that provide portable SIMD/vector intrinsics
|
---|
157 | </para>
|
---|
158 | <indexterm zone="highway libhwy">
|
---|
159 | <primary sortas="c-libhwy">libhwy.so</primary>
|
---|
160 | </indexterm>
|
---|
161 | </listitem>
|
---|
162 | </varlistentry>
|
---|
163 |
|
---|
164 | <varlistentry id="libhwy_contrib">
|
---|
165 | <term><filename class="libraryfile">libhwy_contrib.so</filename></term>
|
---|
166 | <listitem>
|
---|
167 | <para>
|
---|
168 | contains several additions to Highway, including a series of dot
|
---|
169 | product, image, math, and sort routines
|
---|
170 | </para>
|
---|
171 | <indexterm zone="highway libhwy_contrib">
|
---|
172 | <primary sortas="c-libhwy_contrib">libhwy_contrib.so</primary>
|
---|
173 | </indexterm>
|
---|
174 | </listitem>
|
---|
175 | </varlistentry>
|
---|
176 |
|
---|
177 | <varlistentry id="libhwy_test">
|
---|
178 | <term><filename class="libraryfile">libhwy_test.so</filename></term>
|
---|
179 | <listitem>
|
---|
180 | <para>
|
---|
181 | contains test helpers for Highway
|
---|
182 | </para>
|
---|
183 | <indexterm zone="highway libhwy_test">
|
---|
184 | <primary sortas="c-libhwy_test">libhwy_test.so</primary>
|
---|
185 | </indexterm>
|
---|
186 | </listitem>
|
---|
187 | </varlistentry>
|
---|
188 | </variablelist>
|
---|
189 | </sect2>
|
---|
190 | </sect1>
|
---|