Skip to content

Commit be23f41

Browse files
committed
More scala doc improvements
1 parent 70c4f43 commit be23f41

File tree

4 files changed

+5
-7
lines changed

4 files changed

+5
-7
lines changed

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/ScaledKernel.html

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -52,9 +52,7 @@ <h4 id="signature" class="signature">
5252
</h4>
5353

5454
<div id="comment" class="fullcommenttop"><div class="comment cmt"><p>Represents covariance function of a GP which is
55-
scaled version of a base GP.
56-
z ~ GP(m(.), K(.,.))
57-
y = g(x)*z</p><p>y ~ GP(g(x)*m(x), g(x)K(x,x')g(x'))
55+
scaled version of a base GP.</p><p>z ~ GP(m(.), K(.,.))</p><p>y = g(x)*z</p><p>y ~ GP(g(x)*m(x), g(x)K(x,x')g(x'))
5856
</p></div><div class="toggleContainer block">
5957
<span class="toggle">Linear Supertypes</span>
6058
<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.ScaledKernel.I">I</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.ScaledKernel.I">I</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.ScaledKernel.I">I</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>

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

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1157,9 +1157,7 @@ <h4 class="signature">
11571157
</span>
11581158
<p class="shortcomment cmt">Represents covariance function of a GP which is
11591159
scaled version of a base GP.</p><div class="fullcomment"><div class="comment cmt"><p>Represents covariance function of a GP which is
1160-
scaled version of a base GP.
1161-
z ~ GP(m(.), K(.,.))
1162-
y = g(x)*z</p><p>y ~ GP(g(x)*m(x), g(x)K(x,x')g(x'))
1160+
scaled version of a base GP.</p><p>z ~ GP(m(.), K(.,.))</p><p>y = g(x)*z</p><p>y ~ GP(g(x)*m(x), g(x)K(x,x')g(x'))
11631161
</p></div></div>
11641162
</li><li name="io.github.mandar2812.dynaml.kernels.StationaryKernel" visbl="pub" data-isabs="true" fullComment="no" group="Ungrouped">
11651163
<a id="StationaryKernel[T,V,M]extendsCovarianceFunction[T,V,M]"></a>

dynaml-core/src/main/scala-2.11/io/github/mandar2812/dynaml/kernels/LocallyStationaryKernel.scala

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,9 @@ class LocallyStationaryKernel[I](
5353
*
5454
* Represents covariance function of a GP which is
5555
* scaled version of a base GP.
56+
*
5657
* z ~ GP(m(.), K(.,.))
58+
*
5759
* y = g(x)*z
5860
*
5961
* y ~ GP(g(x)*m(x), g(x)K(x,x')g(x'))

0 commit comments

Comments
 (0)