Sphinx rebuild (648e8cf).

facebookresearch · Apr 24, 2024 · b383622 · b383622
1 parent 648e8cf
commit b383622
Show file tree

Hide file tree

Showing 7 changed files with 45 additions and 5 deletions.
diff --git a/docs/cpp_api/file/Level2-inl_8h.html b/docs/cpp_api/file/Level2-inl_8h.html
@@ -348,7 +348,15 @@ <h1>File Level2-inl.h<a class="headerlink" href="#file-level2-inl-h" title="Perm
 <dl class="cpp type">
 <dt class="sig sig-object cpp" id="_CPPv4N5faiss10cppcontribE">
 <span id="_CPPv3N5faiss10cppcontribE"></span><span id="_CPPv2N5faiss10cppcontribE"></span><span id="faiss::cppcontrib"></span><span class="target" id="namespacefaiss_1_1cppcontrib"></span><span class="k"><span class="pre">namespace</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">cppcontrib</span></span></span><br /></dt>
-<dd><dl class="cpp struct">
+<dd><div class="breathe-sectiondef docutils container">
+<p class="breathe-sectiondef-title rubric" id="breathe-section-title-functions">Functions</p>
+<dl class="cpp function">
+<dt class="sig sig-object cpp" id="_CPPv4N5faiss10cppcontrib11isBigEndianEv">
+<span id="_CPPv3N5faiss10cppcontrib11isBigEndianEv"></span><span id="_CPPv2N5faiss10cppcontrib11isBigEndianEv"></span><span id="faiss::cppcontrib::isBigEndian"></span><span class="target" id="Level2-inl_8h_1ae4e8b14ff45f25eb929a6d6b3cbd3c39"></span><span class="kt"><span class="pre">bool</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">isBigEndian</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5faiss10cppcontrib11isBigEndianEv" title="Permalink to this definition"></a><br /></dt>
+<dd></dd></dl>
+
+</div>
+<dl class="cpp struct">
 <dt class="sig sig-object cpp" id="_CPPv4I_8intptr_t_8intptr_t_8intptr_t_8intptr_t_8intptr_tEN5faiss10cppcontrib18Index2LevelDecoderE">
 <span id="_CPPv3I_8intptr_t_8intptr_t_8intptr_t_8intptr_t_8intptr_tEN5faiss10cppcontrib18Index2LevelDecoderE"></span><span id="_CPPv2I_8intptr_t_8intptr_t_8intptr_t_8intptr_t_8intptr_tEN5faiss10cppcontrib18Index2LevelDecoderE"></span><span class="k"><span class="pre">template</span></span><span class="p"><span class="pre">&lt;</span></span><span class="n"><span class="pre">intptr_t</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">DIM</span></span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="n"><span class="pre">intptr_t</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">COARSE_SIZE</span></span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="n"><span class="pre">intptr_t</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">FINE_SIZE</span></span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="n"><span class="pre">intptr_t</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">COARSE_BITS</span></span></span><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="m"><span class="pre">8</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="n"><span class="pre">intptr_t</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">FINE_BITS</span></span></span><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="m"><span class="pre">8</span></span><span class="p"><span class="pre">&gt;</span></span><br /><span class="target" id="structfaiss_1_1cppcontrib_1_1Index2LevelDecoder"></span><span class="k"><span class="pre">struct</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">Index2LevelDecoder</span></span></span><br /></dt>
 <dd><div class="docutils container">

diff --git a/docs/cpp_api/file/platform__macros_8h.html b/docs/cpp_api/file/platform__macros_8h.html
@@ -360,6 +360,16 @@ <h1>File platform_macros.h<a class="headerlink" href="#file-platform-macros-h" t
 <span class="target" id="platform__macros_8h_1a67c757ea9f8ddbedbacd421c993b5582"></span><span class="sig-name descname"><span class="n"><span class="pre">FAISS_PRAGMA_IMPRECISE_FUNCTION_END</span></span></span><a class="headerlink" href="#c.FAISS_PRAGMA_IMPRECISE_FUNCTION_END" title="Permalink to this definition"></a><br /></dt>
 <dd></dd></dl>
 
+<dl class="cpp macro">
+<dt class="sig sig-object cpp" id="c.Swap2Bytes">
+<span class="target" id="platform__macros_8h_1a1cecf34df3997353b021628410b9ef3e"></span><span class="sig-name descname"><span class="n"><span class="pre">Swap2Bytes</span></span></span><span class="sig-paren">(</span><span class="n"><span class="pre">val</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.Swap2Bytes" title="Permalink to this definition"></a><br /></dt>
+<dd></dd></dl>
+
+<dl class="cpp macro">
+<dt class="sig sig-object cpp" id="c.Swap4Bytes">
+<span class="target" id="platform__macros_8h_1a09e79c0144214aac268e716674e71474"></span><span class="sig-name descname"><span class="n"><span class="pre">Swap4Bytes</span></span></span><span class="sig-paren">(</span><span class="n"><span class="pre">val</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.Swap4Bytes" title="Permalink to this definition"></a><br /></dt>
+<dd></dd></dl>
+
 </div>
 </section>
 

diff --git a/docs/cpp_api/namespace/namespacefaiss.html b/docs/cpp_api/namespace/namespacefaiss.html
@@ -55371,7 +55371,15 @@ <h1>Namespace faiss<a class="headerlink" href="#namespace-faiss" title="Permalin
 <dl class="cpp type">
 <dt class="sig sig-object cpp" id="_CPPv4N5faiss10cppcontribE">
 <span id="_CPPv3N5faiss10cppcontribE"></span><span id="_CPPv2N5faiss10cppcontribE"></span><span id="faiss::cppcontrib"></span><span class="target" id="namespacefaiss_1_1cppcontrib"></span><span class="k"><span class="pre">namespace</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">cppcontrib</span></span></span><br /></dt>
-<dd><dl class="cpp struct">
+<dd><div class="breathe-sectiondef docutils container">
+<p class="breathe-sectiondef-title rubric" id="breathe-section-title-functions">Functions</p>
+<dl class="cpp function">
+<dt class="sig sig-object cpp" id="_CPPv4N5faiss10cppcontrib11isBigEndianEv">
+<span id="_CPPv3N5faiss10cppcontrib11isBigEndianEv"></span><span id="_CPPv2N5faiss10cppcontrib11isBigEndianEv"></span><span id="faiss::cppcontrib::isBigEndian"></span><span class="target" id="Level2-inl_8h_1ae4e8b14ff45f25eb929a6d6b3cbd3c39"></span><span class="kt"><span class="pre">bool</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">isBigEndian</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><br /></dt>
+<dd></dd></dl>
+
+</div>
+<dl class="cpp struct">
 <dt class="sig sig-object cpp" id="_CPPv4I_8intptr_t_8intptr_t_8intptr_t_8intptr_t_8intptr_tEN5faiss10cppcontrib18Index2LevelDecoderE">
 <span id="_CPPv3I_8intptr_t_8intptr_t_8intptr_t_8intptr_t_8intptr_tEN5faiss10cppcontrib18Index2LevelDecoderE"></span><span id="_CPPv2I_8intptr_t_8intptr_t_8intptr_t_8intptr_t_8intptr_tEN5faiss10cppcontrib18Index2LevelDecoderE"></span><span class="k"><span class="pre">template</span></span><span class="p"><span class="pre">&lt;</span></span><span class="n"><span class="pre">intptr_t</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">DIM</span></span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="n"><span class="pre">intptr_t</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">COARSE_SIZE</span></span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="n"><span class="pre">intptr_t</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">FINE_SIZE</span></span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="n"><span class="pre">intptr_t</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">COARSE_BITS</span></span></span><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="m"><span class="pre">8</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="n"><span class="pre">intptr_t</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">FINE_BITS</span></span></span><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="m"><span class="pre">8</span></span><span class="p"><span class="pre">&gt;</span></span><br /><span class="target" id="structfaiss_1_1cppcontrib_1_1Index2LevelDecoder"></span><span class="k"><span class="pre">struct</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">Index2LevelDecoder</span></span></span><br /></dt>
 <dd><div class="docutils container">

diff --git a/docs/cpp_api/namespace/namespacefaiss_1_1cppcontrib.html b/docs/cpp_api/namespace/namespacefaiss_1_1cppcontrib.html
@@ -116,7 +116,15 @@ <h1>Namespace faiss::cppcontrib<a class="headerlink" href="#namespace-faiss-cppc
 <dl class="cpp type">
 <dt class="sig sig-object cpp" id="_CPPv4N5faiss10cppcontribE">
 <span id="_CPPv3N5faiss10cppcontribE"></span><span id="_CPPv2N5faiss10cppcontribE"></span><span id="faiss::cppcontrib"></span><span class="target" id="namespacefaiss_1_1cppcontrib"></span><span class="k"><span class="pre">namespace</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">cppcontrib</span></span></span><br /></dt>
-<dd><dl class="cpp struct">
+<dd><div class="breathe-sectiondef docutils container">
+<p class="breathe-sectiondef-title rubric" id="breathe-section-title-functions">Functions</p>
+<dl class="cpp function">
+<dt class="sig sig-object cpp" id="_CPPv4N5faiss10cppcontrib11isBigEndianEv">
+<span id="_CPPv3N5faiss10cppcontrib11isBigEndianEv"></span><span id="_CPPv2N5faiss10cppcontrib11isBigEndianEv"></span><span id="faiss::cppcontrib::isBigEndian"></span><span class="target" id="Level2-inl_8h_1ae4e8b14ff45f25eb929a6d6b3cbd3c39"></span><span class="kt"><span class="pre">bool</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">isBigEndian</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><br /></dt>
+<dd></dd></dl>
+
+</div>
+<dl class="cpp struct">
 <dt class="sig sig-object cpp" id="_CPPv4I_8intptr_t_8intptr_t_8intptr_t_8intptr_t_8intptr_tEN5faiss10cppcontrib18Index2LevelDecoderE">
 <span id="_CPPv3I_8intptr_t_8intptr_t_8intptr_t_8intptr_t_8intptr_tEN5faiss10cppcontrib18Index2LevelDecoderE"></span><span id="_CPPv2I_8intptr_t_8intptr_t_8intptr_t_8intptr_t_8intptr_tEN5faiss10cppcontrib18Index2LevelDecoderE"></span><span class="k"><span class="pre">template</span></span><span class="p"><span class="pre">&lt;</span></span><span class="n"><span class="pre">intptr_t</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">DIM</span></span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="n"><span class="pre">intptr_t</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">COARSE_SIZE</span></span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="n"><span class="pre">intptr_t</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">FINE_SIZE</span></span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="n"><span class="pre">intptr_t</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">COARSE_BITS</span></span></span><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="m"><span class="pre">8</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="n"><span class="pre">intptr_t</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">FINE_BITS</span></span></span><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="m"><span class="pre">8</span></span><span class="p"><span class="pre">&gt;</span></span><br /><span class="target" id="structfaiss_1_1cppcontrib_1_1Index2LevelDecoder"></span><span class="k"><span class="pre">struct</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">Index2LevelDecoder</span></span></span><br /></dt>
 <dd><div class="docutils container">

diff --git a/docs/genindex.html b/docs/genindex.html
@@ -1101,6 +1101,8 @@ <h2 id="F">F</h2>
       <li><a href="cpp_api/file/PQ-avx2-inl_8h.html#_CPPv4N5faiss10cppcontrib14IndexPQDecoder8fineBitsE">faiss::cppcontrib::IndexPQDecoder::fineBits (C++ member)</a>, <a href="cpp_api/namespace/namespacefaiss.html#_CPPv4N5faiss10cppcontrib14IndexPQDecoder8fineBitsE">[1]</a>, <a href="cpp_api/namespace/namespacefaiss_1_1cppcontrib.html#_CPPv4N5faiss10cppcontrib14IndexPQDecoder8fineBitsE">[2]</a>, <a href="cpp_api/struct/structfaiss_1_1cppcontrib_1_1IndexPQDecoder.html#_CPPv4N5faiss10cppcontrib14IndexPQDecoder8fineBitsE">[3]</a>
 </li>
       <li><a href="cpp_api/file/PQ-avx2-inl_8h.html#_CPPv4N5faiss10cppcontrib14IndexPQDecoder8fineSizeE">faiss::cppcontrib::IndexPQDecoder::fineSize (C++ member)</a>, <a href="cpp_api/namespace/namespacefaiss.html#_CPPv4N5faiss10cppcontrib14IndexPQDecoder8fineSizeE">[1]</a>, <a href="cpp_api/namespace/namespacefaiss_1_1cppcontrib.html#_CPPv4N5faiss10cppcontrib14IndexPQDecoder8fineSizeE">[2]</a>, <a href="cpp_api/struct/structfaiss_1_1cppcontrib_1_1IndexPQDecoder.html#_CPPv4N5faiss10cppcontrib14IndexPQDecoder8fineSizeE">[3]</a>
+</li>
+      <li><a href="cpp_api/file/Level2-inl_8h.html#_CPPv4N5faiss10cppcontrib11isBigEndianEv">faiss::cppcontrib::isBigEndian (C++ function)</a>, <a href="cpp_api/namespace/namespacefaiss.html#_CPPv4N5faiss10cppcontrib11isBigEndianEv">[1]</a>, <a href="cpp_api/namespace/namespacefaiss_1_1cppcontrib.html#_CPPv4N5faiss10cppcontrib11isBigEndianEv">[2]</a>
 </li>
       <li><a href="cpp_api/file/hamming_8h.html#_CPPv4N5faiss24crosshamming_count_thresEPK7uint8_t6size_t8hamdis_t6size_tP6size_t">faiss::crosshamming_count_thres (C++ function)</a>, <a href="cpp_api/namespace/namespacefaiss.html#_CPPv4N5faiss24crosshamming_count_thresEPK7uint8_t6size_t8hamdis_t6size_tP6size_t">[1]</a>
 </li>
@@ -16295,10 +16297,14 @@ <h2 id="S">S</h2>
 <table style="width: 100%" class="indextable genindextable"><tr>
   <td style="width: 33%; vertical-align: top;"><ul>
       <li><a href="cpp_api/file/hamdis-inl_8h.html#c.SPECIALIZED_HC">SPECIALIZED_HC (C macro)</a>
+</li>
+      <li><a href="cpp_api/namespace/namespacestd.html#_CPPv4St">std (C++ type)</a>
 </li>
   </ul></td>
   <td style="width: 33%; vertical-align: top;"><ul>
-      <li><a href="cpp_api/namespace/namespacestd.html#_CPPv4St">std (C++ type)</a>
+      <li><a href="cpp_api/file/platform__macros_8h.html#c.Swap2Bytes">Swap2Bytes (C macro)</a>
+</li>
+      <li><a href="cpp_api/file/platform__macros_8h.html#c.Swap4Bytes">Swap4Bytes (C macro)</a>
 </li>
   </ul></td>
 </tr></table>

diff --git a/docs/objects.inv b/docs/objects.inv
diff --git a/docs/searchindex.js b/docs/searchindex.js