apatite/docs/Apatite/LinearAlgebra.html

246 lines
5.7 KiB
HTML

<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="generator" content="Crystal Docs 0.29.0">
<link href="../css/style.css" rel="stylesheet" type="text/css">
<script type="text/javascript" src="../js/doc.js"></script>
<script type="text/javascript">
CrystalDoc.base_path = "../";
</script>
<meta id="repository-name" content="github.com/watzon/apatite">
<title>Apatite::LinearAlgebra - github.com/watzon/apatite</title>
</head>
<body>
<div class="sidebar">
<div class="sidebar-header">
<div class="search-box">
<input type="search" class="search-input" placeholder="Search..." spellcheck="false" aria-label="Search">
</div>
<div class="repository-links">
<a href="../index.html">README</a>
</div>
</div>
<div class="search-results" class="hidden">
<ul class="search-list"></ul>
</div>
<div class="types-list">
<ul>
<li class="parent open current" data-id="github.com/watzon/apatite/Apatite" data-name="apatite">
<a href="../Apatite.html">Apatite</a>
<ul>
<li class="parent open current" data-id="github.com/watzon/apatite/Apatite/LinearAlgebra" data-name="apatite::linearalgebra">
<a href="../Apatite/LinearAlgebra.html">LinearAlgebra</a>
<ul>
<li class=" " data-id="github.com/watzon/apatite/Apatite/LinearAlgebra/Matrix" data-name="apatite::linearalgebra::matrix">
<a href="../Apatite/LinearAlgebra/Matrix.html">Matrix</a>
</li>
<li class=" " data-id="github.com/watzon/apatite/Apatite/LinearAlgebra/NDArray" data-name="apatite::linearalgebra::ndarray">
<a href="../Apatite/LinearAlgebra/NDArray.html">NDArray</a>
</li>
<li class=" " data-id="github.com/watzon/apatite/Apatite/LinearAlgebra/Vector" data-name="apatite::linearalgebra::vector">
<a href="../Apatite/LinearAlgebra/Vector.html">Vector</a>
</li>
</ul>
</li>
</ul>
</li>
<li class=" " data-id="github.com/watzon/apatite/Array" data-name="array(t)">
<a href="../Array.html">Array</a>
</li>
</ul>
</div>
</div>
<div class="main-content">
<h1 class="type-name">
<span class="kind">module</span> Apatite::LinearAlgebra
</h1>
<h2>Extended Modules</h2>
<ul class="other-types-list">
<li class="other-type"><a href="../Apatite/LinearAlgebra.html">Apatite::LinearAlgebra</a></li>
</ul>
<h2>Direct including types</h2>
<ul class="other-types-list">
<li class="other-type"><a href="../Apatite.html">Apatite</a></li>
</ul>
<h2>Defined in:</h2>
<a href="https://github.com/watzon/apatite/blob/bb0f2c43324c0d6ab61bd78a63170c4d2e671d2f/src/apatite/linear_algebra/ndarray.cr#L1" target="_blank">
apatite/linear_algebra/ndarray.cr
</a>
<br/>
<a href="https://github.com/watzon/apatite/blob/bb0f2c43324c0d6ab61bd78a63170c4d2e671d2f/src/apatite/linear_algebra/vector.cr#L1" target="_blank">
apatite/linear_algebra/vector.cr
</a>
<br/>
<a href="https://github.com/watzon/apatite/blob/bb0f2c43324c0d6ab61bd78a63170c4d2e671d2f/src/apatite/linear_algebra/matrix.cr#L3" target="_blank">
apatite/linear_algebra/matrix.cr
</a>
<br/>
<a href="https://github.com/watzon/apatite/blob/bb0f2c43324c0d6ab61bd78a63170c4d2e671d2f/src/apatite/linear_algebra.cr#L6" target="_blank">
apatite/linear_algebra.cr
</a>
<br/>
<h2>Instance Method Summary</h2>
<ul class="list-summary">
<li class="entry-summary">
<a href="#sigmoid%28input%3ANumber%29-instance-method" class="signature"><strong>#sigmoid</strong>(input : Number)</a>
<div class="summary"><p>Calculates the sigmoid curve for a numeric input.</p></div>
</li>
<li class="entry-summary">
<a href="#sigmoid_d%28input%3ANumber%29-instance-method" class="signature"><strong>#sigmoid_d</strong>(input : Number)</a>
<div class="summary"><p>Calculates the derivative sigmoid curve for a numeric input.</p></div>
</li>
</ul>
<div class="methods-inherited">
</div>
<h2>Instance Method Detail</h2>
<div class="entry-detail" id="sigmoid(input:Number)-instance-method">
<div class="signature">
def <strong>sigmoid</strong>(input : Number)
<a class="method-permalink" href="#sigmoid%28input%3ANumber%29-instance-method">#</a>
</div>
<div class="doc"><p>Calculates the sigmoid curve for a numeric input.</p>
<p><code>f(x) = 1/(1 + e^-x)</code></p>
<p>See also: <a href="https://www.wikiwand.com/en/Sigmoid_function" target="_blank">Sigmoid function (WikiWand)</a></p></div>
<br/>
<div>
[<a href="https://github.com/watzon/apatite/blob/bb0f2c43324c0d6ab61bd78a63170c4d2e671d2f/src/apatite/linear_algebra.cr#L14" target="_blank">View source</a>]
</div>
</div>
<div class="entry-detail" id="sigmoid_d(input:Number)-instance-method">
<div class="signature">
def <strong>sigmoid_d</strong>(input : Number)
<a class="method-permalink" href="#sigmoid_d%28input%3ANumber%29-instance-method">#</a>
</div>
<div class="doc"><p>Calculates the derivative sigmoid curve for a numeric input.</p>
<p><code>f'(x) = f(x)(1 - f(x)),</code></p></div>
<br/>
<div>
[<a href="https://github.com/watzon/apatite/blob/bb0f2c43324c0d6ab61bd78a63170c4d2e671d2f/src/apatite/linear_algebra.cr#L22" target="_blank">View source</a>]
</div>
</div>
</div>
</body>
</html>