add annotations

Author: ice1000

src/main/java/org/algo4j/linear/ColumnVector.java

@@ -1,11 +1,14 @@
 package org.algo4j.linear;
 
+import org.jetbrains.annotations.NotNull;
+
 @SuppressWarnings({"WeakerAccess", "unused"})
 public class ColumnVector extends Vector {
-public ColumnVector(double[] data) {
+public ColumnVector(@NotNull double[] data) {
 super(true, data);
 }
 
+@NotNull
 public RowVector toRowVector() {
 int L = nativeData().rows();
 double[] data = new double[L];

src/main/java/org/algo4j/linear/Matrix.java

@@ -1,6 +1,7 @@
 package org.algo4j.linear;
 
 import org.algo4j.util.MatrixCaster;
+import org.jetbrains.annotations.NotNull;
 import org.nd4j.linalg.api.ndarray.INDArray;
 import org.nd4j.linalg.factory.Nd4j;
 import org.nd4j.linalg.ops.transforms.Transforms;
@@ -16,98 +17,118 @@
 public class Matrix {
 private INDArray data;
 
-public Matrix(int[][] data) {
+public Matrix(@NotNull int[][] data) {
 this.data = Nd4j.create(MatrixCaster.cast(data));
 }
 
-public Matrix(float[][] data) {
+public Matrix(@NotNull float[][] data) {
 this.data = Nd4j.create(data);
 }
 
-public Matrix(double[][] data) {
+public Matrix(@NotNull double[][] data) {
 this.data = Nd4j.create(data);
 }
 
-Matrix(INDArray array) {
+Matrix(@NotNull INDArray array) {
 this.data = array;
 }
 
+@NotNull
 public INDArray nativeData() {
 return data;
 }
 
+@NotNull
 public Matrix addEach(int n) {
 return new Matrix(data.add(n));
 }
 
+@NotNull
 public Matrix multiplyEach(int n) {
 return new Matrix(data.mul(n));
 }
 
+@NotNull
 public Matrix minusEach(int n) {
 return new Matrix(data.subi(n));
 }
 
+@NotNull
 public Matrix divideEach(int n) {
 return new Matrix(data.divi(n));
 }
 
-public Matrix add(ColumnVector vector) {
+@NotNull
+public Matrix add(@NotNull ColumnVector vector) {
 return new Matrix(data.add(vector.nativeData()));
 }
 
-public Matrix add(RowVector vector) {
+@NotNull
+public Matrix add(@NotNull RowVector vector) {
 return new Matrix(data.add(vector.nativeData()));
 }
 
-public Matrix multiply(ColumnVector vector) {
+@NotNull
+public Matrix multiply(@NotNull ColumnVector vector) {
 return new Matrix(data.mul(vector.nativeData()));
 }
 
-public Matrix multiply(RowVector vector) {
+@NotNull
+public Matrix multiply(@NotNull RowVector vector) {
 return new Matrix(data.mul(vector.nativeData()));
 }
 
-public Matrix minus(ColumnVector vector) {
+@NotNull
+public Matrix minus(@NotNull ColumnVector vector) {
 return new Matrix(data.sub(vector.nativeData()));
 }
 
-public Matrix minus(RowVector vector) {
+@NotNull
+public Matrix minus(@NotNull RowVector vector) {
 return new Matrix(data.sub(vector.nativeData()));
 }
 
-public Matrix divide(ColumnVector vector) {
+@NotNull
+public Matrix divide(@NotNull ColumnVector vector) {
 return new Matrix(data.div(vector.nativeData()));
 }
 
-public Matrix divide(RowVector vector) {
+@NotNull
+public Matrix divide(@NotNull RowVector vector) {
 return new Matrix(data.div(vector.nativeData()));
 }
 
+@NotNull
 public Matrix sigmoid() {
 return new Matrix(Transforms.sigmoid(data));
 }
 
+@NotNull
 public Matrix tanh() {
 return new Matrix(Transforms.tanh(data));
 }
 
+@NotNull
 public Matrix abs() {
 return new Matrix(Transforms.abs(data));
 }
 
+@NotNull
 public Matrix sqrt() {
 return new Matrix(Transforms.sqrt(data));
 }
 
+@NotNull
 public Matrix exp() {
 return new Matrix(Transforms.exp(data));
 }
 
+@NotNull
 public Matrix transpose() {
 return new Matrix(data.transpose());
 }
 
+@NotNull
 public Matrix reshape(int rowN, int columnN) {
 return new Matrix(data.reshape(rowN, columnN));
 }
@@ -116,14 +137,14 @@ public double get(int row, int column) {
 return data.getDouble(row, column);
 }
 
+@NotNull
 public double[][] cast() {
 return MatrixCaster.cast(this);
 }
 
 @Override
+@NotNull
 public String toString() {
-return "Matrix{" +
-"data=" + data.toString() +
-'}';
+return "Matrix{data=" + data.toString() + "}";
 }
 }

src/main/java/org/algo4j/linear/RowVector.java

@@ -1,13 +1,15 @@
 package org.algo4j.linear;
 
 import org.algo4j.util.MatrixCaster;
+import org.jetbrains.annotations.NotNull;
 
 @SuppressWarnings({"WeakerAccess", "unused"})
 public class RowVector extends Vector {
-public RowVector(double[] data) {
+public RowVector(@NotNull double[] data) {
 super(false, data);
 }
 
+@NotNull
 public ColumnVector toColumnVector() {
 return new ColumnVector(MatrixCaster.cast(new Matrix(nativeData()))[0]);
 }

src/main/java/org/algo4j/util/MatrixCaster.java

@@ -1,14 +1,16 @@
 package org.algo4j.util;
 
 import org.algo4j.linear.Matrix;
+import org.jetbrains.annotations.NotNull;
 import org.nd4j.linalg.api.ndarray.INDArray;
 
 public class MatrixCaster {
 private MatrixCaster() {
 throw new Error("do not instantiation me");
 }
 
-public static float[][] cast(int[][] in) {
+@NotNull
+public static float[][] cast(@NotNull int[][] in) {
 int inL = in.length;
 float[][] out = new float[inL][in[0].length];
 
@@ -21,7 +23,8 @@ public static float[][] cast(int[][] in) {
 return out;
 }
 
-public static double[][] cast(Matrix inM) {
+@NotNull
+public static double[][] cast(@NotNull Matrix inM) {
 INDArray in = inM.nativeData();
 int l = in.length();
 double[][] out = new double[l][in.size(0)];