AUTO for SYMX_ENABLE_AVX2

Author: JoseAntFer

.doctrees/compilation.doctree

@@ -0,0 +1 @@
+_static/overview.jpg

.doctrees/environment.pickle

@@ -120,7 +120,7 @@ Compiled<__m256d> compiled({f, df_dx}, "my_function_simd4d", codegen_dir, checks
 Compiled<__m256> compiled({f, df_dx}, "my_function_simd8f", codegen_dir, checksum);
 ```
 Note that you will need to set values of type `FLOAT` and that the result will be returned as `View<FLOAT>`.
-If your system does not support these SIMD types, set SymX's the CMake flag `SYMX_ENABLE_AVX2` to `OFF`.
+If your system does not support these SIMD types, disable them with `-DSYMX_ENABLE_AVX2=OFF` (the default `AUTO` already does this on non-x86 targets).
 
 ### Parallel evaluation
 You can evaluate a `Compiled` expression in parallel in the following way:

.doctrees/setup.doctree

@@ -41,17 +41,19 @@ build/examples/examples   # Examples
 
 | Option | Default | Description |
 |---|---|---|
-| `SYMX_ENABLE_AVX2` | `ON` | Enable AVX2 + FMA SIMD paths |
+| `SYMX_ENABLE_AVX2` | `AUTO` | Enable AVX2 + FMA SIMD paths (`AUTO` / `ON` / `OFF`); `AUTO` enables on x86/x86_64/AMD64 |
 | `SYMX_COMPILER_PATH` | `AUTO` | Compiler used for JIT code generation at runtime |
 | `SYMX_CODEGEN_DIR` | *(empty)* | Output directory for generated files; defaults to `<build>/codegen` |
 | `SYMX_HESS_STORAGE_FLOAT` | `float` | Hessian storage precision (`float` or `double`) |
 
 
 ### AVX2 support
 SymX uses AVX2 to speedup computations in several locations, such as evaluation and linear system solves.
-If your system does not support it (e.g. Apple Silicon) use `SYMX_ENABLE_AVX2=OFF` in CMake to disable such code paths.
+`SYMX_ENABLE_AVX2` accepts `AUTO` (default), `ON`, or `OFF`.
+`AUTO` enables AVX2 on x86/x86_64/AMD64 and disables it everywhere else (e.g. Apple Silicon).
+Override explicitly with `-DSYMX_ENABLE_AVX2=ON` or `-DSYMX_ENABLE_AVX2=OFF`.
 
-If you try to compile SymX as-is, without support for AVX2 you will get something like:
+If you try to compile on a non-AVX2 system with `ON`, you will get something like:
 
 ```bash
 ../immintrin.h:14 error "This header is only meant to be used on x86 and x64 architecture"

.gitignore

@@ -383,7 +383,7 @@ <h3>Compilation <code class="docutils literal notranslate"><span class="pre">FLO
 </pre></div>
 </div>
 <p>Note that you will need to set values of type <code class="docutils literal notranslate"><span class="pre">FLOAT</span></code> and that the result will be returned as <code class="docutils literal notranslate"><span class="pre">View&lt;FLOAT&gt;</span></code>.
-If your system does not support these SIMD types, set SymX’s the CMake flag <code class="docutils literal notranslate"><span class="pre">SYMX_ENABLE_AVX2</span></code> to <code class="docutils literal notranslate"><span class="pre">OFF</span></code>.</p>
+If your system does not support these SIMD types, disable them with <code class="docutils literal notranslate"><span class="pre">-DSYMX_ENABLE_AVX2=OFF</span></code> (the default <code class="docutils literal notranslate"><span class="pre">AUTO</span></code> already does this on non-x86 targets).</p>
 </section>
 <section id="parallel-evaluation">
 <h3>Parallel evaluation<a class="headerlink" href="#parallel-evaluation" title="Link to this heading">¶</a></h3>

_sources/compilation.md.txt

@@ -323,8 +323,8 @@ <h2>CMake options<a class="headerlink" href="#cmake-options" title="Link to this
 </thead>
 <tbody>
 <tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">SYMX_ENABLE_AVX2</span></code></p></td>
-<td><p><code class="docutils literal notranslate"><span class="pre">ON</span></code></p></td>
-<td><p>Enable AVX2 + FMA SIMD paths</p></td>
+<td><p><code class="docutils literal notranslate"><span class="pre">AUTO</span></code></p></td>
+<td><p>Enable AVX2 + FMA SIMD paths (<code class="docutils literal notranslate"><span class="pre">AUTO</span></code> / <code class="docutils literal notranslate"><span class="pre">ON</span></code> / <code class="docutils literal notranslate"><span class="pre">OFF</span></code>); <code class="docutils literal notranslate"><span class="pre">AUTO</span></code> enables on x86/x86_64/AMD64</p></td>
 </tr>
 <tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">SYMX_COMPILER_PATH</span></code></p></td>
 <td><p><code class="docutils literal notranslate"><span class="pre">AUTO</span></code></p></td>
@@ -344,8 +344,10 @@ <h2>CMake options<a class="headerlink" href="#cmake-options" title="Link to this
 <section id="avx2-support">
 <h3>AVX2 support<a class="headerlink" href="#avx2-support" title="Link to this heading">¶</a></h3>
 <p>SymX uses AVX2 to speedup computations in several locations, such as evaluation and linear system solves.
-If your system does not support it (e.g. Apple Silicon) use <code class="docutils literal notranslate"><span class="pre">SYMX_ENABLE_AVX2=OFF</span></code> in CMake to disable such code paths.</p>
-<p>If you try to compile SymX as-is, without support for AVX2 you will get something like:</p>
+<code class="docutils literal notranslate"><span class="pre">SYMX_ENABLE_AVX2</span></code> accepts <code class="docutils literal notranslate"><span class="pre">AUTO</span></code> (default), <code class="docutils literal notranslate"><span class="pre">ON</span></code>, or <code class="docutils literal notranslate"><span class="pre">OFF</span></code>.
+<code class="docutils literal notranslate"><span class="pre">AUTO</span></code> enables AVX2 on x86/x86_64/AMD64 and disables it everywhere else (e.g. Apple Silicon).
+Override explicitly with <code class="docutils literal notranslate"><span class="pre">-DSYMX_ENABLE_AVX2=ON</span></code> or <code class="docutils literal notranslate"><span class="pre">-DSYMX_ENABLE_AVX2=OFF</span></code>.</p>
+<p>If you try to compile on a non-AVX2 system with <code class="docutils literal notranslate"><span class="pre">ON</span></code>, you will get something like:</p>
 <div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>../immintrin.h:14<span class="w"> </span>error<span class="w"> </span><span class="s2">&quot;This header is only meant to be used on x86 and x64 architecture&quot;</span>
 </pre></div>
 </div>