apatite/docs/Apatite.html

266 lines
6.2 KiB
HTML
Raw Normal View History

2019-06-13 02:23:54 +00:00
<!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 - 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 " data-id="github.com/watzon/apatite/Apatite/LinearAlgebra" data-name="apatite::linearalgebra">
<a href="Apatite/LinearAlgebra.html">LinearAlgebra</a>
<ul>
2019-07-10 01:18:01 +00:00
<li class=" " data-id="github.com/watzon/apatite/Apatite/LinearAlgebra/ErrDimensionMismatch" data-name="apatite::linearalgebra::errdimensionmismatch">
<a href="Apatite/LinearAlgebra/ErrDimensionMismatch.html">ErrDimensionMismatch</a>
</li>
<li class=" " data-id="github.com/watzon/apatite/Apatite/LinearAlgebra/ErrNotRegular" data-name="apatite::linearalgebra::errnotregular">
<a href="Apatite/LinearAlgebra/ErrNotRegular.html">ErrNotRegular</a>
</li>
<li class=" " data-id="github.com/watzon/apatite/Apatite/LinearAlgebra/ErrOperationNotDefined" data-name="apatite::linearalgebra::erroperationnotdefined">
<a href="Apatite/LinearAlgebra/ErrOperationNotDefined.html">ErrOperationNotDefined</a>
</li>
<li class=" " data-id="github.com/watzon/apatite/Apatite/LinearAlgebra/Error" data-name="apatite::linearalgebra::error">
<a href="Apatite/LinearAlgebra/Error.html">Error</a>
</li>
2019-07-10 02:08:46 +00:00
<li class="parent " data-id="github.com/watzon/apatite/Apatite/LinearAlgebra/Matrix" data-name="apatite::linearalgebra::matrix(t)">
2019-06-13 02:23:54 +00:00
<a href="Apatite/LinearAlgebra/Matrix.html">Matrix</a>
2019-07-10 02:08:46 +00:00
<ul>
2019-06-13 02:23:54 +00:00
2019-07-10 02:08:46 +00:00
<li class=" " data-id="github.com/watzon/apatite/Apatite/LinearAlgebra/Matrix/EigenvalueDecomposition" data-name="apatite::linearalgebra::matrix::eigenvaluedecomposition">
<a href="Apatite/LinearAlgebra/Matrix/EigenvalueDecomposition.html">EigenvalueDecomposition</a>
2019-06-13 02:23:54 +00:00
</li>
2019-07-10 02:08:46 +00:00
<li class=" " data-id="github.com/watzon/apatite/Apatite/LinearAlgebra/Matrix/LupDecomposition" data-name="apatite::linearalgebra::matrix::lupdecomposition">
<a href="Apatite/LinearAlgebra/Matrix/LupDecomposition.html">LupDecomposition</a>
2019-07-10 01:18:01 +00:00
</li>
</ul>
</li>
2019-07-10 02:08:46 +00:00
<li class=" " data-id="github.com/watzon/apatite/Apatite/LinearAlgebra/NDArray" data-name="apatite::linearalgebra::ndarray">
<a href="Apatite/LinearAlgebra/NDArray.html">NDArray</a>
2019-07-10 01:18:01 +00:00
2019-07-10 02:08:46 +00:00
</li>
2019-07-10 01:18:01 +00:00
2019-07-10 02:08:46 +00:00
<li class=" " data-id="github.com/watzon/apatite/Apatite/LinearAlgebra/Vector" data-name="apatite::linearalgebra::vector(t)">
<a href="Apatite/LinearAlgebra/Vector.html">Vector</a>
2019-07-10 01:18:01 +00:00
</li>
2019-07-10 02:08:46 +00:00
<li class=" " data-id="github.com/watzon/apatite/Apatite/LinearAlgebra/ZeroVectorError" data-name="apatite::linearalgebra::zerovectorerror">
<a href="Apatite/LinearAlgebra/ZeroVectorError.html">ZeroVectorError</a>
2019-07-10 01:18:01 +00:00
</li>
2019-06-13 02:23:54 +00:00
</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
</h1>
<h2>Overview</h2>
<p>Apatite is a fundimental package for scientific computing in Crystal. If that
sounds like a modified version of the first line from the NumPy homepage,
that's because it is. Apatite has (ok, will have) all of the goodness
of NumPy sitting atop the blazing speed and beautiful syntax
of Crystal.</p>
<h2>Included Modules</h2>
<ul class="other-types-list">
<li class="other-type"><a href="Apatite/LinearAlgebra.html">Apatite::LinearAlgebra</a></li>
</ul>
<h2>Extended Modules</h2>
<ul class="other-types-list">
<li class="other-type"><a href="Apatite.html">Apatite</a></li>
</ul>
<h2>Defined in:</h2>
2019-07-10 02:08:46 +00:00
<a href="https://github.com/watzon/apatite/blob/06bd6fa4ee11fe383cfa0fae10d396c06768c07e/src/apatite/linear_algebra/error.cr#L1" target="_blank">
2019-07-10 01:18:01 +00:00
apatite/linear_algebra/error.cr
</a>
<br/>
2019-07-10 02:08:46 +00:00
<a href="https://github.com/watzon/apatite/blob/06bd6fa4ee11fe383cfa0fae10d396c06768c07e/src/apatite/linear_algebra.cr#L6" target="_blank">
2019-06-13 02:23:54 +00:00
apatite/linear_algebra.cr
</a>
<br/>
2019-07-10 02:08:46 +00:00
<a href="https://github.com/watzon/apatite/blob/06bd6fa4ee11fe383cfa0fae10d396c06768c07e/src/apatite.cr#L10" target="_blank">
2019-06-13 02:23:54 +00:00
apatite.cr
</a>
<br/>
2019-07-10 02:08:46 +00:00
<a href="https://github.com/watzon/apatite/blob/06bd6fa4ee11fe383cfa0fae10d396c06768c07e/src/apatite/version.cr#L1" target="_blank">
2019-06-13 02:23:54 +00:00
apatite/version.cr
</a>
<br/>
<h2>Constant Summary</h2>
<dl>
<dt class="entry-const" id="VERSION">
<strong>VERSION</strong> = <code><span class="s">&quot;0.1.0&quot;</span></code>
</dt>
</dl>
2019-06-17 22:01:05 +00:00
2019-06-13 02:23:54 +00:00
<div class="methods-inherited">
<h3>Instance methods inherited from module <code><a href="Apatite/LinearAlgebra.html">Apatite::LinearAlgebra</a></code></h3>
<a href="Apatite/LinearAlgebra.html#sigmoid%28input%3ANumber%29-instance-method" class="tooltip">
<span>sigmoid(input : Number)</span>
sigmoid</a>,
<a href="Apatite/LinearAlgebra.html#sigmoid_d%28input%3ANumber%29-instance-method" class="tooltip">
<span>sigmoid_d(input : Number)</span>
sigmoid_d</a>
</div>
2019-06-17 22:01:05 +00:00
2019-06-13 02:23:54 +00:00
</div>
</body>
</html>