Deploying to gh-pages from @ 76e59b6 🚀

localcc · Nov 9, 2023 · 524e012 · 524e012
commit 524e012
Show file tree

Hide file tree

Showing 154 changed files with 29,503 additions and 0 deletions.
diff --git a/.buildinfo b/.buildinfo
@@ -0,0 +1,4 @@
+# Sphinx build info version 1
+# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
+config: 1c752622af49f691dbe19b5aa6ed9df5
+tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/.doctrees/api/classLightningScanner_1_1AlignedAllocator.doctree b/.doctrees/api/classLightningScanner_1_1AlignedAllocator.doctree
diff --git a/.doctrees/api/classLightningScanner_1_1ScanResult.doctree b/.doctrees/api/classLightningScanner_1_1ScanResult.doctree
diff --git a/.doctrees/api/classLightningScanner_1_1Scanner.doctree b/.doctrees/api/classLightningScanner_1_1Scanner.doctree
diff --git a/.doctrees/api/dir__home_runner_work_LightningScanner_LightningScanner_include.doctree b/.doctrees/api/dir__home_runner_work_LightningScanner_LightningScanner_include.doctree
diff --git a/.../dir__home_runner_work_LightningScanner_LightningScanner_include_LightningScanner.doctree b/.../dir__home_runner_work_LightningScanner_LightningScanner_include_LightningScanner.doctree
diff --git a/..._runner_work_LightningScanner_LightningScanner_include_LightningScanner_allocator.doctree b/..._runner_work_LightningScanner_LightningScanner_include_LightningScanner_allocator.doctree
diff --git a/...e_runner_work_LightningScanner_LightningScanner_include_LightningScanner_backends.doctree b/...e_runner_work_LightningScanner_LightningScanner_include_LightningScanner_backends.doctree
diff --git a/.doctrees/api/enum_ScanMode_8hpp_1af9e3bb003dab9b2cf00854a1eb3b01f0.doctree b/.doctrees/api/enum_ScanMode_8hpp_1af9e3bb003dab9b2cf00854a1eb3b01f0.doctree
diff --git a/...unner_work_LightningScanner_LightningScanner_include_LightningScanner_CpuInfo.hpp.doctree b/...unner_work_LightningScanner_LightningScanner_include_LightningScanner_CpuInfo.hpp.doctree
diff --git a/...k_LightningScanner_LightningScanner_include_LightningScanner_LightningScanner.hpp.doctree b/...k_LightningScanner_LightningScanner_include_LightningScanner_LightningScanner.hpp.doctree
diff --git a/...unner_work_LightningScanner_LightningScanner_include_LightningScanner_Pattern.hpp.doctree b/...unner_work_LightningScanner_LightningScanner_include_LightningScanner_Pattern.hpp.doctree
diff --git a/...nner_work_LightningScanner_LightningScanner_include_LightningScanner_ScanMode.hpp.doctree b/...nner_work_LightningScanner_LightningScanner_include_LightningScanner_ScanMode.hpp.doctree
diff --git a/...er_work_LightningScanner_LightningScanner_include_LightningScanner_ScanResult.hpp.doctree b/...er_work_LightningScanner_LightningScanner_include_LightningScanner_ScanResult.hpp.doctree
diff --git a/...gScanner_LightningScanner_include_LightningScanner_allocator_AlignedAllocator.hpp.doctree b/...gScanner_LightningScanner_include_LightningScanner_allocator_AlignedAllocator.hpp.doctree
diff --git a/...work_LightningScanner_LightningScanner_include_LightningScanner_backends_Avx2.hpp.doctree b/...work_LightningScanner_LightningScanner_include_LightningScanner_backends_Avx2.hpp.doctree
diff --git a/...rk_LightningScanner_LightningScanner_include_LightningScanner_backends_Scalar.hpp.doctree b/...rk_LightningScanner_LightningScanner_include_LightningScanner_backends_Scalar.hpp.doctree
diff --git a/...ork_LightningScanner_LightningScanner_include_LightningScanner_backends_Sse42.hpp.doctree b/...ork_LightningScanner_LightningScanner_include_LightningScanner_backends_Sse42.hpp.doctree
diff --git a/.doctrees/api/function_Avx2_8hpp_1adefc7e7e854d228955b8ee844d1d8d6f.doctree b/.doctrees/api/function_Avx2_8hpp_1adefc7e7e854d228955b8ee844d1d8d6f.doctree
diff --git a/.doctrees/api/function_Scalar_8hpp_1a369c2061275480d50ec15632cfc5e193.doctree b/.doctrees/api/function_Scalar_8hpp_1a369c2061275480d50ec15632cfc5e193.doctree
diff --git a/.doctrees/api/function_Sse42_8hpp_1ad1108528070d7402171ae16362cdcd3c.doctree b/.doctrees/api/function_Sse42_8hpp_1ad1108528070d7402171ae16362cdcd3c.doctree
diff --git a/.doctrees/api/library_root.doctree b/.doctrees/api/library_root.doctree
diff --git a/.doctrees/api/namespace_LightningScanner.doctree b/.doctrees/api/namespace_LightningScanner.doctree
diff --git a/...unner_work_LightningScanner_LightningScanner_include_LightningScanner_CpuInfo.hpp.doctree b/...unner_work_LightningScanner_LightningScanner_include_LightningScanner_CpuInfo.hpp.doctree
diff --git a/...k_LightningScanner_LightningScanner_include_LightningScanner_LightningScanner.hpp.doctree b/...k_LightningScanner_LightningScanner_include_LightningScanner_LightningScanner.hpp.doctree
diff --git a/...unner_work_LightningScanner_LightningScanner_include_LightningScanner_Pattern.hpp.doctree b/...unner_work_LightningScanner_LightningScanner_include_LightningScanner_Pattern.hpp.doctree
diff --git a/...nner_work_LightningScanner_LightningScanner_include_LightningScanner_ScanMode.hpp.doctree b/...nner_work_LightningScanner_LightningScanner_include_LightningScanner_ScanMode.hpp.doctree
diff --git a/...er_work_LightningScanner_LightningScanner_include_LightningScanner_ScanResult.hpp.doctree b/...er_work_LightningScanner_LightningScanner_include_LightningScanner_ScanResult.hpp.doctree
diff --git a/...gScanner_LightningScanner_include_LightningScanner_allocator_AlignedAllocator.hpp.doctree b/...gScanner_LightningScanner_include_LightningScanner_allocator_AlignedAllocator.hpp.doctree
diff --git a/...work_LightningScanner_LightningScanner_include_LightningScanner_backends_Avx2.hpp.doctree b/...work_LightningScanner_LightningScanner_include_LightningScanner_backends_Avx2.hpp.doctree
diff --git a/...rk_LightningScanner_LightningScanner_include_LightningScanner_backends_Scalar.hpp.doctree b/...rk_LightningScanner_LightningScanner_include_LightningScanner_backends_Scalar.hpp.doctree
diff --git a/...ork_LightningScanner_LightningScanner_include_LightningScanner_backends_Sse42.hpp.doctree b/...ork_LightningScanner_LightningScanner_include_LightningScanner_backends_Sse42.hpp.doctree
diff --git a/.doctrees/api/structLightningScanner_1_1AlignedAllocator_1_1rebind.doctree b/.doctrees/api/structLightningScanner_1_1AlignedAllocator_1_1rebind.doctree
diff --git a/.doctrees/api/structLightningScanner_1_1CpuInfo.doctree b/.doctrees/api/structLightningScanner_1_1CpuInfo.doctree
diff --git a/.doctrees/api/structLightningScanner_1_1Pattern.doctree b/.doctrees/api/structLightningScanner_1_1Pattern.doctree
diff --git a/.doctrees/api/unabridged_orphan.doctree b/.doctrees/api/unabridged_orphan.doctree
diff --git a/.doctrees/environment.pickle b/.doctrees/environment.pickle
diff --git a/.doctrees/gettingstarted.doctree b/.doctrees/gettingstarted.doctree
diff --git a/.doctrees/index.doctree b/.doctrees/index.doctree
diff --git a/.nojekyll b/.nojekyll
diff --git a/_sources/api/classLightningScanner_1_1AlignedAllocator.rst.txt b/_sources/api/classLightningScanner_1_1AlignedAllocator.rst.txt
@@ -0,0 +1,27 @@
+.. _exhale_class_classLightningScanner_1_1AlignedAllocator:
+
+Template Class AlignedAllocator
+===============================
+
+- Defined in :ref:`file__home_runner_work_LightningScanner_LightningScanner_include_LightningScanner_allocator_AlignedAllocator.hpp`
+
+
+Nested Relationships
+--------------------
+
+
+Nested Types
+************
+
+- :ref:`exhale_struct_structLightningScanner_1_1AlignedAllocator_1_1rebind`
+
+
+Class Documentation
+-------------------
+
+
+.. doxygenclass:: LightningScanner::AlignedAllocator
+   :project: LightningScanner
+   :members:
+   :undoc-members:
+   :private-members:
diff --git a/_sources/api/classLightningScanner_1_1ScanResult.rst.txt b/_sources/api/classLightningScanner_1_1ScanResult.rst.txt
@@ -0,0 +1,17 @@
+.. _exhale_class_classLightningScanner_1_1ScanResult:
+
+Class ScanResult
+================
+
+- Defined in :ref:`file__home_runner_work_LightningScanner_LightningScanner_include_LightningScanner_ScanResult.hpp`
+
+
+Class Documentation
+-------------------
+
+
+.. doxygenclass:: LightningScanner::ScanResult
+   :project: LightningScanner
+   :members:
+   :undoc-members:
+   :private-members:
diff --git a/_sources/api/classLightningScanner_1_1Scanner.rst.txt b/_sources/api/classLightningScanner_1_1Scanner.rst.txt
@@ -0,0 +1,17 @@
+.. _exhale_class_classLightningScanner_1_1Scanner:
+
+Template Class Scanner
+======================
+
+- Defined in :ref:`file__home_runner_work_LightningScanner_LightningScanner_include_LightningScanner_LightningScanner.hpp`
+
+
+Class Documentation
+-------------------
+
+
+.. doxygenclass:: LightningScanner::Scanner
+   :project: LightningScanner
+   :members:
+   :undoc-members:
+   :private-members:
diff --git a/...ces/api/dir__home_runner_work_LightningScanner_LightningScanner_include.rst.txt b/...ces/api/dir__home_runner_work_LightningScanner_LightningScanner_include.rst.txt
@@ -0,0 +1,16 @@
+.. _dir__home_runner_work_LightningScanner_LightningScanner_include:
+
+
+Directory include
+=================
+
+
+*Directory path:* ``/home/runner/work/LightningScanner/LightningScanner/include``
+
+Subdirectories
+--------------
+
+- :ref:`dir__home_runner_work_LightningScanner_LightningScanner_include_LightningScanner`
+
+
+
diff --git a/..._runner_work_LightningScanner_LightningScanner_include_LightningScanner.rst.txt b/..._runner_work_LightningScanner_LightningScanner_include_LightningScanner.rst.txt
@@ -0,0 +1,31 @@
+.. _dir__home_runner_work_LightningScanner_LightningScanner_include_LightningScanner:
+
+
+Directory LightningScanner
+==========================
+
+
+|exhale_lsh| :ref:`Parent directory <dir__home_runner_work_LightningScanner_LightningScanner_include>` (``/home/runner/work/LightningScanner/LightningScanner/include``)
+
+.. |exhale_lsh| unicode:: U+021B0 .. UPWARDS ARROW WITH TIP LEFTWARDS
+
+
+*Directory path:* ``/home/runner/work/LightningScanner/LightningScanner/include/LightningScanner``
+
+Subdirectories
+--------------
+
+- :ref:`dir__home_runner_work_LightningScanner_LightningScanner_include_LightningScanner_allocator`
+- :ref:`dir__home_runner_work_LightningScanner_LightningScanner_include_LightningScanner_backends`
+
+
+Files
+-----
+
+- :ref:`file__home_runner_work_LightningScanner_LightningScanner_include_LightningScanner_CpuInfo.hpp`
+- :ref:`file__home_runner_work_LightningScanner_LightningScanner_include_LightningScanner_LightningScanner.hpp`
+- :ref:`file__home_runner_work_LightningScanner_LightningScanner_include_LightningScanner_Pattern.hpp`
+- :ref:`file__home_runner_work_LightningScanner_LightningScanner_include_LightningScanner_ScanMode.hpp`
+- :ref:`file__home_runner_work_LightningScanner_LightningScanner_include_LightningScanner_ScanResult.hpp`
+
+
diff --git a/...rk_LightningScanner_LightningScanner_include_LightningScanner_allocator.rst.txt b/...rk_LightningScanner_LightningScanner_include_LightningScanner_allocator.rst.txt
@@ -0,0 +1,21 @@
+.. _dir__home_runner_work_LightningScanner_LightningScanner_include_LightningScanner_allocator:
+
+
+Directory allocator
+===================
+
+
+|exhale_lsh| :ref:`Parent directory <dir__home_runner_work_LightningScanner_LightningScanner_include_LightningScanner>` (``/home/runner/work/LightningScanner/LightningScanner/include/LightningScanner``)
+
+.. |exhale_lsh| unicode:: U+021B0 .. UPWARDS ARROW WITH TIP LEFTWARDS
+
+
+*Directory path:* ``/home/runner/work/LightningScanner/LightningScanner/include/LightningScanner/allocator``
+
+
+Files
+-----
+
+- :ref:`file__home_runner_work_LightningScanner_LightningScanner_include_LightningScanner_allocator_AlignedAllocator.hpp`
+
+
diff --git a/...ork_LightningScanner_LightningScanner_include_LightningScanner_backends.rst.txt b/...ork_LightningScanner_LightningScanner_include_LightningScanner_backends.rst.txt
@@ -0,0 +1,23 @@
+.. _dir__home_runner_work_LightningScanner_LightningScanner_include_LightningScanner_backends:
+
+
+Directory backends
+==================
+
+
+|exhale_lsh| :ref:`Parent directory <dir__home_runner_work_LightningScanner_LightningScanner_include_LightningScanner>` (``/home/runner/work/LightningScanner/LightningScanner/include/LightningScanner``)
+
+.. |exhale_lsh| unicode:: U+021B0 .. UPWARDS ARROW WITH TIP LEFTWARDS
+
+
+*Directory path:* ``/home/runner/work/LightningScanner/LightningScanner/include/LightningScanner/backends``
+
+
+Files
+-----
+
+- :ref:`file__home_runner_work_LightningScanner_LightningScanner_include_LightningScanner_backends_Avx2.hpp`
+- :ref:`file__home_runner_work_LightningScanner_LightningScanner_include_LightningScanner_backends_Scalar.hpp`
+- :ref:`file__home_runner_work_LightningScanner_LightningScanner_include_LightningScanner_backends_Sse42.hpp`
+
+
diff --git a/_sources/api/enum_ScanMode_8hpp_1af9e3bb003dab9b2cf00854a1eb3b01f0.rst.txt b/_sources/api/enum_ScanMode_8hpp_1af9e3bb003dab9b2cf00854a1eb3b01f0.rst.txt
@@ -0,0 +1,14 @@
+.. _exhale_enum_ScanMode_8hpp_1af9e3bb003dab9b2cf00854a1eb3b01f0:
+
+Enum ScanMode
+=============
+
+- Defined in :ref:`file__home_runner_work_LightningScanner_LightningScanner_include_LightningScanner_ScanMode.hpp`
+
+
+Enum Documentation
+------------------
+
+
+.. doxygenenum:: ScanMode
+   :project: LightningScanner
diff --git a/..._LightningScanner_LightningScanner_include_LightningScanner_CpuInfo.hpp.rst.txt b/..._LightningScanner_LightningScanner_include_LightningScanner_CpuInfo.hpp.rst.txt
@@ -0,0 +1,47 @@
+
+.. _file__home_runner_work_LightningScanner_LightningScanner_include_LightningScanner_CpuInfo.hpp:
+
+File CpuInfo.hpp
+================
+
+|exhale_lsh| :ref:`Parent directory <dir__home_runner_work_LightningScanner_LightningScanner_include_LightningScanner>` (``/home/runner/work/LightningScanner/LightningScanner/include/LightningScanner``)
+
+.. |exhale_lsh| unicode:: U+021B0 .. UPWARDS ARROW WITH TIP LEFTWARDS
+
+Definition (``/home/runner/work/LightningScanner/LightningScanner/include/LightningScanner/CpuInfo.hpp``)
+---------------------------------------------------------------------------------------------------------
+
+
+.. toctree::
+   :maxdepth: 1
+
+   program_listing_file__home_runner_work_LightningScanner_LightningScanner_include_LightningScanner_CpuInfo.hpp.rst
+
+
+
+
+
+
+
+Included By
+-----------
+
+
+- :ref:`file__home_runner_work_LightningScanner_LightningScanner_include_LightningScanner_LightningScanner.hpp`
+
+
+
+
+Namespaces
+----------
+
+
+- :ref:`namespace_LightningScanner`
+
+
+Classes
+-------
+
+
+- :ref:`exhale_struct_structLightningScanner_1_1CpuInfo`
+
diff --git a/...gScanner_LightningScanner_include_LightningScanner_LightningScanner.hpp.rst.txt b/...gScanner_LightningScanner_include_LightningScanner_LightningScanner.hpp.rst.txt
@@ -0,0 +1,63 @@
+
+.. _file__home_runner_work_LightningScanner_LightningScanner_include_LightningScanner_LightningScanner.hpp:
+
+File LightningScanner.hpp
+=========================
+
+|exhale_lsh| :ref:`Parent directory <dir__home_runner_work_LightningScanner_LightningScanner_include_LightningScanner>` (``/home/runner/work/LightningScanner/LightningScanner/include/LightningScanner``)
+
+.. |exhale_lsh| unicode:: U+021B0 .. UPWARDS ARROW WITH TIP LEFTWARDS
+
+Definition (``/home/runner/work/LightningScanner/LightningScanner/include/LightningScanner/LightningScanner.hpp``)
+------------------------------------------------------------------------------------------------------------------
+
+
+.. toctree::
+   :maxdepth: 1
+
+   program_listing_file__home_runner_work_LightningScanner_LightningScanner_include_LightningScanner_LightningScanner.hpp.rst
+
+
+
+
+
+Includes
+--------
+
+
+- ``LightningScanner/CpuInfo.hpp`` (:ref:`file__home_runner_work_LightningScanner_LightningScanner_include_LightningScanner_CpuInfo.hpp`)
+
+- ``LightningScanner/Pattern.hpp`` (:ref:`file__home_runner_work_LightningScanner_LightningScanner_include_LightningScanner_Pattern.hpp`)
+
+- ``LightningScanner/ScanMode.hpp`` (:ref:`file__home_runner_work_LightningScanner_LightningScanner_include_LightningScanner_ScanMode.hpp`)
+
+- ``LightningScanner/ScanResult.hpp`` (:ref:`file__home_runner_work_LightningScanner_LightningScanner_include_LightningScanner_ScanResult.hpp`)
+
+- ``LightningScanner/backends/Avx2.hpp`` (:ref:`file__home_runner_work_LightningScanner_LightningScanner_include_LightningScanner_backends_Avx2.hpp`)
+
+- ``LightningScanner/backends/Scalar.hpp`` (:ref:`file__home_runner_work_LightningScanner_LightningScanner_include_LightningScanner_backends_Scalar.hpp`)
+
+- ``LightningScanner/backends/Sse42.hpp`` (:ref:`file__home_runner_work_LightningScanner_LightningScanner_include_LightningScanner_backends_Sse42.hpp`)
+
+- ``cstdint``
+
+- ``vector``
+
+
+
+
+
+
+Namespaces
+----------
+
+
+- :ref:`namespace_LightningScanner`
+
+
+Classes
+-------
+
+
+- :ref:`exhale_class_classLightningScanner_1_1Scanner`
+
diff --git a/..._LightningScanner_LightningScanner_include_LightningScanner_Pattern.hpp.rst.txt b/..._LightningScanner_LightningScanner_include_LightningScanner_Pattern.hpp.rst.txt
@@ -0,0 +1,67 @@
+
+.. _file__home_runner_work_LightningScanner_LightningScanner_include_LightningScanner_Pattern.hpp:
+
+File Pattern.hpp
+================
+
+|exhale_lsh| :ref:`Parent directory <dir__home_runner_work_LightningScanner_LightningScanner_include_LightningScanner>` (``/home/runner/work/LightningScanner/LightningScanner/include/LightningScanner``)
+
+.. |exhale_lsh| unicode:: U+021B0 .. UPWARDS ARROW WITH TIP LEFTWARDS
+
+Definition (``/home/runner/work/LightningScanner/LightningScanner/include/LightningScanner/Pattern.hpp``)
+---------------------------------------------------------------------------------------------------------
+
+
+.. toctree::
+   :maxdepth: 1
+
+   program_listing_file__home_runner_work_LightningScanner_LightningScanner_include_LightningScanner_Pattern.hpp.rst
+
+
+
+
+
+Includes
+--------
+
+
+- ``LightningScanner/allocator/AlignedAllocator.hpp`` (:ref:`file__home_runner_work_LightningScanner_LightningScanner_include_LightningScanner_allocator_AlignedAllocator.hpp`)
+
+- ``cmath``
+
+- ``cstdint``
+
+- ``string_view``
+
+- ``vector``
+
+
+
+Included By
+-----------
+
+
+- :ref:`file__home_runner_work_LightningScanner_LightningScanner_include_LightningScanner_backends_Avx2.hpp`
+
+- :ref:`file__home_runner_work_LightningScanner_LightningScanner_include_LightningScanner_backends_Scalar.hpp`
+
+- :ref:`file__home_runner_work_LightningScanner_LightningScanner_include_LightningScanner_backends_Sse42.hpp`
+
+- :ref:`file__home_runner_work_LightningScanner_LightningScanner_include_LightningScanner_LightningScanner.hpp`
+
+
+
+
+Namespaces
+----------
+
+
+- :ref:`namespace_LightningScanner`
+
+
+Classes
+-------
+
+
+- :ref:`exhale_struct_structLightningScanner_1_1Pattern`
+