Sphinx rebuild (3a29d71).

facebookresearch · Jul 22, 2024 · e887a80 · e887a80
1 parent 3a29d71
commit e887a80
Show file tree

Hide file tree

Showing 6 changed files with 43 additions and 3 deletions.
diff --git a/docs/cpp_api/file/Index_8h.html b/docs/cpp_api/file/Index_8h.html
@@ -340,6 +340,21 @@ <h1>File Index.h<a class="headerlink" href="#file-index-h" title="Permalink to t
 <span class="target" id="Index_8h_1abaa30cb4993a34c8e9b3b5057529613a"></span><span class="sig-name descname"><span class="n"><span class="pre">FAISS_VERSION_PATCH</span></span></span><a class="headerlink" href="#c.FAISS_VERSION_PATCH" title="Permalink to this definition"></a><br /></dt>
 <dd></dd></dl>
 
+<dl class="cpp macro">
+<dt class="sig sig-object cpp" id="c.FAISS_STRINGIFY">
+<span class="target" id="Index_8h_1a224ce263210941bfad72a6393dddc717"></span><span class="sig-name descname"><span class="n"><span class="pre">FAISS_STRINGIFY</span></span></span><span class="sig-paren">(</span><span class="n"><span class="pre">ARG</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.FAISS_STRINGIFY" title="Permalink to this definition"></a><br /></dt>
+<dd></dd></dl>
+
+<dl class="cpp macro">
+<dt class="sig sig-object cpp" id="c.FAISS_TOSTRING">
+<span class="target" id="Index_8h_1a1adf987d3a209a2b288b0828a31ccb0c"></span><span class="sig-name descname"><span class="n"><span class="pre">FAISS_TOSTRING</span></span></span><span class="sig-paren">(</span><span class="n"><span class="pre">ARG</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.FAISS_TOSTRING" title="Permalink to this definition"></a><br /></dt>
+<dd></dd></dl>
+
+<dl class="cpp macro">
+<dt class="sig sig-object cpp" id="c.VERSION_STRING">
+<span class="target" id="Index_8h_1a698acb89e1bf5837b33c30ef35c30044"></span><span class="sig-name descname"><span class="n"><span class="pre">VERSION_STRING</span></span></span><a class="headerlink" href="#c.VERSION_STRING" title="Permalink to this definition"></a><br /></dt>
+<dd></dd></dl>
+
 </div>
 <dl class="cpp type">
 <dt class="sig sig-object cpp" id="_CPPv45faiss">

diff --git a/docs/cpp_api/file/utils_8h.html b/docs/cpp_api/file/utils_8h.html
@@ -360,6 +360,11 @@ <h1>File utils.h<a class="headerlink" href="#file-utils-h" title="Permalink to t
 <dd><p>get compile options </p>
 </dd></dl>
 
+<dl class="cpp function">
+<dt class="sig sig-object cpp" id="_CPPv4N5faiss11get_versionEv">
+<span id="_CPPv3N5faiss11get_versionEv"></span><span id="_CPPv2N5faiss11get_versionEv"></span><span id="faiss::get_version"></span><span class="target" id="namespacefaiss_1a7492814a6d7dd80de1e5a375758534b5"></span><a class="reference internal" href="../namespace/namespacestd.html#_CPPv4St" title="std"><span class="n"><span class="pre">std</span></span></a><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">string</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">get_version</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5faiss11get_versionEv" title="Permalink to this definition"></a><br /></dt>
+<dd></dd></dl>
+
 <dl class="cpp function">
 <dt class="sig sig-object cpp" id="_CPPv4N5faiss12getmillisecsEv">
 <span id="_CPPv3N5faiss12getmillisecsEv"></span><span id="_CPPv2N5faiss12getmillisecsEv"></span><span id="faiss::getmillisecs"></span><span class="target" id="namespacefaiss_1af2a71f7d5402ae02ce169a4cc83020eb"></span><span class="kt"><span class="pre">double</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">getmillisecs</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5faiss12getmillisecsEv" title="Permalink to this definition"></a><br /></dt>

diff --git a/docs/cpp_api/namespace/namespacefaiss.html b/docs/cpp_api/namespace/namespacefaiss.html
@@ -1929,6 +1929,11 @@ <h1>Namespace faiss<a class="headerlink" href="#namespace-faiss" title="Permalin
 <dd><p>get compile options </p>
 </dd></dl>
 
+<dl class="cpp function">
+<dt class="sig sig-object cpp" id="_CPPv4N5faiss11get_versionEv">
+<span id="_CPPv3N5faiss11get_versionEv"></span><span id="_CPPv2N5faiss11get_versionEv"></span><span id="faiss::get_version"></span><span class="target" id="namespacefaiss_1a7492814a6d7dd80de1e5a375758534b5"></span><a class="reference internal" href="namespacestd.html#_CPPv4St" title="std"><span class="n"><span class="pre">std</span></span></a><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">string</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">get_version</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><br /></dt>
+<dd></dd></dl>
+
 <dl class="cpp function">
 <dt class="sig sig-object cpp" id="_CPPv4N5faiss12getmillisecsEv">
 <span id="_CPPv3N5faiss12getmillisecsEv"></span><span id="_CPPv2N5faiss12getmillisecsEv"></span><span id="faiss::getmillisecs"></span><span class="target" id="namespacefaiss_1af2a71f7d5402ae02ce169a4cc83020eb"></span><span class="kt"><span class="pre">double</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">getmillisecs</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><br /></dt>

diff --git a/docs/genindex.html b/docs/genindex.html
@@ -94,6 +94,7 @@ <h1 id="index">Index</h1>
  | <a href="#P"><strong>P</strong></a>
  | <a href="#R"><strong>R</strong></a>
  | <a href="#S"><strong>S</strong></a>
+ | <a href="#V"><strong>V</strong></a>
  | <a href="#W"><strong>W</strong></a>
 
 </div>
@@ -1521,6 +1522,8 @@ <h2 id="F">F</h2>
       <li><a href="cpp_api/file/utils_8h.html#_CPPv4N5faiss16get_mem_usage_kbEv">faiss::get_mem_usage_kb (C++ function)</a>, <a href="cpp_api/namespace/namespacefaiss.html#_CPPv4N5faiss16get_mem_usage_kbEv">[1]</a>
 </li>
       <li><a href="cpp_api/file/simdlib__avx2_8h.html#_CPPv4N5faiss8get_MSBsE11simd32uint8">faiss::get_MSBs (C++ function)</a>, <a href="cpp_api/file/simdlib__emulated_8h.html#_CPPv4N5faiss8get_MSBsERK11simd32uint8">[1]</a>, <a href="cpp_api/namespace/namespacefaiss.html#_CPPv4N5faiss8get_MSBsE11simd32uint8">[2]</a>, <a href="cpp_api/namespace/namespacefaiss.html#_CPPv4N5faiss8get_MSBsERK11simd32uint8">[3]</a>
+</li>
+      <li><a href="cpp_api/file/utils_8h.html#_CPPv4N5faiss11get_versionEv">faiss::get_version (C++ function)</a>, <a href="cpp_api/namespace/namespacefaiss.html#_CPPv4N5faiss11get_versionEv">[1]</a>
 </li>
       <li><a href="cpp_api/file/utils_8h.html#_CPPv4N5faiss12getmillisecsEv">faiss::getmillisecs (C++ function)</a>, <a href="cpp_api/namespace/namespacefaiss.html#_CPPv4N5faiss12getmillisecsEv">[1]</a>
 </li>
@@ -8520,10 +8523,10 @@ <h2 id="F">F</h2>
 </li>
       <li><a href="cpp_api/namespace/namespacefaiss.html#_CPPv4N5faiss32IndexIVFProductResidualQuantizer5resetEv">faiss::IndexIVFProductResidualQuantizer::reset (C++ function)</a>, <a href="cpp_api/struct/structfaiss_1_1IndexIVFProductResidualQuantizer.html#_CPPv4N5faiss32IndexIVFProductResidualQuantizer5resetEv">[1]</a>
 </li>
-  </ul></td>
-  <td style="width: 33%; vertical-align: top;"><ul>
       <li><a href="cpp_api/namespace/namespacefaiss.html#_CPPv4NK5faiss32IndexIVFProductResidualQuantizer12sa_code_sizeEv">faiss::IndexIVFProductResidualQuantizer::sa_code_size (C++ function)</a>, <a href="cpp_api/struct/structfaiss_1_1IndexIVFProductResidualQuantizer.html#_CPPv4NK5faiss32IndexIVFProductResidualQuantizer12sa_code_sizeEv">[1]</a>
 </li>
+  </ul></td>
+  <td style="width: 33%; vertical-align: top;"><ul>
       <li><a href="cpp_api/file/IndexIVFAdditiveQuantizer_8h.html#_CPPv4NK5faiss32IndexIVFProductResidualQuantizer9sa_decodeE5idx_tPK7uint8_tPf">faiss::IndexIVFProductResidualQuantizer::sa_decode (C++ function)</a>, <a href="cpp_api/namespace/namespacefaiss.html#_CPPv4NK5faiss32IndexIVFProductResidualQuantizer9sa_decodeE5idx_tPK7uint8_tPf">[1]</a>, <a href="cpp_api/struct/structfaiss_1_1IndexIVFProductResidualQuantizer.html#_CPPv4NK5faiss32IndexIVFProductResidualQuantizer9sa_decodeE5idx_tPK7uint8_tPf">[2]</a>
 </li>
       <li><a href="cpp_api/namespace/namespacefaiss.html#_CPPv4NK5faiss32IndexIVFProductResidualQuantizer9sa_encodeE5idx_tPKfP7uint8_t">faiss::IndexIVFProductResidualQuantizer::sa_encode (C++ function)</a>, <a href="cpp_api/struct/structfaiss_1_1IndexIVFProductResidualQuantizer.html#_CPPv4NK5faiss32IndexIVFProductResidualQuantizer9sa_encodeE5idx_tPKfP7uint8_t">[1]</a>
@@ -16861,6 +16864,8 @@ <h2 id="F">F</h2>
       <li><a href="cpp_api/file/platform__macros_8h.html#c.FAISS_PRAGMA_IMPRECISE_FUNCTION_END">FAISS_PRAGMA_IMPRECISE_FUNCTION_END (C macro)</a>
 </li>
       <li><a href="cpp_api/file/platform__macros_8h.html#c.FAISS_PRAGMA_IMPRECISE_LOOP">FAISS_PRAGMA_IMPRECISE_LOOP (C macro)</a>
+</li>
+      <li><a href="cpp_api/file/Index_8h.html#c.FAISS_STRINGIFY">FAISS_STRINGIFY (C macro)</a>
 </li>
       <li><a href="cpp_api/file/FaissAssert_8h.html#c.FAISS_THROW_FMT">FAISS_THROW_FMT (C macro)</a>
 </li>
@@ -16873,6 +16878,8 @@ <h2 id="F">F</h2>
       <li><a href="cpp_api/file/FaissAssert_8h.html#c.FAISS_THROW_IF_NOT_MSG">FAISS_THROW_IF_NOT_MSG (C macro)</a>
 </li>
       <li><a href="cpp_api/file/FaissAssert_8h.html#c.FAISS_THROW_MSG">FAISS_THROW_MSG (C macro)</a>
+</li>
+      <li><a href="cpp_api/file/Index_8h.html#c.FAISS_TOSTRING">FAISS_TOSTRING (C macro)</a>
 </li>
       <li><a href="cpp_api/file/Index_8h.html#c.FAISS_VERSION_MAJOR">FAISS_VERSION_MAJOR (C macro)</a>
 </li>
@@ -16997,6 +17004,14 @@ <h2 id="S">S</h2>
   </ul></td>
 </tr></table>
 
+<h2 id="V">V</h2>
+<table style="width: 100%" class="indextable genindextable"><tr>
+  <td style="width: 33%; vertical-align: top;"><ul>
+      <li><a href="cpp_api/file/Index_8h.html#c.VERSION_STRING">VERSION_STRING (C macro)</a>
+</li>
+  </ul></td>
+</tr></table>
+
 <h2 id="W">W</h2>
 <table style="width: 100%" class="indextable genindextable"><tr>
   <td style="width: 33%; vertical-align: top;"><ul>

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