commons-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From pste...@apache.org
Subject [math] Added missing @since tags.
Date Sun, 15 Nov 2015 20:40:12 GMT
Repository: commons-math
Updated Branches:
  refs/heads/master 2e87f2934 -> 029b692aa


Added missing @since tags.


Project: http://git-wip-us.apache.org/repos/asf/commons-math/repo
Commit: http://git-wip-us.apache.org/repos/asf/commons-math/commit/029b692a
Tree: http://git-wip-us.apache.org/repos/asf/commons-math/tree/029b692a
Diff: http://git-wip-us.apache.org/repos/asf/commons-math/diff/029b692a

Branch: refs/heads/master
Commit: 029b692aabd6b3c32862b579ffea7d86b818a992
Parents: 2e87f29
Author: Phil Steitz <phil.steitz@gmail.com>
Authored: Sun Nov 15 13:40:06 2015 -0700
Committer: Phil Steitz <phil.steitz@gmail.com>
Committed: Sun Nov 15 13:40:06 2015 -0700

----------------------------------------------------------------------
 .../java/org/apache/commons/math4/ml/neuralnet/Network.java     | 1 +
 src/main/java/org/apache/commons/math4/ml/neuralnet/Neuron.java | 3 +++
 .../commons/math4/ml/neuralnet/twod/NeuronSquareMesh2D.java     | 3 +++
 .../commons/math4/ml/neuralnet/twod/util/HitHistogram.java      | 1 +
 .../commons/math4/ml/neuralnet/twod/util/LocationFinder.java    | 1 +
 .../math4/ml/neuralnet/twod/util/MapDataVisualization.java      | 1 +
 .../commons/math4/ml/neuralnet/twod/util/MapVisualization.java  | 1 +
 .../commons/math4/ml/neuralnet/twod/util/QuantizationError.java | 1 +
 .../math4/ml/neuralnet/twod/util/SmoothedDataHistogram.java     | 1 +
 .../math4/ml/neuralnet/twod/util/TopographicErrorHistogram.java | 1 +
 .../math4/ml/neuralnet/twod/util/UnifiedDistanceMatrix.java     | 1 +
 src/main/java/org/apache/commons/math4/util/MathArrays.java     | 5 +++++
 12 files changed, 20 insertions(+)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/commons-math/blob/029b692a/src/main/java/org/apache/commons/math4/ml/neuralnet/Network.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/commons/math4/ml/neuralnet/Network.java b/src/main/java/org/apache/commons/math4/ml/neuralnet/Network.java
index a223929..6dcd729 100644
--- a/src/main/java/org/apache/commons/math4/ml/neuralnet/Network.java
+++ b/src/main/java/org/apache/commons/math4/ml/neuralnet/Network.java
@@ -143,6 +143,7 @@ public class Network
      * Updating one will not affect the other.
      *
      * @return a new instance with the same state as this instance.
+     * @since 3.6
      */
     public synchronized Network copy() {
         final Network copy = new Network(nextId.get(),

http://git-wip-us.apache.org/repos/asf/commons-math/blob/029b692a/src/main/java/org/apache/commons/math4/ml/neuralnet/Neuron.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/commons/math4/ml/neuralnet/Neuron.java b/src/main/java/org/apache/commons/math4/ml/neuralnet/Neuron.java
index b45bfa9..56f1976 100644
--- a/src/main/java/org/apache/commons/math4/ml/neuralnet/Neuron.java
+++ b/src/main/java/org/apache/commons/math4/ml/neuralnet/Neuron.java
@@ -72,6 +72,7 @@ public class Neuron implements Serializable {
      * Updating one will not affect the other.
      *
      * @return a new instance with the same state as this instance.
+     * @since 3.6
      */
     public synchronized Neuron copy() {
         final Neuron copy = new Neuron(getIdentifier(),
@@ -173,6 +174,7 @@ public class Neuron implements Serializable {
      * may be required to ensure consistency.
      *
      * @return the number of update attempts.
+     * @since 3.6
      */
     public long getNumberOfAttemptedUpdates() {
         return numberOfAttemptedUpdates.get();
@@ -187,6 +189,7 @@ public class Neuron implements Serializable {
      * may be required to ensure consistency.
      *
      * @return the number of successful updates.
+     * @since 3.6
      */
     public long getNumberOfSuccessfulUpdates() {
         return numberOfSuccessfulUpdates.get();

http://git-wip-us.apache.org/repos/asf/commons-math/blob/029b692a/src/main/java/org/apache/commons/math4/ml/neuralnet/twod/NeuronSquareMesh2D.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/commons/math4/ml/neuralnet/twod/NeuronSquareMesh2D.java
b/src/main/java/org/apache/commons/math4/ml/neuralnet/twod/NeuronSquareMesh2D.java
index 56ac1e2..38bd608 100644
--- a/src/main/java/org/apache/commons/math4/ml/neuralnet/twod/NeuronSquareMesh2D.java
+++ b/src/main/java/org/apache/commons/math4/ml/neuralnet/twod/NeuronSquareMesh2D.java
@@ -68,6 +68,7 @@ public class NeuronSquareMesh2D
 
     /**
      * Horizontal (along row) direction.
+     * @since 3.6
      */
     public enum HorizontalDirection {
         /** Column at the right of the current column. */
@@ -79,6 +80,7 @@ public class NeuronSquareMesh2D
     }
     /**
      * Vertical (along column) direction.
+     * @since 3.6
      */
     public enum VerticalDirection {
         /** Row above the current row. */
@@ -230,6 +232,7 @@ public class NeuronSquareMesh2D
      * Updating one will not affect the other.
      *
      * @return a new instance with the same state as this instance.
+     * @since 3.6
      */
     public synchronized NeuronSquareMesh2D copy() {
         final long[][] idGrid = new long[numberOfRows][numberOfColumns];

http://git-wip-us.apache.org/repos/asf/commons-math/blob/029b692a/src/main/java/org/apache/commons/math4/ml/neuralnet/twod/util/HitHistogram.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/commons/math4/ml/neuralnet/twod/util/HitHistogram.java
b/src/main/java/org/apache/commons/math4/ml/neuralnet/twod/util/HitHistogram.java
index e913faf..98d253f 100644
--- a/src/main/java/org/apache/commons/math4/ml/neuralnet/twod/util/HitHistogram.java
+++ b/src/main/java/org/apache/commons/math4/ml/neuralnet/twod/util/HitHistogram.java
@@ -26,6 +26,7 @@ import org.apache.commons.math4.ml.distance.DistanceMeasure;
  * Computes the hit histogram.
  * Each bin will contain the number of data for which the corresponding
  * neuron is the best matching unit.
+ * @since 3.6
  */
 public class HitHistogram implements MapDataVisualization {
     /** Distance. */

http://git-wip-us.apache.org/repos/asf/commons-math/blob/029b692a/src/main/java/org/apache/commons/math4/ml/neuralnet/twod/util/LocationFinder.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/commons/math4/ml/neuralnet/twod/util/LocationFinder.java
b/src/main/java/org/apache/commons/math4/ml/neuralnet/twod/util/LocationFinder.java
index 7450c94..fa02e3a 100644
--- a/src/main/java/org/apache/commons/math4/ml/neuralnet/twod/util/LocationFinder.java
+++ b/src/main/java/org/apache/commons/math4/ml/neuralnet/twod/util/LocationFinder.java
@@ -25,6 +25,7 @@ import org.apache.commons.math4.exception.MathIllegalStateException;
 
 /**
  * Helper class to find the grid coordinates of a neuron.
+ * @since 3.6
  */
 public class LocationFinder {
     /** Identifier to location mapping. */

http://git-wip-us.apache.org/repos/asf/commons-math/blob/029b692a/src/main/java/org/apache/commons/math4/ml/neuralnet/twod/util/MapDataVisualization.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/commons/math4/ml/neuralnet/twod/util/MapDataVisualization.java
b/src/main/java/org/apache/commons/math4/ml/neuralnet/twod/util/MapDataVisualization.java
index 00a6b8d..25f1866 100644
--- a/src/main/java/org/apache/commons/math4/ml/neuralnet/twod/util/MapDataVisualization.java
+++ b/src/main/java/org/apache/commons/math4/ml/neuralnet/twod/util/MapDataVisualization.java
@@ -22,6 +22,7 @@ import org.apache.commons.math4.ml.neuralnet.twod.NeuronSquareMesh2D;
 /**
  * Interface for algorithms that compute some metrics of the projection of
  * data on a 2D-map.
+ * @since 3.6
  */
 public interface MapDataVisualization {
     /**

http://git-wip-us.apache.org/repos/asf/commons-math/blob/029b692a/src/main/java/org/apache/commons/math4/ml/neuralnet/twod/util/MapVisualization.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/commons/math4/ml/neuralnet/twod/util/MapVisualization.java
b/src/main/java/org/apache/commons/math4/ml/neuralnet/twod/util/MapVisualization.java
index b5d6873..e73d342 100644
--- a/src/main/java/org/apache/commons/math4/ml/neuralnet/twod/util/MapVisualization.java
+++ b/src/main/java/org/apache/commons/math4/ml/neuralnet/twod/util/MapVisualization.java
@@ -21,6 +21,7 @@ import org.apache.commons.math4.ml.neuralnet.twod.NeuronSquareMesh2D;
 
 /**
  * Interface for algorithms that compute some property of a 2D-map.
+ * @since 3.6
  */
 public interface MapVisualization {
     /**

http://git-wip-us.apache.org/repos/asf/commons-math/blob/029b692a/src/main/java/org/apache/commons/math4/ml/neuralnet/twod/util/QuantizationError.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/commons/math4/ml/neuralnet/twod/util/QuantizationError.java
b/src/main/java/org/apache/commons/math4/ml/neuralnet/twod/util/QuantizationError.java
index e7bb19e..37b1c3d 100644
--- a/src/main/java/org/apache/commons/math4/ml/neuralnet/twod/util/QuantizationError.java
+++ b/src/main/java/org/apache/commons/math4/ml/neuralnet/twod/util/QuantizationError.java
@@ -26,6 +26,7 @@ import org.apache.commons.math4.ml.distance.DistanceMeasure;
  * Computes the quantization error histogram.
  * Each bin will contain the average of the distances between samples
  * mapped to the corresponding unit and the weight vector of that unit.
+ * @since 3.6
  */
 public class QuantizationError implements MapDataVisualization {
     /** Distance. */

http://git-wip-us.apache.org/repos/asf/commons-math/blob/029b692a/src/main/java/org/apache/commons/math4/ml/neuralnet/twod/util/SmoothedDataHistogram.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/commons/math4/ml/neuralnet/twod/util/SmoothedDataHistogram.java
b/src/main/java/org/apache/commons/math4/ml/neuralnet/twod/util/SmoothedDataHistogram.java
index bdab570..6db74d9 100644
--- a/src/main/java/org/apache/commons/math4/ml/neuralnet/twod/util/SmoothedDataHistogram.java
+++ b/src/main/java/org/apache/commons/math4/ml/neuralnet/twod/util/SmoothedDataHistogram.java
@@ -31,6 +31,7 @@ import org.apache.commons.math4.exception.NumberIsTooSmallException;
  *  <br>
  *  by Elias Pampalk, Andreas Rauber and Dieter Merkl.
  * </quote>
+ * @since 3.6
  */
 public class SmoothedDataHistogram implements MapDataVisualization {
     /** Smoothing parameter. */

http://git-wip-us.apache.org/repos/asf/commons-math/blob/029b692a/src/main/java/org/apache/commons/math4/ml/neuralnet/twod/util/TopographicErrorHistogram.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/commons/math4/ml/neuralnet/twod/util/TopographicErrorHistogram.java
b/src/main/java/org/apache/commons/math4/ml/neuralnet/twod/util/TopographicErrorHistogram.java
index 0543ce0..e3683c1 100644
--- a/src/main/java/org/apache/commons/math4/ml/neuralnet/twod/util/TopographicErrorHistogram.java
+++ b/src/main/java/org/apache/commons/math4/ml/neuralnet/twod/util/TopographicErrorHistogram.java
@@ -28,6 +28,7 @@ import org.apache.commons.math4.util.Pair;
  * Computes the topographic error histogram.
  * Each bin will contain the number of data for which the first and
  * second best matching units are not adjacent in the map.
+ * @since 3.6
  */
 public class TopographicErrorHistogram implements MapDataVisualization {
     /** Distance. */

http://git-wip-us.apache.org/repos/asf/commons-math/blob/029b692a/src/main/java/org/apache/commons/math4/ml/neuralnet/twod/util/UnifiedDistanceMatrix.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/commons/math4/ml/neuralnet/twod/util/UnifiedDistanceMatrix.java
b/src/main/java/org/apache/commons/math4/ml/neuralnet/twod/util/UnifiedDistanceMatrix.java
index 7e6af35..b76e847 100644
--- a/src/main/java/org/apache/commons/math4/ml/neuralnet/twod/util/UnifiedDistanceMatrix.java
+++ b/src/main/java/org/apache/commons/math4/ml/neuralnet/twod/util/UnifiedDistanceMatrix.java
@@ -26,6 +26,7 @@ import org.apache.commons.math4.ml.distance.DistanceMeasure;
 /**
  * <a href="http://en.wikipedia.org/wiki/U-Matrix">U-Matrix</a>
  * visualization of high-dimensional data projection.
+ * @since 3.6
  */
 public class UnifiedDistanceMatrix implements MapVisualization {
     /** Whether to show distance between each pair of neighbouring units. */

http://git-wip-us.apache.org/repos/asf/commons-math/blob/029b692a/src/main/java/org/apache/commons/math4/util/MathArrays.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/commons/math4/util/MathArrays.java b/src/main/java/org/apache/commons/math4/util/MathArrays.java
index e939fcc..71c6d31 100644
--- a/src/main/java/org/apache/commons/math4/util/MathArrays.java
+++ b/src/main/java/org/apache/commons/math4/util/MathArrays.java
@@ -249,6 +249,7 @@ public class MathArrays {
      * @param v1 Cartesian coordinates of the first vector.
      * @param v2 Cartesian coordinates of the second vector.
      * @return the cosine of the angle between the vectors.
+     * @since 3.6
      */
     public static double cosAngle(double[] v1, double[] v2) {
         return linearCombination(v1, v2) / (safeNorm(v1) * safeNorm(v2));
@@ -391,6 +392,7 @@ public class MathArrays {
      * @return {@code true} if the arrays have the same length.
      * @throws DimensionMismatchException if the lengths differ and
      * {@code abort} is {@code true}.
+     * @since 3.6
      */
     public static boolean checkEqualLength(double[] a,
                                            double[] b,
@@ -411,6 +413,7 @@ public class MathArrays {
      * @param a Array.
      * @param b Array.
      * @throws DimensionMismatchException if the lengths differ.
+     * @since 3.6
      */
     public static void checkEqualLength(double[] a,
                                         double[] b) {
@@ -427,6 +430,7 @@ public class MathArrays {
      * @return {@code true} if the arrays have the same length.
      * @throws DimensionMismatchException if the lengths differ and
      * {@code abort} is {@code true}.
+     * @since 3.6
      */
     public static boolean checkEqualLength(int[] a,
                                            int[] b,
@@ -447,6 +451,7 @@ public class MathArrays {
      * @param a Array.
      * @param b Array.
      * @throws DimensionMismatchException if the lengths differ.
+     * @since 3.6
      */
     public static void checkEqualLength(int[] a,
                                         int[] b) {


Mime
View raw message