Skip to content

Commit 591db83

Browse files
committed
Updated scala docs
1 parent 6113707 commit 591db83

File tree

5 files changed

+23
-15
lines changed

5 files changed

+23
-15
lines changed

docs/api_docs/v1.4.2/dynaml-core/io/github/mandar2812/dynaml/kernels/GenericMaternARDKernel.html

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,9 @@ <h4 id="signature" class="signature">
4949
</span>
5050
</h4>
5151

52-
<div id="comment" class="fullcommenttop"><div class="comment cmt"></div><dl class="attributes block"> <dt>Self Type</dt><dd><a href="" class="extype" name="io.github.mandar2812.dynaml.kernels.GenericMaternARDKernel">GenericMaternARDKernel</a>[<span class="extype" name="io.github.mandar2812.dynaml.kernels.GenericMaternARDKernel.T">T</span>]</dd></dl><div class="toggleContainer block">
52+
<div id="comment" class="fullcommenttop"><div class="comment cmt"><p>Implementation of the half integer Matern-ARD
53+
covariance function
54+
</p></div><dl class="attributes block"> <dt>Self Type</dt><dd><a href="" class="extype" name="io.github.mandar2812.dynaml.kernels.GenericMaternARDKernel">GenericMaternARDKernel</a>[<span class="extype" name="io.github.mandar2812.dynaml.kernels.GenericMaternARDKernel.T">T</span>]</dd></dl><div class="toggleContainer block">
5355
<span class="toggle">Linear Supertypes</span>
5456
<div class="superTypes hiddenContent"><a href="LocalScalarKernel.html" class="extype" name="io.github.mandar2812.dynaml.kernels.LocalScalarKernel">LocalScalarKernel</a>[<span class="extype" name="io.github.mandar2812.dynaml.kernels.GenericMaternARDKernel.T">T</span>], <a href="StationaryKernel.html" class="extype" name="io.github.mandar2812.dynaml.kernels.StationaryKernel">StationaryKernel</a>[<span class="extype" name="io.github.mandar2812.dynaml.kernels.GenericMaternARDKernel.T">T</span>, <span class="extype" name="scala.Double">Double</span>, <span class="extype" name="breeze.linalg.DenseMatrix">DenseMatrix</span>[<span class="extype" name="scala.Double">Double</span>]], <a href="CovarianceFunction.html" class="extype" name="io.github.mandar2812.dynaml.kernels.CovarianceFunction">CovarianceFunction</a>[<span class="extype" name="io.github.mandar2812.dynaml.kernels.GenericMaternARDKernel.T">T</span>, <span class="extype" name="scala.Double">Double</span>, <span class="extype" name="breeze.linalg.DenseMatrix">DenseMatrix</span>[<span class="extype" name="scala.Double">Double</span>]], <a href="Kernel.html" class="extype" name="io.github.mandar2812.dynaml.kernels.Kernel">Kernel</a>[<span class="extype" name="io.github.mandar2812.dynaml.kernels.GenericMaternARDKernel.T">T</span>, <span class="extype" name="scala.Double">Double</span>], <span class="extype" name="scala.Serializable">Serializable</span>, <span class="extype" name="java.io.Serializable">Serializable</span>, <span class="extype" name="scala.AnyRef">AnyRef</span>, <span class="extype" name="scala.Any">Any</span></div>
5557
</div></div>
@@ -89,18 +91,18 @@ <h4 id="signature" class="signature">
8991
<div id="constructors" class="members">
9092
<h3>Instance Constructors</h3>
9193
<ol><li name="io.github.mandar2812.dynaml.kernels.GenericMaternARDKernel#&lt;init&gt;" visbl="pub" data-isabs="false" fullComment="no" group="Ungrouped">
92-
<a id="&lt;init&gt;(l:T,p:Int)(implicitev:spire.algebra.Field[T]withspire.algebra.InnerProductSpace[T,Double]):io.github.mandar2812.dynaml.kernels.GenericMaternARDKernel[T]"></a>
94+
<a id="&lt;init&gt;(l:T,p:Int)(implicitevInner:spire.algebra.InnerProductSpace[T,Double],implicitevField:spire.algebra.Field[T]):io.github.mandar2812.dynaml.kernels.GenericMaternARDKernel[T]"></a>
9395
<a id="&lt;init&gt;:GenericMaternARDKernel[T]"></a>
9496
<h4 class="signature">
9597
<span class="modifier_kind">
9698
<span class="modifier"></span>
9799
<span class="kind">new</span>
98100
</span>
99101
<span class="symbol">
100-
<span class="name">GenericMaternARDKernel</span><span class="params">(<span name="l">l: <span class="extype" name="io.github.mandar2812.dynaml.kernels.GenericMaternARDKernel.T">T</span></span>, <span name="p">p: <span class="extype" name="scala.Int">Int</span> = <span class="symbol">3</span></span>)</span><span class="params">(<span class="implicit">implicit </span><span name="ev">ev: <span class="extype" name="spire.algebra.Field">Field</span>[<span class="extype" name="io.github.mandar2812.dynaml.kernels.GenericMaternARDKernel.T">T</span>] with <span class="extype" name="spire.algebra.InnerProductSpace">InnerProductSpace</span>[<span class="extype" name="io.github.mandar2812.dynaml.kernels.GenericMaternARDKernel.T">T</span>, <span class="extype" name="scala.Double">Double</span>]</span>)</span>
102+
<span class="name">GenericMaternARDKernel</span><span class="params">(<span name="l">l: <span class="extype" name="io.github.mandar2812.dynaml.kernels.GenericMaternARDKernel.T">T</span></span>, <span name="p">p: <span class="extype" name="scala.Int">Int</span> = <span class="symbol">3</span></span>)</span><span class="params">(<span class="implicit">implicit </span><span name="evInner">evInner: <span class="extype" name="spire.algebra.InnerProductSpace">InnerProductSpace</span>[<span class="extype" name="io.github.mandar2812.dynaml.kernels.GenericMaternARDKernel.T">T</span>, <span class="extype" name="scala.Double">Double</span>]</span>, <span name="evField">evField: <span class="extype" name="spire.algebra.Field">Field</span>[<span class="extype" name="io.github.mandar2812.dynaml.kernels.GenericMaternARDKernel.T">T</span>]</span>)</span>
101103
</span>
102104
</h4><span class="permalink">
103-
<a href="../../../../../index.html#io.github.mandar2812.dynaml.kernels.GenericMaternARDKernel@&lt;init&gt;(l:T,p:Int)(implicitev:spire.algebra.Field[T]withspire.algebra.InnerProductSpace[T,Double]):io.github.mandar2812.dynaml.kernels.GenericMaternARDKernel[T]" title="Permalink" target="_top">
105+
<a href="../../../../../index.html#io.github.mandar2812.dynaml.kernels.GenericMaternARDKernel@&lt;init&gt;(l:T,p:Int)(implicitevInner:spire.algebra.InnerProductSpace[T,Double],implicitevField:spire.algebra.Field[T]):io.github.mandar2812.dynaml.kernels.GenericMaternARDKernel[T]" title="Permalink" target="_top">
104106
<img src="../../../../../lib/permalink.png" alt="Permalink" />
105107
</a>
106108
</span>

docs/api_docs/v1.4.2/dynaml-core/io/github/mandar2812/dynaml/kernels/GenericMaternKernel.html

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,9 @@ <h4 id="signature" class="signature">
4949
</span>
5050
</h4>
5151

52-
<div id="comment" class="fullcommenttop"><div class="comment cmt"></div><dl class="attributes block"> <dt>Self Type</dt><dd><a href="" class="extype" name="io.github.mandar2812.dynaml.kernels.GenericMaternKernel">GenericMaternKernel</a>[<span class="extype" name="io.github.mandar2812.dynaml.kernels.GenericMaternKernel.T">T</span>]</dd></dl><div class="toggleContainer block">
52+
<div id="comment" class="fullcommenttop"><div class="comment cmt"><p>Implementation of the half integer Matern
53+
covariance function
54+
</p></div><dl class="attributes block"> <dt>Self Type</dt><dd><a href="" class="extype" name="io.github.mandar2812.dynaml.kernels.GenericMaternKernel">GenericMaternKernel</a>[<span class="extype" name="io.github.mandar2812.dynaml.kernels.GenericMaternKernel.T">T</span>]</dd></dl><div class="toggleContainer block">
5355
<span class="toggle">Linear Supertypes</span>
5456
<div class="superTypes hiddenContent"><a href="LocalScalarKernel.html" class="extype" name="io.github.mandar2812.dynaml.kernels.LocalScalarKernel">LocalScalarKernel</a>[<span class="extype" name="io.github.mandar2812.dynaml.kernels.GenericMaternKernel.T">T</span>], <a href="StationaryKernel.html" class="extype" name="io.github.mandar2812.dynaml.kernels.StationaryKernel">StationaryKernel</a>[<span class="extype" name="io.github.mandar2812.dynaml.kernels.GenericMaternKernel.T">T</span>, <span class="extype" name="scala.Double">Double</span>, <span class="extype" name="breeze.linalg.DenseMatrix">DenseMatrix</span>[<span class="extype" name="scala.Double">Double</span>]], <a href="CovarianceFunction.html" class="extype" name="io.github.mandar2812.dynaml.kernels.CovarianceFunction">CovarianceFunction</a>[<span class="extype" name="io.github.mandar2812.dynaml.kernels.GenericMaternKernel.T">T</span>, <span class="extype" name="scala.Double">Double</span>, <span class="extype" name="breeze.linalg.DenseMatrix">DenseMatrix</span>[<span class="extype" name="scala.Double">Double</span>]], <a href="Kernel.html" class="extype" name="io.github.mandar2812.dynaml.kernels.Kernel">Kernel</a>[<span class="extype" name="io.github.mandar2812.dynaml.kernels.GenericMaternKernel.T">T</span>, <span class="extype" name="scala.Double">Double</span>], <span class="extype" name="scala.Serializable">Serializable</span>, <span class="extype" name="java.io.Serializable">Serializable</span>, <span class="extype" name="scala.AnyRef">AnyRef</span>, <span class="extype" name="scala.Any">Any</span></div>
5557
</div></div>
@@ -89,18 +91,18 @@ <h4 id="signature" class="signature">
8991
<div id="constructors" class="members">
9092
<h3>Instance Constructors</h3>
9193
<ol><li name="io.github.mandar2812.dynaml.kernels.GenericMaternKernel#&lt;init&gt;" visbl="pub" data-isabs="false" fullComment="no" group="Ungrouped">
92-
<a id="&lt;init&gt;(l:Double,p:Int)(implicitev:spire.algebra.Field[T]withspire.algebra.InnerProductSpace[T,Double]):io.github.mandar2812.dynaml.kernels.GenericMaternKernel[T]"></a>
94+
<a id="&lt;init&gt;(l:Double,p:Int)(implicitevInner:spire.algebra.InnerProductSpace[T,Double],implicitevField:spire.algebra.Field[T]):io.github.mandar2812.dynaml.kernels.GenericMaternKernel[T]"></a>
9395
<a id="&lt;init&gt;:GenericMaternKernel[T]"></a>
9496
<h4 class="signature">
9597
<span class="modifier_kind">
9698
<span class="modifier"></span>
9799
<span class="kind">new</span>
98100
</span>
99101
<span class="symbol">
100-
<span class="name">GenericMaternKernel</span><span class="params">(<span name="l">l: <span class="extype" name="scala.Double">Double</span></span>, <span name="p">p: <span class="extype" name="scala.Int">Int</span> = <span class="symbol">2</span></span>)</span><span class="params">(<span class="implicit">implicit </span><span name="ev">ev: <span class="extype" name="spire.algebra.Field">Field</span>[<span class="extype" name="io.github.mandar2812.dynaml.kernels.GenericMaternKernel.T">T</span>] with <span class="extype" name="spire.algebra.InnerProductSpace">InnerProductSpace</span>[<span class="extype" name="io.github.mandar2812.dynaml.kernels.GenericMaternKernel.T">T</span>, <span class="extype" name="scala.Double">Double</span>]</span>)</span>
102+
<span class="name">GenericMaternKernel</span><span class="params">(<span name="l">l: <span class="extype" name="scala.Double">Double</span></span>, <span name="p">p: <span class="extype" name="scala.Int">Int</span> = <span class="symbol">2</span></span>)</span><span class="params">(<span class="implicit">implicit </span><span name="evInner">evInner: <span class="extype" name="spire.algebra.InnerProductSpace">InnerProductSpace</span>[<span class="extype" name="io.github.mandar2812.dynaml.kernels.GenericMaternKernel.T">T</span>, <span class="extype" name="scala.Double">Double</span>]</span>, <span name="evField">evField: <span class="extype" name="spire.algebra.Field">Field</span>[<span class="extype" name="io.github.mandar2812.dynaml.kernels.GenericMaternKernel.T">T</span>]</span>)</span>
101103
</span>
102104
</h4><span class="permalink">
103-
<a href="../../../../../index.html#io.github.mandar2812.dynaml.kernels.GenericMaternKernel@&lt;init&gt;(l:Double,p:Int)(implicitev:spire.algebra.Field[T]withspire.algebra.InnerProductSpace[T,Double]):io.github.mandar2812.dynaml.kernels.GenericMaternKernel[T]" title="Permalink" target="_top">
105+
<a href="../../../../../index.html#io.github.mandar2812.dynaml.kernels.GenericMaternKernel@&lt;init&gt;(l:Double,p:Int)(implicitevInner:spire.algebra.InnerProductSpace[T,Double],implicitevField:spire.algebra.Field[T]):io.github.mandar2812.dynaml.kernels.GenericMaternKernel[T]" title="Permalink" target="_top">
104106
<img src="../../../../../lib/permalink.png" alt="Permalink" />
105107
</a>
106108
</span>

docs/api_docs/v1.4.2/dynaml-core/io/github/mandar2812/dynaml/kernels/KernelOpType.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ <h4 id="signature" class="signature">
5454
<div class="superTypes hiddenContent"><span class="extype" name="scala.AnyRef">AnyRef</span>, <span class="extype" name="scala.Any">Any</span></div>
5555
</div><div class="toggleContainer block">
5656
<span class="toggle">Known Subclasses</span>
57-
<div class="subClasses hiddenContent"><a href="KernelOpAdd$.html" class="extype" name="io.github.mandar2812.dynaml.kernels.KernelOpAdd">KernelOpAdd</a>, <a href="KernelOpAdd.html" class="extype" name="io.github.mandar2812.dynaml.kernels.KernelOpAdd">KernelOpAdd</a>, <a href="KernelOpMult$.html" class="extype" name="io.github.mandar2812.dynaml.kernels.KernelOpMult">KernelOpMult</a>, <a href="KernelOpMult.html" class="extype" name="io.github.mandar2812.dynaml.kernels.KernelOpMult">KernelOpMult</a>, <a href="KernelOuterAdd$.html" class="extype" name="io.github.mandar2812.dynaml.kernels.KernelOuterAdd">KernelOuterAdd</a>, <a href="KernelOuterAdd.html" class="extype" name="io.github.mandar2812.dynaml.kernels.KernelOuterAdd">KernelOuterAdd</a>, <a href="KernelOuterMult.html" class="extype" name="io.github.mandar2812.dynaml.kernels.KernelOuterMult">KernelOuterMult</a>, <a href="KernelOuterMult$.html" class="extype" name="io.github.mandar2812.dynaml.kernels.KernelOuterMult">KernelOuterMult</a></div>
57+
<div class="subClasses hiddenContent"><a href="KernelOpAdd$.html" class="extype" name="io.github.mandar2812.dynaml.kernels.KernelOpAdd">KernelOpAdd</a>, <a href="KernelOpAdd.html" class="extype" name="io.github.mandar2812.dynaml.kernels.KernelOpAdd">KernelOpAdd</a>, <a href="KernelOpMult.html" class="extype" name="io.github.mandar2812.dynaml.kernels.KernelOpMult">KernelOpMult</a>, <a href="KernelOpMult$.html" class="extype" name="io.github.mandar2812.dynaml.kernels.KernelOpMult">KernelOpMult</a>, <a href="KernelOuterAdd$.html" class="extype" name="io.github.mandar2812.dynaml.kernels.KernelOuterAdd">KernelOuterAdd</a>, <a href="KernelOuterAdd.html" class="extype" name="io.github.mandar2812.dynaml.kernels.KernelOuterAdd">KernelOuterAdd</a>, <a href="KernelOuterMult$.html" class="extype" name="io.github.mandar2812.dynaml.kernels.KernelOuterMult">KernelOuterMult</a>, <a href="KernelOuterMult.html" class="extype" name="io.github.mandar2812.dynaml.kernels.KernelOuterMult">KernelOuterMult</a></div>
5858
</div></div>
5959

6060

docs/api_docs/v1.4.2/dynaml-core/io/github/mandar2812/dynaml/kernels/package.html

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -495,7 +495,9 @@ <h4 class="signature">
495495
<img src="../../../../../lib/permalink.png" alt="Permalink" />
496496
</a>
497497
</span>
498-
<p class="shortcomment cmt"></p>
498+
<p class="shortcomment cmt">Implementation of the half integer Matern-ARD
499+
covariance function
500+
</p>
499501
</li><li name="io.github.mandar2812.dynaml.kernels.GenericMaternKernel" visbl="pub" data-isabs="false" fullComment="no" group="Ungrouped">
500502
<a id="GenericMaternKernel[T]extendsStationaryKernel[T,Double,breeze.linalg.DenseMatrix[Double]]withLocalScalarKernel[T]withSerializable"></a>
501503
<a id="GenericMaternKernel[T]:GenericMaternKernel[T]"></a>
@@ -512,7 +514,9 @@ <h4 class="signature">
512514
<img src="../../../../../lib/permalink.png" alt="Permalink" />
513515
</a>
514516
</span>
515-
<p class="shortcomment cmt"></p>
517+
<p class="shortcomment cmt">Implementation of the half integer Matern
518+
covariance function
519+
</p>
516520
</li><li name="io.github.mandar2812.dynaml.kernels.GenericRBFKernel" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped">
517521
<a id="GenericRBFKernel[T]extendsStationaryKernel[T,Double,breeze.linalg.DenseMatrix[Double]]withLocalScalarKernel[T]withSerializable"></a>
518522
<a id="GenericRBFKernel[T]:GenericRBFKernel[T]"></a>

0 commit comments

Comments
 (0)