Google Git
Sign in
vanadium / third_party / f3f8ecf501af34dcff5dc09ab99fbc11aab47945 / . / java / commons-math3-3.3 / docs / apidocs / org / apache / commons / math3 / stat / correlation / Covariance.html
blob: 7ddbddf47089e1f86bcff3a6cf596285a482bafe [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html" charset="UTF-8">
<title>Covariance (Apache Commons Math 3.3 API)</title>
<link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style">
</head>
<body>
<script type="text/javascript"><!--
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="Covariance (Apache Commons Math 3.3 API)";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar_top">
<!-- -->
</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/Covariance.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../../help-doc.html">Help</a></li>
</ul>
<div class="aboutLanguage"><em><script type="text/javascript" src="http://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script></em></div>
</div>
<div class="subNav">
<ul class="navList">
<li>Prev Class</li>
<li><a href="../../../../../../org/apache/commons/math3/stat/correlation/KendallsCorrelation.html" title="class in org.apache.commons.math3.stat.correlation"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?org/apache/commons/math3/stat/correlation/Covariance.html" target="_top">Frames</a></li>
<li><a href="Covariance.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor_summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor_detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">org.apache.commons.math3.stat.correlation</div>
<h2 title="Class Covariance" class="title">Class Covariance</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li>
<li>
<ul class="inheritance">
<li>org.apache.commons.math3.stat.correlation.Covariance</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>Direct Known Subclasses:</dt>
<dd><a href="../../../../../../org/apache/commons/math3/stat/correlation/StorelessCovariance.html" title="class in org.apache.commons.math3.stat.correlation">StorelessCovariance</a></dd>
</dl>
<hr>
<br>
<pre>public class <span class="strong">Covariance</span>
extends <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></pre>
<div class="block">Computes covariances for pairs of arrays or columns of a matrix.
<p>The constructors that take <code>RealMatrix</code> or
<code>double[][]</code> arguments generate covariance matrices. The
columns of the input matrices are assumed to represent variable values.</p>
<p>The constructor argument <code>biasCorrected</code> determines whether or
not computed covariances are bias-corrected.</p>
<p>Unbiased covariances are given by the formula</p>
<code>cov(X, Y) = &Sigma;[(x<sub>i</sub> - E(X))(y<sub>i</sub> - E(Y))] / (n - 1)</code>
where <code>E(X)</code> is the mean of <code>X</code> and <code>E(Y)</code>
is the mean of the <code>Y</code> values.
<p>Non-bias-corrected estimates use <code>n</code> in place of <code>n - 1</code></div>
<dl><dt><span class="strong">Since:</span></dt>
<dd>2.0</dd>
<dt><span class="strong">Version:</span></dt>
<dd>$Id: Covariance.java 1453271 2013-03-06 10:29:51Z luc $</dd></dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><strong><a href="../../../../../../org/apache/commons/math3/stat/correlation/Covariance.html#Covariance()">Covariance</a></strong>()</code>
<div class="block">Create a Covariance with no data</div>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><strong><a href="../../../../../../org/apache/commons/math3/stat/correlation/Covariance.html#Covariance(double[][])">Covariance</a></strong>(double[][]&nbsp;data)</code>
<div class="block">Create a Covariance matrix from a rectangular array
whose columns represent covariates.</div>
</td>
</tr>
<tr class="altColor">
<td class="colOne"><code><strong><a href="../../../../../../org/apache/commons/math3/stat/correlation/Covariance.html#Covariance(double[][], boolean)">Covariance</a></strong>(double[][]&nbsp;data,
boolean&nbsp;biasCorrected)</code>
<div class="block">Create a Covariance matrix from a rectangular array
whose columns represent covariates.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><strong><a href="../../../../../../org/apache/commons/math3/stat/correlation/Covariance.html#Covariance(org.apache.commons.math3.linear.RealMatrix)">Covariance</a></strong>(<a href="../../../../../../org/apache/commons/math3/linear/RealMatrix.html" title="interface in org.apache.commons.math3.linear">RealMatrix</a>&nbsp;matrix)</code>
<div class="block">Create a covariance matrix from a matrix whose columns
represent covariates.</div>
</td>
</tr>
<tr class="altColor">
<td class="colOne"><code><strong><a href="../../../../../../org/apache/commons/math3/stat/correlation/Covariance.html#Covariance(org.apache.commons.math3.linear.RealMatrix, boolean)">Covariance</a></strong>(<a href="../../../../../../org/apache/commons/math3/linear/RealMatrix.html" title="interface in org.apache.commons.math3.linear">RealMatrix</a>&nbsp;matrix,
boolean&nbsp;biasCorrected)</code>
<div class="block">Create a covariance matrix from a matrix whose columns
represent covariates.</div>
</td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method_summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span>Methods</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected <a href="../../../../../../org/apache/commons/math3/linear/RealMatrix.html" title="interface in org.apache.commons.math3.linear">RealMatrix</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../../org/apache/commons/math3/stat/correlation/Covariance.html#computeCovarianceMatrix(double[][])">computeCovarianceMatrix</a></strong>(double[][]&nbsp;data)</code>
<div class="block">Create a covariance matrix from a rectangular array whose columns represent
covariates.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected <a href="../../../../../../org/apache/commons/math3/linear/RealMatrix.html" title="interface in org.apache.commons.math3.linear">RealMatrix</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../../org/apache/commons/math3/stat/correlation/Covariance.html#computeCovarianceMatrix(double[][], boolean)">computeCovarianceMatrix</a></strong>(double[][]&nbsp;data,
boolean&nbsp;biasCorrected)</code>
<div class="block">Compute a covariance matrix from a rectangular array whose columns represent
covariates.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected <a href="../../../../../../org/apache/commons/math3/linear/RealMatrix.html" title="interface in org.apache.commons.math3.linear">RealMatrix</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../../org/apache/commons/math3/stat/correlation/Covariance.html#computeCovarianceMatrix(org.apache.commons.math3.linear.RealMatrix)">computeCovarianceMatrix</a></strong>(<a href="../../../../../../org/apache/commons/math3/linear/RealMatrix.html" title="interface in org.apache.commons.math3.linear">RealMatrix</a>&nbsp;matrix)</code>
<div class="block">Create a covariance matrix from a matrix whose columns represent
covariates.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected <a href="../../../../../../org/apache/commons/math3/linear/RealMatrix.html" title="interface in org.apache.commons.math3.linear">RealMatrix</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../../org/apache/commons/math3/stat/correlation/Covariance.html#computeCovarianceMatrix(org.apache.commons.math3.linear.RealMatrix, boolean)">computeCovarianceMatrix</a></strong>(<a href="../../../../../../org/apache/commons/math3/linear/RealMatrix.html" title="interface in org.apache.commons.math3.linear">RealMatrix</a>&nbsp;matrix,
boolean&nbsp;biasCorrected)</code>
<div class="block">Compute a covariance matrix from a matrix whose columns represent
covariates.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>double</code></td>
<td class="colLast"><code><strong><a href="../../../../../../org/apache/commons/math3/stat/correlation/Covariance.html#covariance(double[], double[])">covariance</a></strong>(double[]&nbsp;xArray,
double[]&nbsp;yArray)</code>
<div class="block">Computes the covariance between the two arrays, using the bias-corrected
formula.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>double</code></td>
<td class="colLast"><code><strong><a href="../../../../../../org/apache/commons/math3/stat/correlation/Covariance.html#covariance(double[], double[], boolean)">covariance</a></strong>(double[]&nbsp;xArray,
double[]&nbsp;yArray,
boolean&nbsp;biasCorrected)</code>
<div class="block">Computes the covariance between the two arrays.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../../../org/apache/commons/math3/linear/RealMatrix.html" title="interface in org.apache.commons.math3.linear">RealMatrix</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../../org/apache/commons/math3/stat/correlation/Covariance.html#getCovarianceMatrix()">getCovarianceMatrix</a></strong>()</code>
<div class="block">Returns the covariance matrix</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../../../../../org/apache/commons/math3/stat/correlation/Covariance.html#getN()">getN</a></strong>()</code>
<div class="block">Returns the number of observations (length of covariate vectors)</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3>
<code><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang">clone</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang">equals</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang">finalize</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang">toString</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait(long, int)" title="class or interface in java.lang">wait</a></code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="Covariance()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>Covariance</h4>
<pre>public&nbsp;Covariance()</pre>
<div class="block">Create a Covariance with no data</div>
</li>
</ul>
<a name="Covariance(double[][], boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>Covariance</h4>
<pre>public&nbsp;Covariance(double[][]&nbsp;data,
boolean&nbsp;biasCorrected)
throws <a href="../../../../../../org/apache/commons/math3/exception/MathIllegalArgumentException.html" title="class in org.apache.commons.math3.exception">MathIllegalArgumentException</a>,
<a href="../../../../../../org/apache/commons/math3/exception/NotStrictlyPositiveException.html" title="class in org.apache.commons.math3.exception">NotStrictlyPositiveException</a></pre>
<div class="block">Create a Covariance matrix from a rectangular array
whose columns represent covariates.
<p>The <code>biasCorrected</code> parameter determines whether or not
covariance estimates are bias-corrected.</p>
<p>The input array must be rectangular with at least one column
and two rows.</p></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>data</code> - rectangular array with columns representing covariates</dd><dd><code>biasCorrected</code> - true means covariances are bias-corrected</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../../../../../org/apache/commons/math3/exception/MathIllegalArgumentException.html" title="class in org.apache.commons.math3.exception">MathIllegalArgumentException</a></code> - if the input data array is not
rectangular with at least two rows and one column.</dd>
<dd><code><a href="../../../../../../org/apache/commons/math3/exception/NotStrictlyPositiveException.html" title="class in org.apache.commons.math3.exception">NotStrictlyPositiveException</a></code> - if the input data array is not
rectangular with at least one row and one column.</dd></dl>
</li>
</ul>
<a name="Covariance(double[][])">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>Covariance</h4>
<pre>public&nbsp;Covariance(double[][]&nbsp;data)
throws <a href="../../../../../../org/apache/commons/math3/exception/MathIllegalArgumentException.html" title="class in org.apache.commons.math3.exception">MathIllegalArgumentException</a>,
<a href="../../../../../../org/apache/commons/math3/exception/NotStrictlyPositiveException.html" title="class in org.apache.commons.math3.exception">NotStrictlyPositiveException</a></pre>
<div class="block">Create a Covariance matrix from a rectangular array
whose columns represent covariates.
<p>The input array must be rectangular with at least one column
and two rows</p></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>data</code> - rectangular array with columns representing covariates</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../../../../../org/apache/commons/math3/exception/MathIllegalArgumentException.html" title="class in org.apache.commons.math3.exception">MathIllegalArgumentException</a></code> - if the input data array is not
rectangular with at least two rows and one column.</dd>
<dd><code><a href="../../../../../../org/apache/commons/math3/exception/NotStrictlyPositiveException.html" title="class in org.apache.commons.math3.exception">NotStrictlyPositiveException</a></code> - if the input data array is not
rectangular with at least one row and one column.</dd></dl>
</li>
</ul>
<a name="Covariance(org.apache.commons.math3.linear.RealMatrix, boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>Covariance</h4>
<pre>public&nbsp;Covariance(<a href="../../../../../../org/apache/commons/math3/linear/RealMatrix.html" title="interface in org.apache.commons.math3.linear">RealMatrix</a>&nbsp;matrix,
boolean&nbsp;biasCorrected)
throws <a href="../../../../../../org/apache/commons/math3/exception/MathIllegalArgumentException.html" title="class in org.apache.commons.math3.exception">MathIllegalArgumentException</a></pre>
<div class="block">Create a covariance matrix from a matrix whose columns
represent covariates.
<p>The <code>biasCorrected</code> parameter determines whether or not
covariance estimates are bias-corrected.</p>
<p>The matrix must have at least one column and two rows</p></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>matrix</code> - matrix with columns representing covariates</dd><dd><code>biasCorrected</code> - true means covariances are bias-corrected</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../../../../../org/apache/commons/math3/exception/MathIllegalArgumentException.html" title="class in org.apache.commons.math3.exception">MathIllegalArgumentException</a></code> - if the input matrix does not have
at least two rows and one column</dd></dl>
</li>
</ul>
<a name="Covariance(org.apache.commons.math3.linear.RealMatrix)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>Covariance</h4>
<pre>public&nbsp;Covariance(<a href="../../../../../../org/apache/commons/math3/linear/RealMatrix.html" title="interface in org.apache.commons.math3.linear">RealMatrix</a>&nbsp;matrix)
throws <a href="../../../../../../org/apache/commons/math3/exception/MathIllegalArgumentException.html" title="class in org.apache.commons.math3.exception">MathIllegalArgumentException</a></pre>
<div class="block">Create a covariance matrix from a matrix whose columns
represent covariates.
<p>The matrix must have at least one column and two rows</p></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>matrix</code> - matrix with columns representing covariates</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../../../../../org/apache/commons/math3/exception/MathIllegalArgumentException.html" title="class in org.apache.commons.math3.exception">MathIllegalArgumentException</a></code> - if the input matrix does not have
at least two rows and one column</dd></dl>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="getCovarianceMatrix()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getCovarianceMatrix</h4>
<pre>public&nbsp;<a href="../../../../../../org/apache/commons/math3/linear/RealMatrix.html" title="interface in org.apache.commons.math3.linear">RealMatrix</a>&nbsp;getCovarianceMatrix()</pre>
<div class="block">Returns the covariance matrix</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>covariance matrix</dd></dl>
</li>
</ul>
<a name="getN()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getN</h4>
<pre>public&nbsp;int&nbsp;getN()</pre>
<div class="block">Returns the number of observations (length of covariate vectors)</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>number of observations</dd></dl>
</li>
</ul>
<a name="computeCovarianceMatrix(org.apache.commons.math3.linear.RealMatrix, boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>computeCovarianceMatrix</h4>
<pre>protected&nbsp;<a href="../../../../../../org/apache/commons/math3/linear/RealMatrix.html" title="interface in org.apache.commons.math3.linear">RealMatrix</a>&nbsp;computeCovarianceMatrix(<a href="../../../../../../org/apache/commons/math3/linear/RealMatrix.html" title="interface in org.apache.commons.math3.linear">RealMatrix</a>&nbsp;matrix,
boolean&nbsp;biasCorrected)
throws <a href="../../../../../../org/apache/commons/math3/exception/MathIllegalArgumentException.html" title="class in org.apache.commons.math3.exception">MathIllegalArgumentException</a></pre>
<div class="block">Compute a covariance matrix from a matrix whose columns represent
covariates.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>matrix</code> - input matrix (must have at least one column and two rows)</dd><dd><code>biasCorrected</code> - determines whether or not covariance estimates are bias-corrected</dd>
<dt><span class="strong">Returns:</span></dt><dd>covariance matrix</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../../../../../org/apache/commons/math3/exception/MathIllegalArgumentException.html" title="class in org.apache.commons.math3.exception">MathIllegalArgumentException</a></code> - if the matrix does not contain sufficient data</dd></dl>
</li>
</ul>
<a name="computeCovarianceMatrix(org.apache.commons.math3.linear.RealMatrix)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>computeCovarianceMatrix</h4>
<pre>protected&nbsp;<a href="../../../../../../org/apache/commons/math3/linear/RealMatrix.html" title="interface in org.apache.commons.math3.linear">RealMatrix</a>&nbsp;computeCovarianceMatrix(<a href="../../../../../../org/apache/commons/math3/linear/RealMatrix.html" title="interface in org.apache.commons.math3.linear">RealMatrix</a>&nbsp;matrix)
throws <a href="../../../../../../org/apache/commons/math3/exception/MathIllegalArgumentException.html" title="class in org.apache.commons.math3.exception">MathIllegalArgumentException</a></pre>
<div class="block">Create a covariance matrix from a matrix whose columns represent
covariates. Covariances are computed using the bias-corrected formula.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>matrix</code> - input matrix (must have at least one column and two rows)</dd>
<dt><span class="strong">Returns:</span></dt><dd>covariance matrix</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../../../../../org/apache/commons/math3/exception/MathIllegalArgumentException.html" title="class in org.apache.commons.math3.exception">MathIllegalArgumentException</a></code> - if matrix does not contain sufficient data</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../../org/apache/commons/math3/stat/correlation/Covariance.html#Covariance(org.apache.commons.math3.linear.RealMatrix)"><code>Covariance(org.apache.commons.math3.linear.RealMatrix)</code></a></dd></dl>
</li>
</ul>
<a name="computeCovarianceMatrix(double[][], boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>computeCovarianceMatrix</h4>
<pre>protected&nbsp;<a href="../../../../../../org/apache/commons/math3/linear/RealMatrix.html" title="interface in org.apache.commons.math3.linear">RealMatrix</a>&nbsp;computeCovarianceMatrix(double[][]&nbsp;data,
boolean&nbsp;biasCorrected)
throws <a href="../../../../../../org/apache/commons/math3/exception/MathIllegalArgumentException.html" title="class in org.apache.commons.math3.exception">MathIllegalArgumentException</a>,
<a href="../../../../../../org/apache/commons/math3/exception/NotStrictlyPositiveException.html" title="class in org.apache.commons.math3.exception">NotStrictlyPositiveException</a></pre>
<div class="block">Compute a covariance matrix from a rectangular array whose columns represent
covariates.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>data</code> - input array (must have at least one column and two rows)</dd><dd><code>biasCorrected</code> - determines whether or not covariance estimates are bias-corrected</dd>
<dt><span class="strong">Returns:</span></dt><dd>covariance matrix</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../../../../../org/apache/commons/math3/exception/MathIllegalArgumentException.html" title="class in org.apache.commons.math3.exception">MathIllegalArgumentException</a></code> - if the data array does not contain sufficient
data</dd>
<dd><code><a href="../../../../../../org/apache/commons/math3/exception/NotStrictlyPositiveException.html" title="class in org.apache.commons.math3.exception">NotStrictlyPositiveException</a></code> - if the input data array is not
rectangular with at least one row and one column.</dd></dl>
</li>
</ul>
<a name="computeCovarianceMatrix(double[][])">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>computeCovarianceMatrix</h4>
<pre>protected&nbsp;<a href="../../../../../../org/apache/commons/math3/linear/RealMatrix.html" title="interface in org.apache.commons.math3.linear">RealMatrix</a>&nbsp;computeCovarianceMatrix(double[][]&nbsp;data)
throws <a href="../../../../../../org/apache/commons/math3/exception/MathIllegalArgumentException.html" title="class in org.apache.commons.math3.exception">MathIllegalArgumentException</a>,
<a href="../../../../../../org/apache/commons/math3/exception/NotStrictlyPositiveException.html" title="class in org.apache.commons.math3.exception">NotStrictlyPositiveException</a></pre>
<div class="block">Create a covariance matrix from a rectangular array whose columns represent
covariates. Covariances are computed using the bias-corrected formula.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>data</code> - input array (must have at least one column and two rows)</dd>
<dt><span class="strong">Returns:</span></dt><dd>covariance matrix</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../../../../../org/apache/commons/math3/exception/MathIllegalArgumentException.html" title="class in org.apache.commons.math3.exception">MathIllegalArgumentException</a></code> - if the data array does not contain sufficient data</dd>
<dd><code><a href="../../../../../../org/apache/commons/math3/exception/NotStrictlyPositiveException.html" title="class in org.apache.commons.math3.exception">NotStrictlyPositiveException</a></code> - if the input data array is not
rectangular with at least one row and one column.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../../org/apache/commons/math3/stat/correlation/Covariance.html#Covariance(org.apache.commons.math3.linear.RealMatrix)"><code>Covariance(org.apache.commons.math3.linear.RealMatrix)</code></a></dd></dl>
</li>
</ul>
<a name="covariance(double[], double[], boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>covariance</h4>
<pre>public&nbsp;double&nbsp;covariance(double[]&nbsp;xArray,
double[]&nbsp;yArray,
boolean&nbsp;biasCorrected)
throws <a href="../../../../../../org/apache/commons/math3/exception/MathIllegalArgumentException.html" title="class in org.apache.commons.math3.exception">MathIllegalArgumentException</a></pre>
<div class="block">Computes the covariance between the two arrays.
<p>Array lengths must match and the common length must be at least 2.</p></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>xArray</code> - first data array</dd><dd><code>yArray</code> - second data array</dd><dd><code>biasCorrected</code> - if true, returned value will be bias-corrected</dd>
<dt><span class="strong">Returns:</span></dt><dd>returns the covariance for the two arrays</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../../../../../org/apache/commons/math3/exception/MathIllegalArgumentException.html" title="class in org.apache.commons.math3.exception">MathIllegalArgumentException</a></code> - if the arrays lengths do not match or
there is insufficient data</dd></dl>
</li>
</ul>
<a name="covariance(double[], double[])">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>covariance</h4>
<pre>public&nbsp;double&nbsp;covariance(double[]&nbsp;xArray,
double[]&nbsp;yArray)
throws <a href="../../../../../../org/apache/commons/math3/exception/MathIllegalArgumentException.html" title="class in org.apache.commons.math3.exception">MathIllegalArgumentException</a></pre>
<div class="block">Computes the covariance between the two arrays, using the bias-corrected
formula.
<p>Array lengths must match and the common length must be at least 2.</p></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>xArray</code> - first data array</dd><dd><code>yArray</code> - second data array</dd>
<dt><span class="strong">Returns:</span></dt><dd>returns the covariance for the two arrays</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../../../../../org/apache/commons/math3/exception/MathIllegalArgumentException.html" title="class in org.apache.commons.math3.exception">MathIllegalArgumentException</a></code> - if the arrays lengths do not match or
there is insufficient data</dd></dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar_bottom">
<!-- -->
</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/Covariance.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../../help-doc.html">Help</a></li>
</ul>
<div class="aboutLanguage"><em><script type="text/javascript" src="http://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script></em></div>
</div>
<div class="subNav">
<ul class="navList">
<li>Prev Class</li>
<li><a href="../../../../../../org/apache/commons/math3/stat/correlation/KendallsCorrelation.html" title="class in org.apache.commons.math3.stat.correlation"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?org/apache/commons/math3/stat/correlation/Covariance.html" target="_top">Frames</a></li>
<li><a href="Covariance.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor_summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor_detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>Copyright &#169; 2003&#x2013;2014 <a href="http://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
</body>
</html>