ListBackend

<p>Backend implementation using in-memory list storage.
This wraps the existing list-based storage mechanism for backwards compatibility.</p>

Implements various Riemannian metrics for symmetric positive definite matrices, including AIRM (Affine Invariant Riemannian Metric, <doi:10.1007/s11263-005-3222-z>), Log-Euclidean (<doi:10.1002/mrm.20965>), Euclidean, Log-Cholesky (<doi:10.1137/18M1221084>), and Bures-Wasserstein metrics (<doi:10.1016/j.exmath.2018.01.002>). Provides functions for computing logarithmic and exponential maps, vectorization, and statistical operations on the manifold of positive definite matrices.

Nicolas Escobar

riemtan

Riemannian Metrics for Symmetric Positive Definite Matrices

Jaroslaw Harezlak

ListBackend function

<p><code>riemtan::DataBackend</code> -&gt; <code>ListBackend</code></p>

Super class


<div class="section" id="public-methods">
<h3>Public methods</h3><p></p><p><ul>
<li><p><a href="/link/ListBackend%24new()?package=riemtan&version=0.2.5" data-mini-rdoc="riemtan::ListBackend$new()"><code>ListBackend$new()</code></a></p></li>
<li><p><a href="/link/ListBackend%24get_matrix()?package=riemtan&version=0.2.5" data-mini-rdoc="riemtan::ListBackend$get_matrix()"><code>ListBackend$get_matrix()</code></a></p></li>
<li><p><a href="/link/ListBackend%24get_all_matrices()?package=riemtan&version=0.2.5" data-mini-rdoc="riemtan::ListBackend$get_all_matrices()"><code>ListBackend$get_all_matrices()</code></a></p></li>
<li><p><a href="/link/ListBackend%24length()?package=riemtan&version=0.2.5" data-mini-rdoc="riemtan::ListBackend$length()"><code>ListBackend$length()</code></a></p></li>
<li><p><a href="/link/ListBackend%24get_dimensions()?package=riemtan&version=0.2.5" data-mini-rdoc="riemtan::ListBackend$get_dimensions()"><code>ListBackend$get_dimensions()</code></a></p></li>
<li><p><a href="/link/ListBackend%24clone()?package=riemtan&version=0.2.5" data-mini-rdoc="riemtan::ListBackend$clone()"><code>ListBackend$clone()</code></a></p></li>
</ul></p><p></p></div><p><hr>
<a id="method-ListBackend-new"></a></p><div class="section" id="method-new-">
<h3>Method <code>new()</code></h3>
<p>Initialize a ListBackend</p><div class="section" id="usage">
<h4>Usage</h4>
<p><div class="r"></div></p><pre><code>ListBackend$new(matrices)</code></pre><p></p></div><p></p>
</div><p></p><p><div class="section" id="arguments">
<h4>Arguments</h4>
<p><div class="arguments"></div></p><dl>
<dt><code>matrices</code></dt>
<dd><p>A list of dppMatrix objects</p></dd></dl></div></p><p>
</p><p></p>
<p></p><p></p><p><hr>
<a id="method-ListBackend-get_matrix"></a></p><div class="section" id="method-get-matrix-">
<h3>Method <code>get_matrix()</code></h3>
<p>Get a specific matrix by index</p><div class="section" id="usage">
<h4>Usage</h4>
<p><div class="r"></div></p><pre><code>ListBackend$get_matrix(i)</code></pre><p></p></div><p></p>
</div><p></p><p><div class="section" id="arguments">
<h4>Arguments</h4>
<p><div class="arguments"></div></p><dl>
<dt><code>i</code></dt>
<dd><p>Integer index</p></dd></dl></div></p><p>
</p><p></p>

<div class="section" id="returns">
<h4>Returns</h4>
<p>A dppMatrix object</p>
</div><p></p><p></p><p><hr>
<a id="method-ListBackend-get_all_matrices"></a></p><div class="section" id="method-get-all-matrices-">
<h3>Method <code>get_all_matrices()</code></h3>
<p>Get all matrices</p><div class="section" id="usage">
<h4>Usage</h4>
<p><div class="r"></div></p><pre><code>ListBackend$get_all_matrices()</code></pre><p></p></div><p></p>
</div><p></p><p><div class="section" id="returns">
<h4>Returns</h4>
<p>A list of dppMatrix objects</p>
</div></p><p></p><p><hr>
<a id="method-ListBackend-length"></a></p><div class="section" id="method-length-">
<h3>Method <code><a href="/link/length()?package=riemtan&version=0.2.5" data-mini-rdoc="riemtan::length()">length()</a></code></h3>
<p>Get the number of matrices</p><div class="section" id="usage">
<h4>Usage</h4>
<p><div class="r"></div></p><pre><code>ListBackend$length()</code></pre><p></p></div><p></p>
</div><p></p><p><div class="section" id="returns">
<h4>Returns</h4>
<p>Integer count</p>
</div></p><p></p><p><hr>
<a id="method-ListBackend-get_dimensions"></a></p><div class="section" id="method-get-dimensions-">
<h3>Method <code>get_dimensions()</code></h3>
<p>Get matrix dimensions</p><div class="section" id="usage">
<h4>Usage</h4>
<p><div class="r"></div></p><pre><code>ListBackend$get_dimensions()</code></pre><p></p></div><p></p>
</div><p></p><p><div class="section" id="returns">
<h4>Returns</h4>
<p>Integer p (matrices are p x p)</p>
</div></p><p></p><p><hr>
<a id="method-ListBackend-clone"></a></p><div class="section" id="method-clone-">
<h3>Method <code>clone()</code></h3>
<p>The objects of this class are cloneable with this method.</p><div class="section" id="usage">
<h4>Usage</h4>
<p><div class="r"></div></p><pre><code>ListBackend$clone(deep = FALSE)</code></pre><p></p></div><p></p>
</div><p></p><p><div class="section" id="arguments">
<h4>Arguments</h4>
<p><div class="arguments"></div></p><dl>
<dt><code>deep</code></dt>
<dd><p>Whether to make a deep clone.</p></dd></dl></div></p><p>
</p><p></p>
<p></p><p>
</p>

Methods

ListBackend Class — ListBackend


<div class='section' id='public-methods'>
<h3>Public methods</h3>

<ul>
<li><p><a href='#method-ListBackend-new'><code>ListBackend$new()</code></a></p></li>
<li><p><a href='#method-ListBackend-get_matrix'><code>ListBackend$get_matrix()</code></a></p></li>
<li><p><a href='#method-ListBackend-get_all_matrices'><code>ListBackend$get_all_matrices()</code></a></p></li>
<li><p><a href='#method-ListBackend-length'><code>ListBackend$length()</code></a></p></li>
<li><p><a href='#method-ListBackend-get_dimensions'><code>ListBackend$get_dimensions()</code></a></p></li>
<li><p><a href='#method-ListBackend-clone'><code>ListBackend$clone()</code></a></p></li>
</ul>

</div><p><hr>
<a id="method-ListBackend-new"></a></p><div class='section' id='method-new-'>
<h3>Method <code>new()</code></h3>
<p>Initialize a ListBackend</p><div class='section' id='usage'>
<h4>Usage</h4>
<p><div class="r"></p><pre><code>ListBackend$new(matrices)</code></pre><p></div></p>
</div>

<div class='section' id='arguments'>
<h4>Arguments</h4>
<p><div class="arguments"></p><dl>
<dt><code>matrices</code></dt>
<dd><p>A list of dppMatrix objects</p></dd>


</dl><p></div></p>
</div>

</div><p><hr>
<a id="method-ListBackend-get_matrix"></a></p><div class='section' id='method-get-matrix-'>
<h3>Method <code>get_matrix()</code></h3>
<p>Get a specific matrix by index</p><div class='section' id='usage'>
<h4>Usage</h4>
<p><div class="r"></p><pre><code>ListBackend$get_matrix(i)</code></pre><p></div></p>
</div>

<div class='section' id='arguments'>
<h4>Arguments</h4>
<p><div class="arguments"></p><dl>
<dt><code>i</code></dt>
<dd><p>Integer index</p></dd>


</dl><p></div></p>
</div>
<div class='section' id='returns'>
<h4>Returns</h4>
<p>A dppMatrix object</p>
</div>

</div><p><hr>
<a id="method-ListBackend-get_all_matrices"></a></p><div class='section' id='method-get-all-matrices-'>
<h3>Method <code>get_all_matrices()</code></h3>
<p>Get all matrices</p><div class='section' id='usage'>
<h4>Usage</h4>
<p><div class="r"></p><pre><code>ListBackend$get_all_matrices()</code></pre><p></div></p>
</div>

<div class='section' id='returns'>
<h4>Returns</h4>
<p>A list of dppMatrix objects</p>
</div>

</div><p><hr>
<a id="method-ListBackend-length"></a></p><div class='section' id='method-length-'>
<h3>Method <code><a href='https://rdrr.io/r/base/length.html'>length()</a></code></h3>
<p>Get the number of matrices</p><div class='section' id='usage'>
<h4>Usage</h4>
<p><div class="r"></p><pre><code>ListBackend$length()</code></pre><p></div></p>
</div>

<div class='section' id='returns'>
<h4>Returns</h4>
<p>Integer count</p>
</div>

</div><p><hr>
<a id="method-ListBackend-get_dimensions"></a></p><div class='section' id='method-get-dimensions-'>
<h3>Method <code>get_dimensions()</code></h3>
<p>Get matrix dimensions</p><div class='section' id='usage'>
<h4>Usage</h4>
<p><div class="r"></p><pre><code>ListBackend$get_dimensions()</code></pre><p></div></p>
</div>

<div class='section' id='returns'>
<h4>Returns</h4>
<p>Integer p (matrices are p x p)</p>
</div>

</div><p><hr>
<a id="method-ListBackend-clone"></a></p><div class='section' id='method-clone-'>
<h3>Method <code>clone()</code></h3>
<p>The objects of this class are cloneable with this method.</p><div class='section' id='usage'>
<h4>Usage</h4>
<p><div class="r"></p><pre><code>ListBackend$clone(deep = FALSE)</code></pre><p></div></p>
</div>

<div class='section' id='arguments'>
<h4>Arguments</h4>
<p><div class="arguments"></p><dl>
<dt><code>deep</code></dt>
<dd><p>Whether to make a deep clone.</p></dd>


</dl><p></div></p>
</div>

</div>


ListBackend: ListBackend Class

Description

Arguments

Super class

Methods

Public methods

Method `new()`

Usage

Arguments

Method `get_matrix()`

Usage

Arguments

Returns

Method `get_all_matrices()`

Usage

Returns

Method `length()`

Usage

Returns

Method `get_dimensions()`

Usage

Returns

Method `clone()`

Usage

Arguments

Description

Arguments

Super class

Methods

Public methods

Method new()

Usage

Arguments

Method get_matrix()

Usage

Arguments

Returns

Method get_all_matrices()

Usage

Returns

Method length()

Usage

Returns

Method get_dimensions()

Usage

Returns

Method clone()

Usage

Arguments

Method `new()`

Method `get_matrix()`

Method `get_all_matrices()`

Method `length()`

Method `get_dimensions()`

Method `clone()`