From 41297032e810d97c59d020eff090f6ce5e54046c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Zbigniew=20J=C4=99drzejewski-Szmek?= Date: Thu, 26 Jan 2017 10:58:48 -0500 Subject: [PATCH 1/2] javadoc: add summaries to tables Required by java 8 javadoc paraser. --- src/main/java/org/jblas/DoubleMatrix.java | 24 +++++++++++------------ src/main/java/org/jblas/FloatMatrix.java | 24 +++++++++++------------ 2 files changed, 24 insertions(+), 24 deletions(-) diff --git a/src/main/java/org/jblas/DoubleMatrix.java b/src/main/java/org/jblas/DoubleMatrix.java index 5bb5511..60ab13c 100644 --- a/src/main/java/org/jblas/DoubleMatrix.java +++ b/src/main/java/org/jblas/DoubleMatrix.java @@ -75,7 +75,7 @@ *

To construct a two-dimensional matrices, you can use the following constructors * and static methods.

* - * + *
*
MethodDescription *
DoubleMatrix(m,n, [value1, value2, value3...])Values are filled in column by column. *
DoubleMatrix(new double[][] {{value1, value2, ...}, ...}Inner arrays are rows. @@ -91,7 +91,7 @@ *

Alternatively, you can construct (column) vectors, if you just supply the length * using the following constructors and static methods.

* - * + *
* * * @@ -107,7 +107,7 @@ *

You can also construct new matrices by concatenating matrices either horziontally * or vertically:

* - *
Method Description
DoubleMatrix(m) Constructs a column vector.
DoubleMatrix(new double[] {value1, value2, ...})Constructs a column vector.
+ *
*
MethodDescription *
x.concatHorizontally(y)New matrix will be x next to y. *
x.concatVertically(y)New matrix will be x atop y. @@ -119,7 +119,7 @@ *

To access individual elements, or whole rows and columns, use the following * methods:

* - * + *
*
x.MethodDescription *
x.get(i,j)Get element in row i and column j. *
x.put(i, j, v)Set element in row i and column j to value v @@ -149,7 +149,7 @@ * *

There exist the following Range objects. The Class RangeUtils also * contains the a number of handy helper methods for constructing these ranges.

- * + *
*
Class RangeUtils method Indices *
AllRange all() All legal indices. *
PointRange point(i) A single point. @@ -162,7 +162,7 @@ * *

The following methods can be used for duplicating and copying matrices.

* - * + *
*
MethodDescription *
x.dup()Get a copy of x. *
x.copy(y)Copy the contents of y to x (possible resizing x). @@ -173,7 +173,7 @@ * *

The following methods permit to access the size of a matrix and change its size or shape.

* - * + *
*
x.MethodDescription *
x.rowsNumber of rows. *
x.columnsNumber of columns. @@ -224,7 +224,7 @@ * right-hand-side. The same effect can be achieved by passing a DoubleMatrix with * exactly one element.

* - * + *
*
Operation Method Comment *
x + y x.add(y) *
x - y x.sub(y), y.rsub(x) rsub subtracts left from right hand side @@ -238,7 +238,7 @@ * *

There also exist operations which work on whole columns or rows.

* - * + *
* * * @@ -258,7 +258,7 @@ * *

The following comparison operations are available

* - *
Method Description
x.addRowVector adds a vector to each row (addiRowVector works in-place)
x.addColumnVectoradds a vector to each column
+ *
*
Operation Method *
x < y x.lt(y) *
x <= y x.le(y) @@ -273,7 +273,7 @@ * zero is treated as "true" and zero is treated as "false". All operations are carried * out elementwise.

* - * + *
*
Operation Method *
x & y x.and(y) *
x | y x.or(y) @@ -284,7 +284,7 @@ * *

Finally, there are a few more methods to compute various things:

* - * + *
*
Method Description *
x.max() Return maximal element *
x.argmax() Return index of largest element diff --git a/src/main/java/org/jblas/FloatMatrix.java b/src/main/java/org/jblas/FloatMatrix.java index 0bd9248..a967534 100644 --- a/src/main/java/org/jblas/FloatMatrix.java +++ b/src/main/java/org/jblas/FloatMatrix.java @@ -75,7 +75,7 @@ *

To construct a two-dimensional matrices, you can use the following constructors * and static methods.

* - * + *
*
MethodDescription *
FloatMatrix(m,n, [value1, value2, value3...])Values are filled in column by column. *
FloatMatrix(new float[][] {{value1, value2, ...}, ...}Inner arrays are rows. @@ -91,7 +91,7 @@ *

Alternatively, you can construct (column) vectors, if you just supply the length * using the following constructors and static methods.

* - * + *
* * * @@ -107,7 +107,7 @@ *

You can also construct new matrices by concatenating matrices either horziontally * or vertically:

* - *
Method Description
FloatMatrix(m) Constructs a column vector.
FloatMatrix(new float[] {value1, value2, ...})Constructs a column vector.
+ *
*
MethodDescription *
x.concatHorizontally(y)New matrix will be x next to y. *
x.concatVertically(y)New matrix will be x atop y. @@ -119,7 +119,7 @@ *

To access individual elements, or whole rows and columns, use the following * methods:

* - * + *
*
x.MethodDescription *
x.get(i,j)Get element in row i and column j. *
x.put(i, j, v)Set element in row i and column j to value v @@ -149,7 +149,7 @@ * *

There exist the following Range objects. The Class RangeUtils also * contains the a number of handy helper methods for constructing these ranges.

- * + *
*
Class RangeUtils method Indices *
AllRange all() All legal indices. *
PointRange point(i) A single point. @@ -162,7 +162,7 @@ * *

The following methods can be used for duplicating and copying matrices.

* - * + *
*
MethodDescription *
x.dup()Get a copy of x. *
x.copy(y)Copy the contents of y to x (possible resizing x). @@ -173,7 +173,7 @@ * *

The following methods permit to access the size of a matrix and change its size or shape.

* - * + *
*
x.MethodDescription *
x.rowsNumber of rows. *
x.columnsNumber of columns. @@ -224,7 +224,7 @@ * right-hand-side. The same effect can be achieved by passing a FloatMatrix with * exactly one element.

* - * + *
*
Operation Method Comment *
x + y x.add(y) *
x - y x.sub(y), y.rsub(x) rsub subtracts left from right hand side @@ -238,7 +238,7 @@ * *

There also exist operations which work on whole columns or rows.

* - * + *
* * * @@ -258,7 +258,7 @@ * *

The following comparison operations are available

* - *
Method Description
x.addRowVector adds a vector to each row (addiRowVector works in-place)
x.addColumnVectoradds a vector to each column
+ *
*
Operation Method *
x < y x.lt(y) *
x <= y x.le(y) @@ -273,7 +273,7 @@ * zero is treated as "true" and zero is treated as "false". All operations are carried * out elementwise.

* - * + *
*
Operation Method *
x & y x.and(y) *
x | y x.or(y) @@ -284,7 +284,7 @@ * *

Finally, there are a few more methods to compute various things:

* - * + *
*
Method Description *
x.max() Return maximal element *
x.argmax() Return index of largest element From b3d56798e386f215d30519061d5ae482d576764c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Zbigniew=20J=C4=99drzejewski-Szmek?= Date: Thu, 26 Jan 2017 11:02:43 -0500 Subject: [PATCH 2/2] Fix path to stylesheet and overview --- build.xml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/build.xml b/build.xml index 9fb2fbc..4a7b86e 100644 --- a/build.xml +++ b/build.xml @@ -230,7 +230,8 @@ OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. sourcepath="${src}" defaultexcludes="yes" destdir="${doc}" author="true" version="true" use="true" windowtitle="jblas" linksource="yes" - stylesheetfile="javadoc.css" overview="${src}/overview.html"> + stylesheetfile="src/main/javadoc/stylesheet.css" + overview="src/main/javadoc/overview.html"> jblas - Linear Algebra for Java (version ${version}) ]]> @@ -285,7 +286,6 @@ OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. -