Exponential

<p>Exponential distribution in OOP way. Based on AbstractDist</p>

Statistical distribution in OOP (Object Oriented Programming) way.
This package proposes a R6 class interface to classic statistical
distribution, and new distributions can be easily added with the
class AbstractDist. A useful point is the generic fit() method for
each class, which uses a maximum likelihood estimation to find the
parameters of a dataset, see, e.g. Hastie, T. and al (2009)
<isbn:978-0-387-84857-0>. Furthermore, the rv_histogram class
gives a non-parametric fit, with the same accessors that for the
classic distribution. Finally, three random generators useful to
build synthetic data are given: a multivariate normal generator, an
orthogonal matrix generator, and a symmetric positive definite
matrix generator, see Mezzadri, F. (2007)
<arXiv:math-ph/0609050>.

Yoann Robin

ROOPSD

R Object Oriented Programming for Statistical Distribution

Exponential function

<p><code>ROOPSD::AbstractDist</code> -&gt; <code>Exponential</code></p>

Super class

<p><div class="r6-active-bindings"></div></p><dl>
<dt><code>rate</code></dt>
<dd><p>[double] rate of the exponential law</p></dd><p></p><p>
<dt><code>params</code></dt>
<dd><p>[vector] params of the exponential law</p></dd></p><p>
</p></dl><p></p>

Active bindings


<div class="section" id="public-methods">
<h3>Public methods</h3><p></p><p><ul>
<li><p><a href="/link/Exponential%24new()?package=ROOPSD&version=0.3.9" data-mini-rdoc="ROOPSD::Exponential$new()"><code>Exponential$new()</code></a></p></li>
<li><p><a href="/link/Exponential%24clone()?package=ROOPSD&version=0.3.9" data-mini-rdoc="ROOPSD::Exponential$clone()"><code>Exponential$clone()</code></a></p></li>
</ul></p><p></p></div><p><details><summary>Inherited methods</summary>
<ul>
<li><span class="pkg-link" data-pkg="ROOPSD" data-topic="AbstractDist" data-id="cdf"><a href="/link/ROOPSD%3A%3AAbstractDist%24cdf()?package=ROOPSD&version=0.3.9" data-mini-rdoc="ROOPSD::ROOPSD::AbstractDist$cdf()"><code>ROOPSD::AbstractDist$cdf()</code></a></span></li>
<li><span class="pkg-link" data-pkg="ROOPSD" data-topic="AbstractDist" data-id="density"><a href="/link/ROOPSD%3A%3AAbstractDist%24density()?package=ROOPSD&version=0.3.9" data-mini-rdoc="ROOPSD::ROOPSD::AbstractDist$density()"><code>ROOPSD::AbstractDist$density()</code></a></span></li>
<li><span class="pkg-link" data-pkg="ROOPSD" data-topic="AbstractDist" data-id="diagnostic"><a href="/link/ROOPSD%3A%3AAbstractDist%24diagnostic()?package=ROOPSD&version=0.3.9" data-mini-rdoc="ROOPSD::ROOPSD::AbstractDist$diagnostic()"><code>ROOPSD::AbstractDist$diagnostic()</code></a></span></li>
<li><span class="pkg-link" data-pkg="ROOPSD" data-topic="AbstractDist" data-id="fit"><a href="/link/ROOPSD%3A%3AAbstractDist%24fit()?package=ROOPSD&version=0.3.9" data-mini-rdoc="ROOPSD::ROOPSD::AbstractDist$fit()"><code>ROOPSD::AbstractDist$fit()</code></a></span></li>
<li><span class="pkg-link" data-pkg="ROOPSD" data-topic="AbstractDist" data-id="icdf"><a href="/link/ROOPSD%3A%3AAbstractDist%24icdf()?package=ROOPSD&version=0.3.9" data-mini-rdoc="ROOPSD::ROOPSD::AbstractDist$icdf()"><code>ROOPSD::AbstractDist$icdf()</code></a></span></li>
<li><span class="pkg-link" data-pkg="ROOPSD" data-topic="AbstractDist" data-id="isf"><a href="/link/ROOPSD%3A%3AAbstractDist%24isf()?package=ROOPSD&version=0.3.9" data-mini-rdoc="ROOPSD::ROOPSD::AbstractDist$isf()"><code>ROOPSD::AbstractDist$isf()</code></a></span></li>
<li><span class="pkg-link" data-pkg="ROOPSD" data-topic="AbstractDist" data-id="logdensity"><a href="/link/ROOPSD%3A%3AAbstractDist%24logdensity()?package=ROOPSD&version=0.3.9" data-mini-rdoc="ROOPSD::ROOPSD::AbstractDist$logdensity()"><code>ROOPSD::AbstractDist$logdensity()</code></a></span></li>
<li><span class="pkg-link" data-pkg="ROOPSD" data-topic="AbstractDist" data-id="pdeltaCI"><a href="/link/ROOPSD%3A%3AAbstractDist%24pdeltaCI()?package=ROOPSD&version=0.3.9" data-mini-rdoc="ROOPSD::ROOPSD::AbstractDist$pdeltaCI()"><code>ROOPSD::AbstractDist$pdeltaCI()</code></a></span></li>
<li><span class="pkg-link" data-pkg="ROOPSD" data-topic="AbstractDist" data-id="qdeltaCI"><a href="/link/ROOPSD%3A%3AAbstractDist%24qdeltaCI()?package=ROOPSD&version=0.3.9" data-mini-rdoc="ROOPSD::ROOPSD::AbstractDist$qdeltaCI()"><code>ROOPSD::AbstractDist$qdeltaCI()</code></a></span></li>
<li><span class="pkg-link" data-pkg="ROOPSD" data-topic="AbstractDist" data-id="qgradient"><a href="/link/ROOPSD%3A%3AAbstractDist%24qgradient()?package=ROOPSD&version=0.3.9" data-mini-rdoc="ROOPSD::ROOPSD::AbstractDist$qgradient()"><code>ROOPSD::AbstractDist$qgradient()</code></a></span></li>
<li><span class="pkg-link" data-pkg="ROOPSD" data-topic="AbstractDist" data-id="rvs"><a href="/link/ROOPSD%3A%3AAbstractDist%24rvs()?package=ROOPSD&version=0.3.9" data-mini-rdoc="ROOPSD::ROOPSD::AbstractDist$rvs()"><code>ROOPSD::AbstractDist$rvs()</code></a></span></li>
<li><span class="pkg-link" data-pkg="ROOPSD" data-topic="AbstractDist" data-id="sf"><a href="/link/ROOPSD%3A%3AAbstractDist%24sf()?package=ROOPSD&version=0.3.9" data-mini-rdoc="ROOPSD::ROOPSD::AbstractDist$sf()"><code>ROOPSD::AbstractDist$sf()</code></a></span></li>
</ul>
</details></p><p><hr>
<a id="method-Exponential-new"></a></p><div class="section" id="method-new-">
<h3>Method <code>new()</code></h3>
<p>Create a new Exponential object.</p><div class="section" id="usage">
<h4>Usage</h4>
<p><div class="r"></div></p><pre><code>Exponential$new(rate = 1)</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>rate</code></dt>
<dd><p>[double] Rate of the exponential law</p></dd></dl></div></p><p>
</p><p></p>

<div class="section" id="returns">
<h4>Returns</h4>
<p>A new `Exponential` object.</p>
</div><p></p><p></p><p><hr>
<a id="method-Exponential-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>Exponential$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

Exponential — Exponential

<p><div class="r6-active-bindings"></p><dl>
<dt><code>rate</code></dt>
<dd><p>[double] rate of the exponential law</p></dd>


<dt><code>params</code></dt>
<dd><p>[vector] params of the exponential law</p></dd>


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


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

<ul>
<li><p><a href='#method-Exponential-new'><code>Exponential$new()</code></a></p></li>
<li><p><a href='#method-Exponential-clone'><code>Exponential$clone()</code></a></p></li>
</ul>

</div><p><details><summary>Inherited methods</summary>
<ul>
<li><span class="pkg-link" data-pkg="ROOPSD" data-topic="AbstractDist" data-id="cdf"><a href='../../ROOPSD/html/AbstractDist.html#method-AbstractDist-cdf'><code>ROOPSD::AbstractDist$cdf()</code></a></span></li>
<li><span class="pkg-link" data-pkg="ROOPSD" data-topic="AbstractDist" data-id="density"><a href='../../ROOPSD/html/AbstractDist.html#method-AbstractDist-density'><code>ROOPSD::AbstractDist$density()</code></a></span></li>
<li><span class="pkg-link" data-pkg="ROOPSD" data-topic="AbstractDist" data-id="diagnostic"><a href='../../ROOPSD/html/AbstractDist.html#method-AbstractDist-diagnostic'><code>ROOPSD::AbstractDist$diagnostic()</code></a></span></li>
<li><span class="pkg-link" data-pkg="ROOPSD" data-topic="AbstractDist" data-id="fit"><a href='../../ROOPSD/html/AbstractDist.html#method-AbstractDist-fit'><code>ROOPSD::AbstractDist$fit()</code></a></span></li>
<li><span class="pkg-link" data-pkg="ROOPSD" data-topic="AbstractDist" data-id="icdf"><a href='../../ROOPSD/html/AbstractDist.html#method-AbstractDist-icdf'><code>ROOPSD::AbstractDist$icdf()</code></a></span></li>
<li><span class="pkg-link" data-pkg="ROOPSD" data-topic="AbstractDist" data-id="isf"><a href='../../ROOPSD/html/AbstractDist.html#method-AbstractDist-isf'><code>ROOPSD::AbstractDist$isf()</code></a></span></li>
<li><span class="pkg-link" data-pkg="ROOPSD" data-topic="AbstractDist" data-id="logdensity"><a href='../../ROOPSD/html/AbstractDist.html#method-AbstractDist-logdensity'><code>ROOPSD::AbstractDist$logdensity()</code></a></span></li>
<li><span class="pkg-link" data-pkg="ROOPSD" data-topic="AbstractDist" data-id="pdeltaCI"><a href='../../ROOPSD/html/AbstractDist.html#method-AbstractDist-pdeltaCI'><code>ROOPSD::AbstractDist$pdeltaCI()</code></a></span></li>
<li><span class="pkg-link" data-pkg="ROOPSD" data-topic="AbstractDist" data-id="qdeltaCI"><a href='../../ROOPSD/html/AbstractDist.html#method-AbstractDist-qdeltaCI'><code>ROOPSD::AbstractDist$qdeltaCI()</code></a></span></li>
<li><span class="pkg-link" data-pkg="ROOPSD" data-topic="AbstractDist" data-id="qgradient"><a href='../../ROOPSD/html/AbstractDist.html#method-AbstractDist-qgradient'><code>ROOPSD::AbstractDist$qgradient()</code></a></span></li>
<li><span class="pkg-link" data-pkg="ROOPSD" data-topic="AbstractDist" data-id="rvs"><a href='../../ROOPSD/html/AbstractDist.html#method-AbstractDist-rvs'><code>ROOPSD::AbstractDist$rvs()</code></a></span></li>
<li><span class="pkg-link" data-pkg="ROOPSD" data-topic="AbstractDist" data-id="sf"><a href='../../ROOPSD/html/AbstractDist.html#method-AbstractDist-sf'><code>ROOPSD::AbstractDist$sf()</code></a></span></li>
</ul>
</details>

<hr>
<a id="method-Exponential-new"></a></p><div class='section' id='method-new-'>
<h3>Method <code>new()</code></h3>
<p>Create a new Exponential object.</p><div class='section' id='usage'>
<h4>Usage</h4>
<p><div class="r"></p><pre><code>Exponential$new(rate = 1)</code></pre><p></div></p>
</div>

<div class='section' id='arguments'>
<h4>Arguments</h4>
<p><div class="arguments"></p><dl>
<dt><code>rate</code></dt>
<dd><p>[double] Rate of the exponential law</p></dd>


</dl><p></div></p>
</div>
<div class='section' id='returns'>
<h4>Returns</h4>
<p>A new `Exponential` object.</p>
</div>

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


Exponential: Exponential

Description

Arguments

Super class

Active bindings

Methods

Public methods

Method `new()`

Usage

Arguments

Returns

Method `clone()`

Usage

Arguments

Details

Examples

Description

Arguments

Super class

Active bindings

Methods

Public methods

Method new()

Usage

Arguments

Returns

Method clone()

Usage

Arguments

Details

Examples

Method `new()`

Method `clone()`