Skip to content

Commit

Permalink
Fix redundant Javadoc phrasing
Browse files Browse the repository at this point in the history
  • Loading branch information
garydgregory committed Feb 12, 2025
1 parent aa1efd8 commit 6898fd4
Show file tree
Hide file tree
Showing 11 changed files with 31 additions and 31 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -227,7 +227,7 @@ protected RealMatrix computeCovarianceMatrix(double[][] data)
* @param xArray first data array
* @param yArray second data array
* @param biasCorrected if true, returned value will be bias-corrected
* @return returns the covariance for the two arrays
* @return the covariance for the two arrays
* @throws MathIllegalArgumentException if the arrays lengths do not match or
* there is insufficient data
*/
Expand Down Expand Up @@ -262,7 +262,7 @@ public double covariance(final double[] xArray, final double[] yArray, boolean b
*
* @param xArray first data array
* @param yArray second data array
* @return returns the covariance for the two arrays
* @return the covariance for the two arrays
* @throws MathIllegalArgumentException if the arrays lengths do not match or
* there is insufficient data
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -148,7 +148,7 @@ public RealMatrix computeCorrelationMatrix(final double[][] matrix) {
*
* @param xArray first data array
* @param yArray second data array
* @return Returns Kendall's Tau rank correlation coefficient for the two arrays
* @return Kendall's Tau rank correlation coefficient for the two arrays
* @throws DimensionMismatchException if the arrays lengths do not match
*/
public double correlation(final double[] xArray, final double[] yArray)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -266,7 +266,7 @@ public RealMatrix computeCorrelationMatrix(double[][] data) {
*
* @param xArray first data array
* @param yArray second data array
* @return Returns Pearson's correlation coefficient for the two arrays
* @return Pearson's correlation coefficient for the two arrays
* @throws DimensionMismatchException if the arrays lengths do not match
* @throws MathIllegalArgumentException if there is insufficient data
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -168,7 +168,7 @@ public RealMatrix computeCorrelationMatrix(final double[][] matrix) {
*
* @param xArray first data array
* @param yArray second data array
* @return Returns Spearman's rank correlation coefficient for the two arrays
* @return Spearman's rank correlation coefficient for the two arrays
* @throws DimensionMismatchException if the arrays lengths do not match
* @throws MathIllegalArgumentException if the array length is less than 2
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -407,7 +407,7 @@ public void setWindowSize(int windowSize) throws MathIllegalArgumentException {
* copy of the underlying data -- i.e., it is not a reference to the
* stored data.
*
* @return returns the current set of numbers in the order in which they
* @return the current set of numbers in the order in which they
* were added to this set
*/
public double[] getValues() {
Expand All @@ -419,7 +419,7 @@ public double[] getValues() {
* sorted in ascending order. The returned array is a fresh
* copy of the underlying data -- i.e., it is not a reference to the
* stored data.
* @return returns the current set of
* @return the current set of
* numbers sorted in ascending order
*/
public double[] getSortedValues() {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -65,55 +65,55 @@ public StatisticalSummaryValues(double mean, double variance, long n,
}

/**
* @return Returns the max.
* @return the max.
*/
@Override
public double getMax() {
return max;
}

/**
* @return Returns the mean.
* @return the mean.
*/
@Override
public double getMean() {
return mean;
}

/**
* @return Returns the min.
* @return the min.
*/
@Override
public double getMin() {
return min;
}

/**
* @return Returns the number of values.
* @return the number of values.
*/
@Override
public long getN() {
return n;
}

/**
* @return Returns the sum.
* @return the sum.
*/
@Override
public double getSum() {
return sum;
}

/**
* @return Returns the standard deviation
* @return the standard deviation
*/
@Override
public double getStandardDeviation() {
return JdkMath.sqrt(variance);
}

/**
* @return Returns the variance.
* @return the variance.
*/
@Override
public double getVariance() {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -228,7 +228,7 @@ public double evaluate(final double[] values, final double mean)
}

/**
* @return Returns the isBiasCorrected.
* @return the isBiasCorrected.
*/
public boolean isBiasCorrected() {
return variance.isBiasCorrected();
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -585,7 +585,7 @@ public double evaluate(final double[] values, final double[] weights, final doub
}

/**
* @return Returns the isBiasCorrected.
* @return the isBiasCorrected.
*/
public boolean isBiasCorrected() {
return isBiasCorrected;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -166,7 +166,7 @@ private NaturalRanking(NaNStrategy nanStrategy,
/**
* Return the NaNStrategy.
*
* @return returns the NaNStrategy
* @return the NaNStrategy
*/
public NaNStrategy getNanStrategy() {
return nanStrategy;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -312,7 +312,7 @@ public void testSampling() {

//------------------ Getters / Setters for test instance data -----------
/**
* @return Returns the cumulativeTestPoints.
* @return the cumulativeTestPoints.
*/
protected int[] getCumulativeTestPoints() {
return cumulativeTestPoints;
Expand All @@ -326,7 +326,7 @@ protected void setCumulativeTestPoints(int[] cumulativeTestPoints) {
}

/**
* @return Returns the cumulativeTestValues.
* @return the cumulativeTestValues.
*/
protected double[] getCumulativeTestValues() {
return cumulativeTestValues;
Expand All @@ -340,7 +340,7 @@ protected void setCumulativeTestValues(double[] cumulativeTestValues) {
}

/**
* @return Returns the densityTestPoints.
* @return the densityTestPoints.
*/
protected int[] getDensityTestPoints() {
return densityTestPoints;
Expand All @@ -354,7 +354,7 @@ protected void setDensityTestPoints(int[] densityTestPoints) {
}

/**
* @return Returns the densityTestValues.
* @return the densityTestValues.
*/
protected double[] getDensityTestValues() {
return densityTestValues;
Expand All @@ -368,7 +368,7 @@ protected void setDensityTestValues(double[] densityTestValues) {
}

/**
* @return Returns the distribution.
* @return the distribution.
*/
protected DiscreteDistribution getDistribution() {
return distribution;
Expand All @@ -382,7 +382,7 @@ protected void setDistribution(DiscreteDistribution distribution) {
}

/**
* @return Returns the inverseCumulativeTestPoints.
* @return the inverseCumulativeTestPoints.
*/
protected double[] getInverseCumulativeTestPoints() {
return inverseCumulativeTestPoints;
Expand All @@ -396,7 +396,7 @@ protected void setInverseCumulativeTestPoints(double[] inverseCumulativeTestPoin
}

/**
* @return Returns the inverseCumulativeTestValues.
* @return the inverseCumulativeTestValues.
*/
protected int[] getInverseCumulativeTestValues() {
return inverseCumulativeTestValues;
Expand All @@ -410,7 +410,7 @@ protected void setInverseCumulativeTestValues(int[] inverseCumulativeTestValues)
}

/**
* @return Returns the tolerance.
* @return the tolerance.
*/
protected double getTolerance() {
return tolerance;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -376,7 +376,7 @@ public double value(double x) {

//------------------ Getters / Setters for test instance data -----------
/**
* @return Returns the cumulativeTestPoints.
* @return the cumulativeTestPoints.
*/
protected double[] getCumulativeTestPoints() {
return cumulativeTestPoints;
Expand All @@ -390,7 +390,7 @@ protected void setCumulativeTestPoints(double[] cumulativeTestPoints) {
}

/**
* @return Returns the cumulativeTestValues.
* @return the cumulativeTestValues.
*/
protected double[] getCumulativeTestValues() {
return cumulativeTestValues;
Expand All @@ -412,7 +412,7 @@ protected void setDensityTestValues(double[] densityTestValues) {
}

/**
* @return Returns the distribution.
* @return the distribution.
*/
protected ContinuousDistribution getDistribution() {
return distribution;
Expand All @@ -426,7 +426,7 @@ protected void setDistribution(ContinuousDistribution distribution) {
}

/**
* @return Returns the inverseCumulativeTestPoints.
* @return the inverseCumulativeTestPoints.
*/
protected double[] getInverseCumulativeTestPoints() {
return inverseCumulativeTestPoints;
Expand All @@ -440,7 +440,7 @@ protected void setInverseCumulativeTestPoints(double[] inverseCumulativeTestPoin
}

/**
* @return Returns the inverseCumulativeTestValues.
* @return the inverseCumulativeTestValues.
*/
protected double[] getInverseCumulativeTestValues() {
return inverseCumulativeTestValues;
Expand All @@ -454,7 +454,7 @@ protected void setInverseCumulativeTestValues(double[] inverseCumulativeTestValu
}

/**
* @return Returns the tolerance.
* @return the tolerance.
*/
protected double getTolerance() {
return tolerance;
Expand Down

0 comments on commit 6898fd4

Please sign in to comment.