You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@commons.apache.org by ps...@apache.org on 2015/05/13 21:14:27 UTC
[2/2] [math] Document NPE. JIRA: MATH-1224.
Document NPE. JIRA: MATH-1224.
Project: http://git-wip-us.apache.org/repos/asf/commons-math/repo
Commit: http://git-wip-us.apache.org/repos/asf/commons-math/commit/fbf6259e
Tree: http://git-wip-us.apache.org/repos/asf/commons-math/tree/fbf6259e
Diff: http://git-wip-us.apache.org/repos/asf/commons-math/diff/fbf6259e
Branch: refs/heads/MATH_3_X
Commit: fbf6259e0fd4fc85ff55ff7a496b40f98cca43f0
Parents: 38021f3
Author: Phil Steitz <ph...@gmail.com>
Authored: Wed May 13 12:10:33 2015 -0700
Committer: Phil Steitz <ph...@gmail.com>
Committed: Wed May 13 12:10:33 2015 -0700
----------------------------------------------------------------------
.../commons/math3/stat/correlation/SpearmansCorrelation.java | 3 +++
1 file changed, 3 insertions(+)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/commons-math/blob/fbf6259e/src/main/java/org/apache/commons/math3/stat/correlation/SpearmansCorrelation.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/commons/math3/stat/correlation/SpearmansCorrelation.java b/src/main/java/org/apache/commons/math3/stat/correlation/SpearmansCorrelation.java
index fbc80de..80c0a54 100644
--- a/src/main/java/org/apache/commons/math3/stat/correlation/SpearmansCorrelation.java
+++ b/src/main/java/org/apache/commons/math3/stat/correlation/SpearmansCorrelation.java
@@ -106,6 +106,7 @@ public class SpearmansCorrelation {
* Calculate the Spearman Rank Correlation Matrix.
*
* @return Spearman Rank Correlation Matrix
+ * @throws NullPointerException if this instance was created with no data
*/
public RealMatrix getCorrelationMatrix() {
return rankCorrelation.getCorrelationMatrix();
@@ -121,6 +122,8 @@ public class SpearmansCorrelation {
* configured <code>RankingAlgorithm</code> to each of the columns of
* <code>matrix.</code>
*
+ * <p>Returns null if this instance was created with no data.</p>
+ *
* @return PearsonsCorrelation among ranked column data
*/
public PearsonsCorrelation getRankCorrelation() {