DataBackend

<p>Abstract base class defining the interface for storage backends.
All backend implementations must inherit from this class and implement
the required methods.</p>

internal

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

DataBackend function


<div class="section" id="public-methods">
<h3>Public methods</h3><p></p><p><ul>
<li><p><a href="/link/DataBackend%24get_matrix()?package=riemtan&version=0.2.5" data-mini-rdoc="riemtan::DataBackend$get_matrix()"><code>DataBackend$get_matrix()</code></a></p></li>
<li><p><a href="/link/DataBackend%24get_all_matrices()?package=riemtan&version=0.2.5" data-mini-rdoc="riemtan::DataBackend$get_all_matrices()"><code>DataBackend$get_all_matrices()</code></a></p></li>
<li><p><a href="/link/DataBackend%24length()?package=riemtan&version=0.2.5" data-mini-rdoc="riemtan::DataBackend$length()"><code>DataBackend$length()</code></a></p></li>
<li><p><a href="/link/DataBackend%24get_dimensions()?package=riemtan&version=0.2.5" data-mini-rdoc="riemtan::DataBackend$get_dimensions()"><code>DataBackend$get_dimensions()</code></a></p></li>
<li><p><a href="/link/DataBackend%24clone()?package=riemtan&version=0.2.5" data-mini-rdoc="riemtan::DataBackend$clone()"><code>DataBackend$clone()</code></a></p></li>
</ul></p><p></p></div><p><hr>
<a id="method-DataBackend-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>DataBackend$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 of the matrix to retrieve</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-DataBackend-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>DataBackend$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-DataBackend-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>DataBackend$length()</code></pre><p></p></div><p></p>
</div><p></p><p><div class="section" id="returns">
<h4>Returns</h4>
<p>Integer count of matrices</p>
</div></p><p></p><p><hr>
<a id="method-DataBackend-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>DataBackend$get_dimensions()</code></pre><p></p></div><p></p>
</div><p></p><p><div class="section" id="returns">
<h4>Returns</h4>
<p>Integer dimension (p) where matrices are p x p</p>
</div></p><p></p><p><hr>
<a id="method-DataBackend-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>DataBackend$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

DataBackend Abstract Class — DataBackend


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

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

</div><p><hr>
<a id="method-DataBackend-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>DataBackend$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 of the matrix to retrieve</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-DataBackend-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>DataBackend$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-DataBackend-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>DataBackend$length()</code></pre><p></div></p>
</div>

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

</div><p><hr>
<a id="method-DataBackend-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>DataBackend$get_dimensions()</code></pre><p></div></p>
</div>

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

</div><p><hr>
<a id="method-DataBackend-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>DataBackend$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>


DataBackend: DataBackend Abstract Class

Description

Arguments

Methods

Public methods

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

Details

Description

Arguments

Methods

Public methods

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

Details

Method `get_matrix()`

Method `get_all_matrices()`

Method `length()`

Method `get_dimensions()`

Method `clone()`