deploy: f576511

MeasureTransport · Feb 1, 2024 · 6fb7056 · 6fb7056
1 parent c2dfbc6
commit 6fb7056
Show file tree

Hide file tree

Showing 6 changed files with 58 additions and 6 deletions.
diff --git a/.doctrees/environment.pickle b/.doctrees/environment.pickle
diff --git a/.doctrees/source/api/utilities/linearalgebra.doctree b/.doctrees/source/api/utilities/linearalgebra.doctree
diff --git a/genindex.html b/genindex.html
@@ -772,14 +772,14 @@ <h2 id="M">M</h2>
 </li>
       <li><a href="source/api/multiindices/multiindex.html#_CPPv4NK5mpart10MultiIndex6VectorEv">mpart::MultiIndex::Vector (C++ function)</a>
 </li>
-  </ul></td>
-  <td style="width: 33%; vertical-align: top;"><ul>
       <li><a href="source/api/multiindices/multiindexlimiter.html#_CPPv4N5mpart17MultiIndexLimiterE">mpart::MultiIndexLimiter (C++ type)</a>
 </li>
       <li><a href="source/api/multiindices/multiindexlimiter.html#_CPPv4N5mpart17MultiIndexLimiter3AndE">mpart::MultiIndexLimiter::And (C++ class)</a>
 </li>
       <li><a href="source/api/multiindices/multiindexlimiter.html#_CPPv4N5mpart17MultiIndexLimiter11AnisotropicE">mpart::MultiIndexLimiter::Anisotropic (C++ class)</a>
 </li>
+  </ul></td>
+  <td style="width: 33%; vertical-align: top;"><ul>
       <li><a href="source/api/multiindices/multiindexlimiter.html#_CPPv4N5mpart17MultiIndexLimiter9DimensionE">mpart::MultiIndexLimiter::Dimension (C++ class)</a>
 </li>
       <li><a href="source/api/multiindices/multiindexlimiter.html#_CPPv4N5mpart17MultiIndexLimiter9MaxDegreeE">mpart::MultiIndexLimiter::MaxDegree (C++ class)</a>
@@ -981,6 +981,18 @@ <h2 id="M">M</h2>
       <li><a href="source/api/parameterizedfunctionbase.html#_CPPv4N5mpart25ParameterizedFunctionBase10WrapCoeffsEN5Eigen3RefIN5Eigen8VectorXdEEE">mpart::ParameterizedFunctionBase::WrapCoeffs (C++ function)</a>, <a href="source/api/parameterizedfunctionbase.html#_CPPv4N5mpart25ParameterizedFunctionBase10WrapCoeffsEN6Kokkos4ViewIPdN6Kokkos9HostSpaceEEE">[1]</a>
 </li>
       <li><a href="source/api/parameterizedfunctionbase.html#_CPPv4N5mpart25ParameterizedFunctionBaseD0Ev">mpart::ParameterizedFunctionBase::~ParameterizedFunctionBase (C++ function)</a>
+</li>
+      <li><a href="source/api/utilities/linearalgebra.html#_CPPv4I0EN5mpart12PartialPivLUE">mpart::PartialPivLU (C++ class)</a>
+</li>
+      <li><a href="source/api/utilities/linearalgebra.html#_CPPv4N5mpart12PartialPivLU7computeEN6Kokkos4ViewIPPKdN6Kokkos10LayoutLeftE11MemorySpaceEE">mpart::PartialPivLU::compute (C++ function)</a>
+</li>
+      <li><a href="source/api/utilities/linearalgebra.html#_CPPv4NK5mpart12PartialPivLU11determinantEv">mpart::PartialPivLU::determinant (C++ function)</a>
+</li>
+      <li><a href="source/api/utilities/linearalgebra.html#_CPPv4N5mpart12PartialPivLU12PartialPivLUEN6Kokkos4ViewIPPKdN6Kokkos10LayoutLeftE11MemorySpaceEE">mpart::PartialPivLU::PartialPivLU (C++ function)</a>, <a href="source/api/utilities/linearalgebra.html#_CPPv4N5mpart12PartialPivLU12PartialPivLUEv">[1]</a>
+</li>
+      <li><a href="source/api/utilities/linearalgebra.html#_CPPv4N5mpart12PartialPivLU5solveE13StridedMatrixIKd11MemorySpaceE">mpart::PartialPivLU::solve (C++ function)</a>
+</li>
+      <li><a href="source/api/utilities/linearalgebra.html#_CPPv4N5mpart12PartialPivLU12solveInPlaceEN6Kokkos4ViewIPPdN6Kokkos10LayoutLeftE11MemorySpaceEE">mpart::PartialPivLU::solveInPlace (C++ function)</a>
 </li>
       <li><a href="source/api/mapfactory.html#_CPPv4N5mpart12PosFuncTypesE">mpart::PosFuncTypes (C++ enum)</a>
 </li>

diff --git a/objects.inv b/objects.inv
diff --git a/searchindex.js b/searchindex.js
diff --git a/source/api/utilities/linearalgebra.html b/source/api/utilities/linearalgebra.html
@@ -731,10 +731,50 @@ <h2>LU Factorization and Solve<a class="headerlink" href="#lu-factorization-and-
 </section>
 <section id="classes-and-functions">
 <h2>Classes and Functions<a class="headerlink" href="#classes-and-functions" title="Permalink to this heading">#</a></h2>
-<div class="admonition warning">
-<p class="admonition-title">Warning</p>
-<p>doxygenclass: Cannot find class “mpart::PartialPivLU” in doxygen xml output for project “mpart” from directory: /home/runner/work/MParT/MParT/build/docs/doxygen/xml</p>
+<dl class="cpp class">
+<dt class="sig sig-object cpp" id="_CPPv4I0EN5mpart12PartialPivLUE">
+<span class="k"><span class="pre">template</span></span><span class="p"><span class="pre">&lt;</span></span><span class="k"><span class="pre">typename</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">MemorySpace</span></span></span><span class="p"><span class="pre">&gt;</span></span><br /><span class="target" id="classmpart_1_1_partial_piv_l_u"></span><span class="k"><span class="pre">class</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">PartialPivLU</span></span></span><a class="headerlink" href="#_CPPv4I0EN5mpart12PartialPivLUE" title="Permalink to this definition">#</a><br /></dt>
+<dd><p>Mimics the interface of the Eigen::PartialPivLU class, but using Kokkos::Views and CUBLAS/CUSOLVER linear algebra.</p>
+<p>Note that the layout of the matrices used in this class is important. Cublas expects column major (layout left). </p>
+<div class="breathe-sectiondef docutils container">
+<p class="breathe-sectiondef-title rubric" id="breathe-section-title-public-functions">Public Functions</p>
+<dl class="cpp function">
+<dt class="sig sig-object cpp" id="_CPPv4N5mpart12PartialPivLU12PartialPivLUEv">
+<span class="target" id="classmpart_1_1_partial_piv_l_u_1aef996d7b2c52c88abbc502ed1d424c78"></span><span class="k"><span class="pre">inline</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">PartialPivLU</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5mpart12PartialPivLU12PartialPivLUEv" title="Permalink to this definition">#</a><br /></dt>
+<dd></dd></dl>
+
+<dl class="cpp function">
+<dt class="sig sig-object cpp" id="_CPPv4N5mpart12PartialPivLU12PartialPivLUEN6Kokkos4ViewIPPKdN6Kokkos10LayoutLeftE11MemorySpaceEE">
+<span class="target" id="classmpart_1_1_partial_piv_l_u_1a0c6f96d34cee518bfab291dda2069900"></span><span class="k"><span class="pre">inline</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">PartialPivLU</span></span></span><span class="sig-paren">(</span><span class="n"><span class="pre">Kokkos</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">View</span></span><span class="p"><span class="pre">&lt;</span></span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="kt"><span class="pre">double</span></span><span class="p"><span class="pre">*</span></span><span class="p"><span class="pre">*</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="n"><span class="pre">Kokkos</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">LayoutLeft</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><a class="reference internal" href="#_CPPv4I0EN5mpart12PartialPivLUE" title="mpart::PartialPivLU::MemorySpace"><span class="n"><span class="pre">MemorySpace</span></span></a><span class="p"><span class="pre">&gt;</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">A</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5mpart12PartialPivLU12PartialPivLUEN6Kokkos4ViewIPPKdN6Kokkos10LayoutLeftE11MemorySpaceEE" title="Permalink to this definition">#</a><br /></dt>
+<dd></dd></dl>
+
+<dl class="cpp function">
+<dt class="sig sig-object cpp" id="_CPPv4N5mpart12PartialPivLU7computeEN6Kokkos4ViewIPPKdN6Kokkos10LayoutLeftE11MemorySpaceEE">
+<span class="target" id="classmpart_1_1_partial_piv_l_u_1aa67227fb586706184bf27b339d89d3b5"></span><span class="kt"><span class="pre">void</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">compute</span></span></span><span class="sig-paren">(</span><span class="n"><span class="pre">Kokkos</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">View</span></span><span class="p"><span class="pre">&lt;</span></span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="kt"><span class="pre">double</span></span><span class="p"><span class="pre">*</span></span><span class="p"><span class="pre">*</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="n"><span class="pre">Kokkos</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">LayoutLeft</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><a class="reference internal" href="#_CPPv4I0EN5mpart12PartialPivLUE" title="mpart::PartialPivLU::MemorySpace"><span class="n"><span class="pre">MemorySpace</span></span></a><span class="p"><span class="pre">&gt;</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">A</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5mpart12PartialPivLU7computeEN6Kokkos4ViewIPPKdN6Kokkos10LayoutLeftE11MemorySpaceEE" title="Permalink to this definition">#</a><br /></dt>
+<dd><p>Computes the LU factorization of a matrix A </p>
+</dd></dl>
+
+<dl class="cpp function">
+<dt class="sig sig-object cpp" id="_CPPv4N5mpart12PartialPivLU12solveInPlaceEN6Kokkos4ViewIPPdN6Kokkos10LayoutLeftE11MemorySpaceEE">
+<span class="target" id="classmpart_1_1_partial_piv_l_u_1a2590c35b55e897ffb633b7c19fb117c6"></span><span class="kt"><span class="pre">void</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">solveInPlace</span></span></span><span class="sig-paren">(</span><span class="n"><span class="pre">Kokkos</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">View</span></span><span class="p"><span class="pre">&lt;</span></span><span class="kt"><span class="pre">double</span></span><span class="p"><span class="pre">*</span></span><span class="p"><span class="pre">*</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="n"><span class="pre">Kokkos</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">LayoutLeft</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><a class="reference internal" href="#_CPPv4I0EN5mpart12PartialPivLUE" title="mpart::PartialPivLU::MemorySpace"><span class="n"><span class="pre">MemorySpace</span></span></a><span class="p"><span class="pre">&gt;</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">x</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5mpart12PartialPivLU12solveInPlaceEN6Kokkos4ViewIPPdN6Kokkos10LayoutLeftE11MemorySpaceEE" title="Permalink to this definition">#</a><br /></dt>
+<dd><p>Computes A^{-1}x and stores the results in x. </p>
+</dd></dl>
+
+<dl class="cpp function">
+<dt class="sig sig-object cpp" id="_CPPv4N5mpart12PartialPivLU5solveE13StridedMatrixIKd11MemorySpaceE">
+<span class="target" id="classmpart_1_1_partial_piv_l_u_1a298e1164a5dc2910f767d7a800d8b6cc"></span><span class="n"><span class="pre">Kokkos</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">View</span></span><span class="p"><span class="pre">&lt;</span></span><span class="kt"><span class="pre">double</span></span><span class="p"><span class="pre">*</span></span><span class="p"><span class="pre">*</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="n"><span class="pre">Kokkos</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">LayoutLeft</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><a class="reference internal" href="#_CPPv4I0EN5mpart12PartialPivLUE" title="mpart::PartialPivLU::MemorySpace"><span class="n"><span class="pre">MemorySpace</span></span></a><span class="p"><span class="pre">&gt;</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">solve</span></span></span><span class="sig-paren">(</span><span class="n"><span class="pre">StridedMatrix</span></span><span class="p"><span class="pre">&lt;</span></span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="kt"><span class="pre">double</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><a class="reference internal" href="#_CPPv4I0EN5mpart12PartialPivLUE" title="mpart::PartialPivLU::MemorySpace"><span class="n"><span class="pre">MemorySpace</span></span></a><span class="p"><span class="pre">&gt;</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">x</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5mpart12PartialPivLU5solveE13StridedMatrixIKd11MemorySpaceE" title="Permalink to this definition">#</a><br /></dt>
+<dd><p>Returns a view containing A^{-1}x. </p>
+</dd></dl>
+
+<dl class="cpp function">
+<dt class="sig sig-object cpp" id="_CPPv4NK5mpart12PartialPivLU11determinantEv">
+<span class="target" id="classmpart_1_1_partial_piv_l_u_1af8cc4ba130d37095bd147e0a2636071e"></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">determinant</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><span class="w"> </span><span class="k"><span class="pre">const</span></span><a class="headerlink" href="#_CPPv4NK5mpart12PartialPivLU11determinantEv" title="Permalink to this definition">#</a><br /></dt>
+<dd><p>Returns the determinant of the matrix A based on its LU factorization. </p>
+</dd></dl>
+
 </div>
+</dd></dl>
+
 <dl class="cpp struct">
 <dt class="sig sig-object cpp" id="_CPPv4I0EN5mpart15TransposeObjectE">
 <span class="k"><span class="pre">template</span></span><span class="p"><span class="pre">&lt;</span></span><span class="k"><span class="pre">typename</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">MemorySpace</span></span></span><span class="p"><span class="pre">&gt;</span></span><br /><span class="target" id="structmpart_1_1_transpose_object"></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">TransposeObject</span></span></span><a class="headerlink" href="#_CPPv4I0EN5mpart15TransposeObjectE" title="Permalink to this definition">#</a><br /></dt>