Skip to content

Commit 6898fd4

Browse files
committed
Fix redundant Javadoc phrasing
1 parent aa1efd8 commit 6898fd4

File tree

11 files changed

+31
-31
lines changed

11 files changed

+31
-31
lines changed

commons-math-legacy/src/main/java/org/apache/commons/math4/legacy/stat/correlation/Covariance.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -227,7 +227,7 @@ protected RealMatrix computeCovarianceMatrix(double[][] data)
227227
* @param xArray first data array
228228
* @param yArray second data array
229229
* @param biasCorrected if true, returned value will be bias-corrected
230-
* @return returns the covariance for the two arrays
230+
* @return the covariance for the two arrays
231231
* @throws MathIllegalArgumentException if the arrays lengths do not match or
232232
* there is insufficient data
233233
*/
@@ -262,7 +262,7 @@ public double covariance(final double[] xArray, final double[] yArray, boolean b
262262
*
263263
* @param xArray first data array
264264
* @param yArray second data array
265-
* @return returns the covariance for the two arrays
265+
* @return the covariance for the two arrays
266266
* @throws MathIllegalArgumentException if the arrays lengths do not match or
267267
* there is insufficient data
268268
*/

commons-math-legacy/src/main/java/org/apache/commons/math4/legacy/stat/correlation/KendallsCorrelation.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -148,7 +148,7 @@ public RealMatrix computeCorrelationMatrix(final double[][] matrix) {
148148
*
149149
* @param xArray first data array
150150
* @param yArray second data array
151-
* @return Returns Kendall's Tau rank correlation coefficient for the two arrays
151+
* @return Kendall's Tau rank correlation coefficient for the two arrays
152152
* @throws DimensionMismatchException if the arrays lengths do not match
153153
*/
154154
public double correlation(final double[] xArray, final double[] yArray)

commons-math-legacy/src/main/java/org/apache/commons/math4/legacy/stat/correlation/PearsonsCorrelation.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -266,7 +266,7 @@ public RealMatrix computeCorrelationMatrix(double[][] data) {
266266
*
267267
* @param xArray first data array
268268
* @param yArray second data array
269-
* @return Returns Pearson's correlation coefficient for the two arrays
269+
* @return Pearson's correlation coefficient for the two arrays
270270
* @throws DimensionMismatchException if the arrays lengths do not match
271271
* @throws MathIllegalArgumentException if there is insufficient data
272272
*/

commons-math-legacy/src/main/java/org/apache/commons/math4/legacy/stat/correlation/SpearmansCorrelation.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -168,7 +168,7 @@ public RealMatrix computeCorrelationMatrix(final double[][] matrix) {
168168
*
169169
* @param xArray first data array
170170
* @param yArray second data array
171-
* @return Returns Spearman's rank correlation coefficient for the two arrays
171+
* @return Spearman's rank correlation coefficient for the two arrays
172172
* @throws DimensionMismatchException if the arrays lengths do not match
173173
* @throws MathIllegalArgumentException if the array length is less than 2
174174
*/

commons-math-legacy/src/main/java/org/apache/commons/math4/legacy/stat/descriptive/DescriptiveStatistics.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -407,7 +407,7 @@ public void setWindowSize(int windowSize) throws MathIllegalArgumentException {
407407
* copy of the underlying data -- i.e., it is not a reference to the
408408
* stored data.
409409
*
410-
* @return returns the current set of numbers in the order in which they
410+
* @return the current set of numbers in the order in which they
411411
* were added to this set
412412
*/
413413
public double[] getValues() {
@@ -419,7 +419,7 @@ public double[] getValues() {
419419
* sorted in ascending order. The returned array is a fresh
420420
* copy of the underlying data -- i.e., it is not a reference to the
421421
* stored data.
422-
* @return returns the current set of
422+
* @return the current set of
423423
* numbers sorted in ascending order
424424
*/
425425
public double[] getSortedValues() {

commons-math-legacy/src/main/java/org/apache/commons/math4/legacy/stat/descriptive/StatisticalSummaryValues.java

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -65,55 +65,55 @@ public StatisticalSummaryValues(double mean, double variance, long n,
6565
}
6666

6767
/**
68-
* @return Returns the max.
68+
* @return the max.
6969
*/
7070
@Override
7171
public double getMax() {
7272
return max;
7373
}
7474

7575
/**
76-
* @return Returns the mean.
76+
* @return the mean.
7777
*/
7878
@Override
7979
public double getMean() {
8080
return mean;
8181
}
8282

8383
/**
84-
* @return Returns the min.
84+
* @return the min.
8585
*/
8686
@Override
8787
public double getMin() {
8888
return min;
8989
}
9090

9191
/**
92-
* @return Returns the number of values.
92+
* @return the number of values.
9393
*/
9494
@Override
9595
public long getN() {
9696
return n;
9797
}
9898

9999
/**
100-
* @return Returns the sum.
100+
* @return the sum.
101101
*/
102102
@Override
103103
public double getSum() {
104104
return sum;
105105
}
106106

107107
/**
108-
* @return Returns the standard deviation
108+
* @return the standard deviation
109109
*/
110110
@Override
111111
public double getStandardDeviation() {
112112
return JdkMath.sqrt(variance);
113113
}
114114

115115
/**
116-
* @return Returns the variance.
116+
* @return the variance.
117117
*/
118118
@Override
119119
public double getVariance() {

commons-math-legacy/src/main/java/org/apache/commons/math4/legacy/stat/descriptive/moment/StandardDeviation.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -228,7 +228,7 @@ public double evaluate(final double[] values, final double mean)
228228
}
229229

230230
/**
231-
* @return Returns the isBiasCorrected.
231+
* @return the isBiasCorrected.
232232
*/
233233
public boolean isBiasCorrected() {
234234
return variance.isBiasCorrected();

commons-math-legacy/src/main/java/org/apache/commons/math4/legacy/stat/descriptive/moment/Variance.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -585,7 +585,7 @@ public double evaluate(final double[] values, final double[] weights, final doub
585585
}
586586

587587
/**
588-
* @return Returns the isBiasCorrected.
588+
* @return the isBiasCorrected.
589589
*/
590590
public boolean isBiasCorrected() {
591591
return isBiasCorrected;

commons-math-legacy/src/main/java/org/apache/commons/math4/legacy/stat/ranking/NaturalRanking.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -166,7 +166,7 @@ private NaturalRanking(NaNStrategy nanStrategy,
166166
/**
167167
* Return the NaNStrategy.
168168
*
169-
* @return returns the NaNStrategy
169+
* @return the NaNStrategy
170170
*/
171171
public NaNStrategy getNanStrategy() {
172172
return nanStrategy;

commons-math-legacy/src/test/java/org/apache/commons/math4/legacy/distribution/IntegerDistributionAbstractTest.java

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -312,7 +312,7 @@ public void testSampling() {
312312

313313
//------------------ Getters / Setters for test instance data -----------
314314
/**
315-
* @return Returns the cumulativeTestPoints.
315+
* @return the cumulativeTestPoints.
316316
*/
317317
protected int[] getCumulativeTestPoints() {
318318
return cumulativeTestPoints;
@@ -326,7 +326,7 @@ protected void setCumulativeTestPoints(int[] cumulativeTestPoints) {
326326
}
327327

328328
/**
329-
* @return Returns the cumulativeTestValues.
329+
* @return the cumulativeTestValues.
330330
*/
331331
protected double[] getCumulativeTestValues() {
332332
return cumulativeTestValues;
@@ -340,7 +340,7 @@ protected void setCumulativeTestValues(double[] cumulativeTestValues) {
340340
}
341341

342342
/**
343-
* @return Returns the densityTestPoints.
343+
* @return the densityTestPoints.
344344
*/
345345
protected int[] getDensityTestPoints() {
346346
return densityTestPoints;
@@ -354,7 +354,7 @@ protected void setDensityTestPoints(int[] densityTestPoints) {
354354
}
355355

356356
/**
357-
* @return Returns the densityTestValues.
357+
* @return the densityTestValues.
358358
*/
359359
protected double[] getDensityTestValues() {
360360
return densityTestValues;
@@ -368,7 +368,7 @@ protected void setDensityTestValues(double[] densityTestValues) {
368368
}
369369

370370
/**
371-
* @return Returns the distribution.
371+
* @return the distribution.
372372
*/
373373
protected DiscreteDistribution getDistribution() {
374374
return distribution;
@@ -382,7 +382,7 @@ protected void setDistribution(DiscreteDistribution distribution) {
382382
}
383383

384384
/**
385-
* @return Returns the inverseCumulativeTestPoints.
385+
* @return the inverseCumulativeTestPoints.
386386
*/
387387
protected double[] getInverseCumulativeTestPoints() {
388388
return inverseCumulativeTestPoints;
@@ -396,7 +396,7 @@ protected void setInverseCumulativeTestPoints(double[] inverseCumulativeTestPoin
396396
}
397397

398398
/**
399-
* @return Returns the inverseCumulativeTestValues.
399+
* @return the inverseCumulativeTestValues.
400400
*/
401401
protected int[] getInverseCumulativeTestValues() {
402402
return inverseCumulativeTestValues;
@@ -410,7 +410,7 @@ protected void setInverseCumulativeTestValues(int[] inverseCumulativeTestValues)
410410
}
411411

412412
/**
413-
* @return Returns the tolerance.
413+
* @return the tolerance.
414414
*/
415415
protected double getTolerance() {
416416
return tolerance;

0 commit comments

Comments
 (0)