diff options
Diffstat (limited to 'commons-math3-3.6.1/docs/apidocs/org/apache/commons/math3/linear/RealMatrix.html')
| -rw-r--r-- | commons-math3-3.6.1/docs/apidocs/org/apache/commons/math3/linear/RealMatrix.html | 1649 |
1 files changed, 1649 insertions, 0 deletions
diff --git a/commons-math3-3.6.1/docs/apidocs/org/apache/commons/math3/linear/RealMatrix.html b/commons-math3-3.6.1/docs/apidocs/org/apache/commons/math3/linear/RealMatrix.html new file mode 100644 index 0000000..ee3136d --- /dev/null +++ b/commons-math3-3.6.1/docs/apidocs/org/apache/commons/math3/linear/RealMatrix.html @@ -0,0 +1,1649 @@ +<!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>RealMatrix (Apache Commons Math 3.6.1 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="RealMatrix (Apache Commons Math 3.6.1 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/RealMatrix.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><a href="../../../../../org/apache/commons/math3/linear/RealLinearOperator.html" title="class in org.apache.commons.math3.linear"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/commons/math3/linear/RealMatrixChangingVisitor.html" title="interface in org.apache.commons.math3.linear"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/commons/math3/linear/RealMatrix.html" target="_top">Frames</a></li> +<li><a href="RealMatrix.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: </li> +<li>Nested | </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </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.linear</div> +<h2 title="Interface RealMatrix" class="title">Interface RealMatrix</h2> +</div> +<div class="contentContainer"> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Superinterfaces:</dt> +<dd><a href="../../../../../org/apache/commons/math3/linear/AnyMatrix.html" title="interface in org.apache.commons.math3.linear">AnyMatrix</a></dd> +</dl> +<dl> +<dt>All Known Subinterfaces:</dt> +<dd><a href="../../../../../org/apache/commons/math3/linear/SparseRealMatrix.html" title="interface in org.apache.commons.math3.linear">SparseRealMatrix</a></dd> +</dl> +<dl> +<dt>All Known Implementing Classes:</dt> +<dd><a href="../../../../../org/apache/commons/math3/linear/AbstractRealMatrix.html" title="class in org.apache.commons.math3.linear">AbstractRealMatrix</a>, <a href="../../../../../org/apache/commons/math3/linear/Array2DRowRealMatrix.html" title="class in org.apache.commons.math3.linear">Array2DRowRealMatrix</a>, <a href="../../../../../org/apache/commons/math3/linear/BlockRealMatrix.html" title="class in org.apache.commons.math3.linear">BlockRealMatrix</a>, <a href="../../../../../org/apache/commons/math3/linear/DiagonalMatrix.html" title="class in org.apache.commons.math3.linear">DiagonalMatrix</a>, <a href="../../../../../org/apache/commons/math3/linear/OpenMapRealMatrix.html" title="class in org.apache.commons.math3.linear">OpenMapRealMatrix</a></dd> +</dl> +<hr> +<br> +<pre>public interface <span class="strong">RealMatrix</span> +extends <a href="../../../../../org/apache/commons/math3/linear/AnyMatrix.html" title="interface in org.apache.commons.math3.linear">AnyMatrix</a></pre> +<div class="block">Interface defining a real-valued matrix with basic algebraic operations. + <p> + Matrix element indexing is 0-based -- e.g., <code>getEntry(0, 0)</code> + returns the element in the first row, first column of the matrix.</p></div> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ========== 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"> </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><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/linear/RealMatrix.html#add(org.apache.commons.math3.linear.RealMatrix)">add</a></strong>(<a href="../../../../../org/apache/commons/math3/linear/RealMatrix.html" title="interface in org.apache.commons.math3.linear">RealMatrix</a> m)</code> +<div class="block">Returns the sum of <code>this</code> and <code>m</code>.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/commons/math3/linear/RealMatrix.html#addToEntry(int,%20int,%20double)">addToEntry</a></strong>(int row, + int column, + double increment)</code> +<div class="block">Adds (in place) the specified value to the specified entry of + <code>this</code> matrix.</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/linear/RealMatrix.html#copy()">copy</a></strong>()</code> +<div class="block">Returns a (deep) copy of this.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/commons/math3/linear/RealMatrix.html#copySubMatrix(int[],%20int[],%20double[][])">copySubMatrix</a></strong>(int[] selectedRows, + int[] selectedColumns, + double[][] destination)</code> +<div class="block">Copy a submatrix.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/commons/math3/linear/RealMatrix.html#copySubMatrix(int,%20int,%20int,%20int,%20double[][])">copySubMatrix</a></strong>(int startRow, + int endRow, + int startColumn, + int endColumn, + double[][] destination)</code> +<div class="block">Copy a submatrix.</div> +</td> +</tr> +<tr class="rowColor"> +<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/linear/RealMatrix.html#createMatrix(int,%20int)">createMatrix</a></strong>(int rowDimension, + int columnDimension)</code> +<div class="block">Create a new RealMatrix of the same type as the instance with the + supplied + row and column dimensions.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>double[]</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/commons/math3/linear/RealMatrix.html#getColumn(int)">getColumn</a></strong>(int column)</code> +<div class="block">Get the entries at the given column index as an array.</div> +</td> +</tr> +<tr class="rowColor"> +<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/linear/RealMatrix.html#getColumnMatrix(int)">getColumnMatrix</a></strong>(int column)</code> +<div class="block">Get the entries at the given column index as a column matrix.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../org/apache/commons/math3/linear/RealVector.html" title="class in org.apache.commons.math3.linear">RealVector</a></code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/commons/math3/linear/RealMatrix.html#getColumnVector(int)">getColumnVector</a></strong>(int column)</code> +<div class="block">Get the entries at the given column index as a vector.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>double[][]</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/commons/math3/linear/RealMatrix.html#getData()">getData</a></strong>()</code> +<div class="block">Returns matrix entries as a two-dimensional array.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>double</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/commons/math3/linear/RealMatrix.html#getEntry(int,%20int)">getEntry</a></strong>(int row, + int column)</code> +<div class="block">Get the entry in the specified row and column.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>double</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/commons/math3/linear/RealMatrix.html#getFrobeniusNorm()">getFrobeniusNorm</a></strong>()</code> +<div class="block">Returns the <a href="http://mathworld.wolfram.com/FrobeniusNorm.html"> + Frobenius norm</a> of the matrix.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>double</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/commons/math3/linear/RealMatrix.html#getNorm()">getNorm</a></strong>()</code> +<div class="block">Returns the <a href="http://mathworld.wolfram.com/MaximumAbsoluteRowSumNorm.html"> + maximum absolute row sum norm</a> of the matrix.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>double[]</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/commons/math3/linear/RealMatrix.html#getRow(int)">getRow</a></strong>(int row)</code> +<div class="block">Get the entries at the given row index.</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/linear/RealMatrix.html#getRowMatrix(int)">getRowMatrix</a></strong>(int row)</code> +<div class="block">Get the entries at the given row index as a row matrix.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../../org/apache/commons/math3/linear/RealVector.html" title="class in org.apache.commons.math3.linear">RealVector</a></code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/commons/math3/linear/RealMatrix.html#getRowVector(int)">getRowVector</a></strong>(int row)</code> +<div class="block">Returns the entries in row number <code>row</code> as a vector.</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/linear/RealMatrix.html#getSubMatrix(int[],%20int[])">getSubMatrix</a></strong>(int[] selectedRows, + int[] selectedColumns)</code> +<div class="block">Gets a submatrix.</div> +</td> +</tr> +<tr class="rowColor"> +<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/linear/RealMatrix.html#getSubMatrix(int,%20int,%20int,%20int)">getSubMatrix</a></strong>(int startRow, + int endRow, + int startColumn, + int endColumn)</code> +<div class="block">Gets a submatrix.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>double</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/commons/math3/linear/RealMatrix.html#getTrace()">getTrace</a></strong>()</code> +<div class="block">Returns the <a href="http://mathworld.wolfram.com/MatrixTrace.html"> + trace</a> of the matrix (the sum of the elements on the main diagonal).</div> +</td> +</tr> +<tr class="rowColor"> +<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/linear/RealMatrix.html#multiply(org.apache.commons.math3.linear.RealMatrix)">multiply</a></strong>(<a href="../../../../../org/apache/commons/math3/linear/RealMatrix.html" title="interface in org.apache.commons.math3.linear">RealMatrix</a> m)</code> +<div class="block">Returns the result of postmultiplying <code>this</code> by <code>m</code>.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/commons/math3/linear/RealMatrix.html#multiplyEntry(int,%20int,%20double)">multiplyEntry</a></strong>(int row, + int column, + double factor)</code> +<div class="block">Multiplies (in place) the specified entry of <code>this</code> matrix by the + specified value.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>double[]</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/commons/math3/linear/RealMatrix.html#operate(double[])">operate</a></strong>(double[] v)</code> +<div class="block">Returns the result of multiplying this by the vector <code>v</code>.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../org/apache/commons/math3/linear/RealVector.html" title="class in org.apache.commons.math3.linear">RealVector</a></code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/commons/math3/linear/RealMatrix.html#operate(org.apache.commons.math3.linear.RealVector)">operate</a></strong>(<a href="../../../../../org/apache/commons/math3/linear/RealVector.html" title="class in org.apache.commons.math3.linear">RealVector</a> v)</code> +<div class="block">Returns the result of multiplying this by the vector <code>v</code>.</div> +</td> +</tr> +<tr class="rowColor"> +<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/linear/RealMatrix.html#power(int)">power</a></strong>(int p)</code> +<div class="block">Returns the result of multiplying <code>this</code> with itself <code>p</code> + times.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>double[]</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/commons/math3/linear/RealMatrix.html#preMultiply(double[])">preMultiply</a></strong>(double[] v)</code> +<div class="block">Returns the (row) vector result of premultiplying this by the vector <code>v</code>.</div> +</td> +</tr> +<tr class="rowColor"> +<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/linear/RealMatrix.html#preMultiply(org.apache.commons.math3.linear.RealMatrix)">preMultiply</a></strong>(<a href="../../../../../org/apache/commons/math3/linear/RealMatrix.html" title="interface in org.apache.commons.math3.linear">RealMatrix</a> m)</code> +<div class="block">Returns the result of premultiplying <code>this</code> by <code>m</code>.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../org/apache/commons/math3/linear/RealVector.html" title="class in org.apache.commons.math3.linear">RealVector</a></code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/commons/math3/linear/RealMatrix.html#preMultiply(org.apache.commons.math3.linear.RealVector)">preMultiply</a></strong>(<a href="../../../../../org/apache/commons/math3/linear/RealVector.html" title="class in org.apache.commons.math3.linear">RealVector</a> v)</code> +<div class="block">Returns the (row) vector result of premultiplying this by the vector <code>v</code>.</div> +</td> +</tr> +<tr class="rowColor"> +<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/linear/RealMatrix.html#scalarAdd(double)">scalarAdd</a></strong>(double d)</code> +<div class="block">Returns the result of adding <code>d</code> to each entry of <code>this</code>.</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/linear/RealMatrix.html#scalarMultiply(double)">scalarMultiply</a></strong>(double d)</code> +<div class="block">Returns the result of multiplying each entry of <code>this</code> by + <code>d</code>.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/commons/math3/linear/RealMatrix.html#setColumn(int,%20double[])">setColumn</a></strong>(int column, + double[] array)</code> +<div class="block">Sets the specified <code>column</code> of <code>this</code> matrix to the entries + of the specified <code>array</code>.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/commons/math3/linear/RealMatrix.html#setColumnMatrix(int,%20org.apache.commons.math3.linear.RealMatrix)">setColumnMatrix</a></strong>(int column, + <a href="../../../../../org/apache/commons/math3/linear/RealMatrix.html" title="interface in org.apache.commons.math3.linear">RealMatrix</a> matrix)</code> +<div class="block">Sets the specified <code>column</code> of <code>this</code> matrix to the entries + of the specified column <code>matrix</code>.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/commons/math3/linear/RealMatrix.html#setColumnVector(int,%20org.apache.commons.math3.linear.RealVector)">setColumnVector</a></strong>(int column, + <a href="../../../../../org/apache/commons/math3/linear/RealVector.html" title="class in org.apache.commons.math3.linear">RealVector</a> vector)</code> +<div class="block">Sets the specified <code>column</code> of <code>this</code> matrix to the entries + of the specified <code>vector</code>.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/commons/math3/linear/RealMatrix.html#setEntry(int,%20int,%20double)">setEntry</a></strong>(int row, + int column, + double value)</code> +<div class="block">Set the entry in the specified row and column.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/commons/math3/linear/RealMatrix.html#setRow(int,%20double[])">setRow</a></strong>(int row, + double[] array)</code> +<div class="block">Sets the specified <code>row</code> of <code>this</code> matrix to the entries + of the specified <code>array</code>.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/commons/math3/linear/RealMatrix.html#setRowMatrix(int,%20org.apache.commons.math3.linear.RealMatrix)">setRowMatrix</a></strong>(int row, + <a href="../../../../../org/apache/commons/math3/linear/RealMatrix.html" title="interface in org.apache.commons.math3.linear">RealMatrix</a> matrix)</code> +<div class="block">Sets the specified <code>row</code> of <code>this</code> matrix to the entries of + the specified row <code>matrix</code>.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/commons/math3/linear/RealMatrix.html#setRowVector(int,%20org.apache.commons.math3.linear.RealVector)">setRowVector</a></strong>(int row, + <a href="../../../../../org/apache/commons/math3/linear/RealVector.html" title="class in org.apache.commons.math3.linear">RealVector</a> vector)</code> +<div class="block">Sets the specified <code>row</code> of <code>this</code> matrix to the entries of + the specified <code>vector</code>.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/commons/math3/linear/RealMatrix.html#setSubMatrix(double[][],%20int,%20int)">setSubMatrix</a></strong>(double[][] subMatrix, + int row, + int column)</code> +<div class="block">Replace the submatrix starting at <code>row, column</code> using data in the + input <code>subMatrix</code> array.</div> +</td> +</tr> +<tr class="rowColor"> +<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/linear/RealMatrix.html#subtract(org.apache.commons.math3.linear.RealMatrix)">subtract</a></strong>(<a href="../../../../../org/apache/commons/math3/linear/RealMatrix.html" title="interface in org.apache.commons.math3.linear">RealMatrix</a> m)</code> +<div class="block">Returns <code>this</code> minus <code>m</code>.</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/linear/RealMatrix.html#transpose()">transpose</a></strong>()</code> +<div class="block">Returns the transpose of this matrix.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>double</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/commons/math3/linear/RealMatrix.html#walkInColumnOrder(org.apache.commons.math3.linear.RealMatrixChangingVisitor)">walkInColumnOrder</a></strong>(<a href="../../../../../org/apache/commons/math3/linear/RealMatrixChangingVisitor.html" title="interface in org.apache.commons.math3.linear">RealMatrixChangingVisitor</a> visitor)</code> +<div class="block">Visit (and possibly change) all matrix entries in column order.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>double</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/commons/math3/linear/RealMatrix.html#walkInColumnOrder(org.apache.commons.math3.linear.RealMatrixChangingVisitor,%20int,%20int,%20int,%20int)">walkInColumnOrder</a></strong>(<a href="../../../../../org/apache/commons/math3/linear/RealMatrixChangingVisitor.html" title="interface in org.apache.commons.math3.linear">RealMatrixChangingVisitor</a> visitor, + int startRow, + int endRow, + int startColumn, + int endColumn)</code> +<div class="block">Visit (and possibly change) some matrix entries in column order.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>double</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/commons/math3/linear/RealMatrix.html#walkInColumnOrder(org.apache.commons.math3.linear.RealMatrixPreservingVisitor)">walkInColumnOrder</a></strong>(<a href="../../../../../org/apache/commons/math3/linear/RealMatrixPreservingVisitor.html" title="interface in org.apache.commons.math3.linear">RealMatrixPreservingVisitor</a> visitor)</code> +<div class="block">Visit (but don't change) all matrix entries in column order.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>double</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/commons/math3/linear/RealMatrix.html#walkInColumnOrder(org.apache.commons.math3.linear.RealMatrixPreservingVisitor,%20int,%20int,%20int,%20int)">walkInColumnOrder</a></strong>(<a href="../../../../../org/apache/commons/math3/linear/RealMatrixPreservingVisitor.html" title="interface in org.apache.commons.math3.linear">RealMatrixPreservingVisitor</a> visitor, + int startRow, + int endRow, + int startColumn, + int endColumn)</code> +<div class="block">Visit (but don't change) some matrix entries in column order.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>double</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/commons/math3/linear/RealMatrix.html#walkInOptimizedOrder(org.apache.commons.math3.linear.RealMatrixChangingVisitor)">walkInOptimizedOrder</a></strong>(<a href="../../../../../org/apache/commons/math3/linear/RealMatrixChangingVisitor.html" title="interface in org.apache.commons.math3.linear">RealMatrixChangingVisitor</a> visitor)</code> +<div class="block">Visit (and possibly change) all matrix entries using the fastest possible order.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>double</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/commons/math3/linear/RealMatrix.html#walkInOptimizedOrder(org.apache.commons.math3.linear.RealMatrixChangingVisitor,%20int,%20int,%20int,%20int)">walkInOptimizedOrder</a></strong>(<a href="../../../../../org/apache/commons/math3/linear/RealMatrixChangingVisitor.html" title="interface in org.apache.commons.math3.linear">RealMatrixChangingVisitor</a> visitor, + int startRow, + int endRow, + int startColumn, + int endColumn)</code> +<div class="block">Visit (and possibly change) some matrix entries using the fastest possible order.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>double</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/commons/math3/linear/RealMatrix.html#walkInOptimizedOrder(org.apache.commons.math3.linear.RealMatrixPreservingVisitor)">walkInOptimizedOrder</a></strong>(<a href="../../../../../org/apache/commons/math3/linear/RealMatrixPreservingVisitor.html" title="interface in org.apache.commons.math3.linear">RealMatrixPreservingVisitor</a> visitor)</code> +<div class="block">Visit (but don't change) all matrix entries using the fastest possible order.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>double</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/commons/math3/linear/RealMatrix.html#walkInOptimizedOrder(org.apache.commons.math3.linear.RealMatrixPreservingVisitor,%20int,%20int,%20int,%20int)">walkInOptimizedOrder</a></strong>(<a href="../../../../../org/apache/commons/math3/linear/RealMatrixPreservingVisitor.html" title="interface in org.apache.commons.math3.linear">RealMatrixPreservingVisitor</a> visitor, + int startRow, + int endRow, + int startColumn, + int endColumn)</code> +<div class="block">Visit (but don't change) some matrix entries using the fastest possible order.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>double</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/commons/math3/linear/RealMatrix.html#walkInRowOrder(org.apache.commons.math3.linear.RealMatrixChangingVisitor)">walkInRowOrder</a></strong>(<a href="../../../../../org/apache/commons/math3/linear/RealMatrixChangingVisitor.html" title="interface in org.apache.commons.math3.linear">RealMatrixChangingVisitor</a> visitor)</code> +<div class="block">Visit (and possibly change) all matrix entries in row order.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>double</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/commons/math3/linear/RealMatrix.html#walkInRowOrder(org.apache.commons.math3.linear.RealMatrixChangingVisitor,%20int,%20int,%20int,%20int)">walkInRowOrder</a></strong>(<a href="../../../../../org/apache/commons/math3/linear/RealMatrixChangingVisitor.html" title="interface in org.apache.commons.math3.linear">RealMatrixChangingVisitor</a> visitor, + int startRow, + int endRow, + int startColumn, + int endColumn)</code> +<div class="block">Visit (and possibly change) some matrix entries in row order.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>double</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/commons/math3/linear/RealMatrix.html#walkInRowOrder(org.apache.commons.math3.linear.RealMatrixPreservingVisitor)">walkInRowOrder</a></strong>(<a href="../../../../../org/apache/commons/math3/linear/RealMatrixPreservingVisitor.html" title="interface in org.apache.commons.math3.linear">RealMatrixPreservingVisitor</a> visitor)</code> +<div class="block">Visit (but don't change) all matrix entries in row order.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>double</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/commons/math3/linear/RealMatrix.html#walkInRowOrder(org.apache.commons.math3.linear.RealMatrixPreservingVisitor,%20int,%20int,%20int,%20int)">walkInRowOrder</a></strong>(<a href="../../../../../org/apache/commons/math3/linear/RealMatrixPreservingVisitor.html" title="interface in org.apache.commons.math3.linear">RealMatrixPreservingVisitor</a> visitor, + int startRow, + int endRow, + int startColumn, + int endColumn)</code> +<div class="block">Visit (but don't change) some matrix entries in row order.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_org.apache.commons.math3.linear.AnyMatrix"> +<!-- --> +</a> +<h3>Methods inherited from interface org.apache.commons.math3.linear.<a href="../../../../../org/apache/commons/math3/linear/AnyMatrix.html" title="interface in org.apache.commons.math3.linear">AnyMatrix</a></h3> +<code><a href="../../../../../org/apache/commons/math3/linear/AnyMatrix.html#getColumnDimension()">getColumnDimension</a>, <a href="../../../../../org/apache/commons/math3/linear/AnyMatrix.html#getRowDimension()">getRowDimension</a>, <a href="../../../../../org/apache/commons/math3/linear/AnyMatrix.html#isSquare()">isSquare</a></code></li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="createMatrix(int, int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>createMatrix</h4> +<pre><a href="../../../../../org/apache/commons/math3/linear/RealMatrix.html" title="interface in org.apache.commons.math3.linear">RealMatrix</a> createMatrix(int rowDimension, + int columnDimension) + throws <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 new RealMatrix of the same type as the instance with the + supplied + row and column dimensions.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>rowDimension</code> - the number of rows in the new matrix</dd><dd><code>columnDimension</code> - the number of columns in the new matrix</dd> +<dt><span class="strong">Returns:</span></dt><dd>a new matrix of the same type as the instance</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../../../org/apache/commons/math3/exception/NotStrictlyPositiveException.html" title="class in org.apache.commons.math3.exception">NotStrictlyPositiveException</a></code> - if row or column dimension is not + positive.</dd><dt><span class="strong">Since:</span></dt> + <dd>2.0</dd></dl> +</li> +</ul> +<a name="copy()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>copy</h4> +<pre><a href="../../../../../org/apache/commons/math3/linear/RealMatrix.html" title="interface in org.apache.commons.math3.linear">RealMatrix</a> copy()</pre> +<div class="block">Returns a (deep) copy of this.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>matrix copy</dd></dl> +</li> +</ul> +<a name="add(org.apache.commons.math3.linear.RealMatrix)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>add</h4> +<pre><a href="../../../../../org/apache/commons/math3/linear/RealMatrix.html" title="interface in org.apache.commons.math3.linear">RealMatrix</a> add(<a href="../../../../../org/apache/commons/math3/linear/RealMatrix.html" title="interface in org.apache.commons.math3.linear">RealMatrix</a> m) + throws <a href="../../../../../org/apache/commons/math3/linear/MatrixDimensionMismatchException.html" title="class in org.apache.commons.math3.linear">MatrixDimensionMismatchException</a></pre> +<div class="block">Returns the sum of <code>this</code> and <code>m</code>.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>m</code> - matrix to be added</dd> +<dt><span class="strong">Returns:</span></dt><dd><code>this + m</code></dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../../../org/apache/commons/math3/linear/MatrixDimensionMismatchException.html" title="class in org.apache.commons.math3.linear">MatrixDimensionMismatchException</a></code> - if <code>m</code> is not the same + size as <code>this</code>.</dd></dl> +</li> +</ul> +<a name="subtract(org.apache.commons.math3.linear.RealMatrix)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>subtract</h4> +<pre><a href="../../../../../org/apache/commons/math3/linear/RealMatrix.html" title="interface in org.apache.commons.math3.linear">RealMatrix</a> subtract(<a href="../../../../../org/apache/commons/math3/linear/RealMatrix.html" title="interface in org.apache.commons.math3.linear">RealMatrix</a> m) + throws <a href="../../../../../org/apache/commons/math3/linear/MatrixDimensionMismatchException.html" title="class in org.apache.commons.math3.linear">MatrixDimensionMismatchException</a></pre> +<div class="block">Returns <code>this</code> minus <code>m</code>.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>m</code> - matrix to be subtracted</dd> +<dt><span class="strong">Returns:</span></dt><dd><code>this - m</code></dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../../../org/apache/commons/math3/linear/MatrixDimensionMismatchException.html" title="class in org.apache.commons.math3.linear">MatrixDimensionMismatchException</a></code> - if <code>m</code> is not the same + size as <code>this</code>.</dd></dl> +</li> +</ul> +<a name="scalarAdd(double)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>scalarAdd</h4> +<pre><a href="../../../../../org/apache/commons/math3/linear/RealMatrix.html" title="interface in org.apache.commons.math3.linear">RealMatrix</a> scalarAdd(double d)</pre> +<div class="block">Returns the result of adding <code>d</code> to each entry of <code>this</code>.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>d</code> - value to be added to each entry</dd> +<dt><span class="strong">Returns:</span></dt><dd><code>d + this</code></dd></dl> +</li> +</ul> +<a name="scalarMultiply(double)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>scalarMultiply</h4> +<pre><a href="../../../../../org/apache/commons/math3/linear/RealMatrix.html" title="interface in org.apache.commons.math3.linear">RealMatrix</a> scalarMultiply(double d)</pre> +<div class="block">Returns the result of multiplying each entry of <code>this</code> by + <code>d</code>.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>d</code> - value to multiply all entries by</dd> +<dt><span class="strong">Returns:</span></dt><dd><code>d * this</code></dd></dl> +</li> +</ul> +<a name="multiply(org.apache.commons.math3.linear.RealMatrix)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>multiply</h4> +<pre><a href="../../../../../org/apache/commons/math3/linear/RealMatrix.html" title="interface in org.apache.commons.math3.linear">RealMatrix</a> multiply(<a href="../../../../../org/apache/commons/math3/linear/RealMatrix.html" title="interface in org.apache.commons.math3.linear">RealMatrix</a> m) + throws <a href="../../../../../org/apache/commons/math3/exception/DimensionMismatchException.html" title="class in org.apache.commons.math3.exception">DimensionMismatchException</a></pre> +<div class="block">Returns the result of postmultiplying <code>this</code> by <code>m</code>.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>m</code> - matrix to postmultiply by</dd> +<dt><span class="strong">Returns:</span></dt><dd><code>this * m</code></dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../../../org/apache/commons/math3/exception/DimensionMismatchException.html" title="class in org.apache.commons.math3.exception">DimensionMismatchException</a></code> - if + <code>columnDimension(this) != rowDimension(m)</code></dd></dl> +</li> +</ul> +<a name="preMultiply(org.apache.commons.math3.linear.RealMatrix)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>preMultiply</h4> +<pre><a href="../../../../../org/apache/commons/math3/linear/RealMatrix.html" title="interface in org.apache.commons.math3.linear">RealMatrix</a> preMultiply(<a href="../../../../../org/apache/commons/math3/linear/RealMatrix.html" title="interface in org.apache.commons.math3.linear">RealMatrix</a> m) + throws <a href="../../../../../org/apache/commons/math3/exception/DimensionMismatchException.html" title="class in org.apache.commons.math3.exception">DimensionMismatchException</a></pre> +<div class="block">Returns the result of premultiplying <code>this</code> by <code>m</code>.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>m</code> - matrix to premultiply by</dd> +<dt><span class="strong">Returns:</span></dt><dd><code>m * this</code></dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../../../org/apache/commons/math3/exception/DimensionMismatchException.html" title="class in org.apache.commons.math3.exception">DimensionMismatchException</a></code> - if + <code>rowDimension(this) != columnDimension(m)</code></dd></dl> +</li> +</ul> +<a name="power(int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>power</h4> +<pre><a href="../../../../../org/apache/commons/math3/linear/RealMatrix.html" title="interface in org.apache.commons.math3.linear">RealMatrix</a> power(int p) + throws <a href="../../../../../org/apache/commons/math3/exception/NotPositiveException.html" title="class in org.apache.commons.math3.exception">NotPositiveException</a>, + <a href="../../../../../org/apache/commons/math3/linear/NonSquareMatrixException.html" title="class in org.apache.commons.math3.linear">NonSquareMatrixException</a></pre> +<div class="block">Returns the result of multiplying <code>this</code> with itself <code>p</code> + times. Depending on the underlying storage, instability for high powers + might occur.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>p</code> - raise <code>this</code> to power <code>p</code></dd> +<dt><span class="strong">Returns:</span></dt><dd><code>this^p</code></dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../../../org/apache/commons/math3/exception/NotPositiveException.html" title="class in org.apache.commons.math3.exception">NotPositiveException</a></code> - if <code>p < 0</code></dd> +<dd><code><a href="../../../../../org/apache/commons/math3/linear/NonSquareMatrixException.html" title="class in org.apache.commons.math3.linear">NonSquareMatrixException</a></code> - if the matrix is not square</dd></dl> +</li> +</ul> +<a name="getData()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getData</h4> +<pre>double[][] getData()</pre> +<div class="block">Returns matrix entries as a two-dimensional array.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>2-dimensional array of entries</dd></dl> +</li> +</ul> +<a name="getNorm()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getNorm</h4> +<pre>double getNorm()</pre> +<div class="block">Returns the <a href="http://mathworld.wolfram.com/MaximumAbsoluteRowSumNorm.html"> + maximum absolute row sum norm</a> of the matrix.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>norm</dd></dl> +</li> +</ul> +<a name="getFrobeniusNorm()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getFrobeniusNorm</h4> +<pre>double getFrobeniusNorm()</pre> +<div class="block">Returns the <a href="http://mathworld.wolfram.com/FrobeniusNorm.html"> + Frobenius norm</a> of the matrix.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>norm</dd></dl> +</li> +</ul> +<a name="getSubMatrix(int, int, int, int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getSubMatrix</h4> +<pre><a href="../../../../../org/apache/commons/math3/linear/RealMatrix.html" title="interface in org.apache.commons.math3.linear">RealMatrix</a> getSubMatrix(int startRow, + int endRow, + int startColumn, + int endColumn) + throws <a href="../../../../../org/apache/commons/math3/exception/OutOfRangeException.html" title="class in org.apache.commons.math3.exception">OutOfRangeException</a>, + <a href="../../../../../org/apache/commons/math3/exception/NumberIsTooSmallException.html" title="class in org.apache.commons.math3.exception">NumberIsTooSmallException</a></pre> +<div class="block">Gets a submatrix. Rows and columns are indicated + counting from 0 to n-1.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>startRow</code> - Initial row index</dd><dd><code>endRow</code> - Final row index (inclusive)</dd><dd><code>startColumn</code> - Initial column index</dd><dd><code>endColumn</code> - Final column index (inclusive)</dd> +<dt><span class="strong">Returns:</span></dt><dd>The subMatrix containing the data of the + specified rows and columns.</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../../../org/apache/commons/math3/exception/OutOfRangeException.html" title="class in org.apache.commons.math3.exception">OutOfRangeException</a></code> - if the indices are not valid.</dd> +<dd><code><a href="../../../../../org/apache/commons/math3/exception/NumberIsTooSmallException.html" title="class in org.apache.commons.math3.exception">NumberIsTooSmallException</a></code> - if <code>endRow < startRow</code> or + <code>endColumn < startColumn</code>.</dd></dl> +</li> +</ul> +<a name="getSubMatrix(int[], int[])"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getSubMatrix</h4> +<pre><a href="../../../../../org/apache/commons/math3/linear/RealMatrix.html" title="interface in org.apache.commons.math3.linear">RealMatrix</a> getSubMatrix(int[] selectedRows, + int[] selectedColumns) + throws <a href="../../../../../org/apache/commons/math3/exception/NullArgumentException.html" title="class in org.apache.commons.math3.exception">NullArgumentException</a>, + <a href="../../../../../org/apache/commons/math3/exception/NoDataException.html" title="class in org.apache.commons.math3.exception">NoDataException</a>, + <a href="../../../../../org/apache/commons/math3/exception/OutOfRangeException.html" title="class in org.apache.commons.math3.exception">OutOfRangeException</a></pre> +<div class="block">Gets a submatrix. Rows and columns are indicated counting from 0 to n-1.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>selectedRows</code> - Array of row indices.</dd><dd><code>selectedColumns</code> - Array of column indices.</dd> +<dt><span class="strong">Returns:</span></dt><dd>The subMatrix containing the data in the specified rows and + columns</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../../../org/apache/commons/math3/exception/NullArgumentException.html" title="class in org.apache.commons.math3.exception">NullArgumentException</a></code> - if the row or column selections are + <code>null</code></dd> +<dd><code><a href="../../../../../org/apache/commons/math3/exception/NoDataException.html" title="class in org.apache.commons.math3.exception">NoDataException</a></code> - if the row or column selections are empty (zero + length).</dd> +<dd><code><a href="../../../../../org/apache/commons/math3/exception/OutOfRangeException.html" title="class in org.apache.commons.math3.exception">OutOfRangeException</a></code> - if the indices are not valid.</dd></dl> +</li> +</ul> +<a name="copySubMatrix(int, int, int, int, double[][])"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>copySubMatrix</h4> +<pre>void copySubMatrix(int startRow, + int endRow, + int startColumn, + int endColumn, + double[][] destination) + throws <a href="../../../../../org/apache/commons/math3/exception/OutOfRangeException.html" title="class in org.apache.commons.math3.exception">OutOfRangeException</a>, + <a href="../../../../../org/apache/commons/math3/exception/NumberIsTooSmallException.html" title="class in org.apache.commons.math3.exception">NumberIsTooSmallException</a>, + <a href="../../../../../org/apache/commons/math3/linear/MatrixDimensionMismatchException.html" title="class in org.apache.commons.math3.linear">MatrixDimensionMismatchException</a></pre> +<div class="block">Copy a submatrix. Rows and columns are indicated counting from 0 to n-1.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>startRow</code> - Initial row index</dd><dd><code>endRow</code> - Final row index (inclusive)</dd><dd><code>startColumn</code> - Initial column index</dd><dd><code>endColumn</code> - Final column index (inclusive)</dd><dd><code>destination</code> - The arrays where the submatrix data should be copied + (if larger than rows/columns counts, only the upper-left part will be + used)</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../../../org/apache/commons/math3/exception/OutOfRangeException.html" title="class in org.apache.commons.math3.exception">OutOfRangeException</a></code> - if the indices are not valid.</dd> +<dd><code><a href="../../../../../org/apache/commons/math3/exception/NumberIsTooSmallException.html" title="class in org.apache.commons.math3.exception">NumberIsTooSmallException</a></code> - if <code>endRow < startRow</code> or + <code>endColumn < startColumn</code>.</dd> +<dd><code><a href="../../../../../org/apache/commons/math3/linear/MatrixDimensionMismatchException.html" title="class in org.apache.commons.math3.linear">MatrixDimensionMismatchException</a></code> - if the destination array is too + small.</dd></dl> +</li> +</ul> +<a name="copySubMatrix(int[], int[], double[][])"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>copySubMatrix</h4> +<pre>void copySubMatrix(int[] selectedRows, + int[] selectedColumns, + double[][] destination) + throws <a href="../../../../../org/apache/commons/math3/exception/OutOfRangeException.html" title="class in org.apache.commons.math3.exception">OutOfRangeException</a>, + <a href="../../../../../org/apache/commons/math3/exception/NullArgumentException.html" title="class in org.apache.commons.math3.exception">NullArgumentException</a>, + <a href="../../../../../org/apache/commons/math3/exception/NoDataException.html" title="class in org.apache.commons.math3.exception">NoDataException</a>, + <a href="../../../../../org/apache/commons/math3/linear/MatrixDimensionMismatchException.html" title="class in org.apache.commons.math3.linear">MatrixDimensionMismatchException</a></pre> +<div class="block">Copy a submatrix. Rows and columns are indicated counting from 0 to n-1.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>selectedRows</code> - Array of row indices.</dd><dd><code>selectedColumns</code> - Array of column indices.</dd><dd><code>destination</code> - The arrays where the submatrix data should be copied + (if larger than rows/columns counts, only the upper-left part will be + used)</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../../../org/apache/commons/math3/exception/NullArgumentException.html" title="class in org.apache.commons.math3.exception">NullArgumentException</a></code> - if the row or column selections are + <code>null</code></dd> +<dd><code><a href="../../../../../org/apache/commons/math3/exception/NoDataException.html" title="class in org.apache.commons.math3.exception">NoDataException</a></code> - if the row or column selections are empty (zero + length).</dd> +<dd><code><a href="../../../../../org/apache/commons/math3/exception/OutOfRangeException.html" title="class in org.apache.commons.math3.exception">OutOfRangeException</a></code> - if the indices are not valid.</dd> +<dd><code><a href="../../../../../org/apache/commons/math3/linear/MatrixDimensionMismatchException.html" title="class in org.apache.commons.math3.linear">MatrixDimensionMismatchException</a></code> - if the destination array is too + small.</dd></dl> +</li> +</ul> +<a name="setSubMatrix(double[][], int, int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setSubMatrix</h4> +<pre>void setSubMatrix(double[][] subMatrix, + int row, + int column) + throws <a href="../../../../../org/apache/commons/math3/exception/NoDataException.html" title="class in org.apache.commons.math3.exception">NoDataException</a>, + <a href="../../../../../org/apache/commons/math3/exception/OutOfRangeException.html" title="class in org.apache.commons.math3.exception">OutOfRangeException</a>, + <a href="../../../../../org/apache/commons/math3/exception/DimensionMismatchException.html" title="class in org.apache.commons.math3.exception">DimensionMismatchException</a>, + <a href="../../../../../org/apache/commons/math3/exception/NullArgumentException.html" title="class in org.apache.commons.math3.exception">NullArgumentException</a></pre> +<div class="block">Replace the submatrix starting at <code>row, column</code> using data in the + input <code>subMatrix</code> array. Indexes are 0-based. + <p> + Example:<br> + Starting with <pre> + 1 2 3 4 + 5 6 7 8 + 9 0 1 2 + </pre> + and <code>subMatrix = {{3, 4} {5,6}}</code>, invoking + <code>setSubMatrix(subMatrix,1,1))</code> will result in <pre> + 1 2 3 4 + 5 3 4 8 + 9 5 6 2 + </pre></p></div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>subMatrix</code> - array containing the submatrix replacement data</dd><dd><code>row</code> - row coordinate of the top, left element to be replaced</dd><dd><code>column</code> - column coordinate of the top, left element to be replaced</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../../../org/apache/commons/math3/exception/NoDataException.html" title="class in org.apache.commons.math3.exception">NoDataException</a></code> - if <code>subMatrix</code> is empty.</dd> +<dd><code><a href="../../../../../org/apache/commons/math3/exception/OutOfRangeException.html" title="class in org.apache.commons.math3.exception">OutOfRangeException</a></code> - if <code>subMatrix</code> does not fit into + this matrix from element in <code>(row, column)</code>.</dd> +<dd><code><a href="../../../../../org/apache/commons/math3/exception/DimensionMismatchException.html" title="class in org.apache.commons.math3.exception">DimensionMismatchException</a></code> - if <code>subMatrix</code> is not rectangular + (not all rows have the same length) or empty.</dd> +<dd><code><a href="../../../../../org/apache/commons/math3/exception/NullArgumentException.html" title="class in org.apache.commons.math3.exception">NullArgumentException</a></code> - if <code>subMatrix</code> is <code>null</code>.</dd><dt><span class="strong">Since:</span></dt> + <dd>2.0</dd></dl> +</li> +</ul> +<a name="getRowMatrix(int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getRowMatrix</h4> +<pre><a href="../../../../../org/apache/commons/math3/linear/RealMatrix.html" title="interface in org.apache.commons.math3.linear">RealMatrix</a> getRowMatrix(int row) + throws <a href="../../../../../org/apache/commons/math3/exception/OutOfRangeException.html" title="class in org.apache.commons.math3.exception">OutOfRangeException</a></pre> +<div class="block">Get the entries at the given row index as a row matrix. Row indices start + at 0.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>row</code> - Row to be fetched.</dd> +<dt><span class="strong">Returns:</span></dt><dd>row Matrix.</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../../../org/apache/commons/math3/exception/OutOfRangeException.html" title="class in org.apache.commons.math3.exception">OutOfRangeException</a></code> - if the specified row index is invalid.</dd></dl> +</li> +</ul> +<a name="setRowMatrix(int, org.apache.commons.math3.linear.RealMatrix)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setRowMatrix</h4> +<pre>void setRowMatrix(int row, + <a href="../../../../../org/apache/commons/math3/linear/RealMatrix.html" title="interface in org.apache.commons.math3.linear">RealMatrix</a> matrix) + throws <a href="../../../../../org/apache/commons/math3/exception/OutOfRangeException.html" title="class in org.apache.commons.math3.exception">OutOfRangeException</a>, + <a href="../../../../../org/apache/commons/math3/linear/MatrixDimensionMismatchException.html" title="class in org.apache.commons.math3.linear">MatrixDimensionMismatchException</a></pre> +<div class="block">Sets the specified <code>row</code> of <code>this</code> matrix to the entries of + the specified row <code>matrix</code>. Row indices start at 0.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>row</code> - Row to be set.</dd><dd><code>matrix</code> - Row matrix to be copied (must have one row and the same + number of columns as the instance).</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../../../org/apache/commons/math3/exception/OutOfRangeException.html" title="class in org.apache.commons.math3.exception">OutOfRangeException</a></code> - if the specified row index is invalid.</dd> +<dd><code><a href="../../../../../org/apache/commons/math3/linear/MatrixDimensionMismatchException.html" title="class in org.apache.commons.math3.linear">MatrixDimensionMismatchException</a></code> - if the row dimension of the + <code>matrix</code> is not <code>1</code>, or the column dimensions of <code>this</code> + and <code>matrix</code> do not match.</dd></dl> +</li> +</ul> +<a name="getColumnMatrix(int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getColumnMatrix</h4> +<pre><a href="../../../../../org/apache/commons/math3/linear/RealMatrix.html" title="interface in org.apache.commons.math3.linear">RealMatrix</a> getColumnMatrix(int column) + throws <a href="../../../../../org/apache/commons/math3/exception/OutOfRangeException.html" title="class in org.apache.commons.math3.exception">OutOfRangeException</a></pre> +<div class="block">Get the entries at the given column index as a column matrix. Column + indices start at 0.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>column</code> - Column to be fetched.</dd> +<dt><span class="strong">Returns:</span></dt><dd>column Matrix.</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../../../org/apache/commons/math3/exception/OutOfRangeException.html" title="class in org.apache.commons.math3.exception">OutOfRangeException</a></code> - if the specified column index is invalid.</dd></dl> +</li> +</ul> +<a name="setColumnMatrix(int, org.apache.commons.math3.linear.RealMatrix)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setColumnMatrix</h4> +<pre>void setColumnMatrix(int column, + <a href="../../../../../org/apache/commons/math3/linear/RealMatrix.html" title="interface in org.apache.commons.math3.linear">RealMatrix</a> matrix) + throws <a href="../../../../../org/apache/commons/math3/exception/OutOfRangeException.html" title="class in org.apache.commons.math3.exception">OutOfRangeException</a>, + <a href="../../../../../org/apache/commons/math3/linear/MatrixDimensionMismatchException.html" title="class in org.apache.commons.math3.linear">MatrixDimensionMismatchException</a></pre> +<div class="block">Sets the specified <code>column</code> of <code>this</code> matrix to the entries + of the specified column <code>matrix</code>. Column indices start at 0.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>column</code> - Column to be set.</dd><dd><code>matrix</code> - Column matrix to be copied (must have one column and the + same number of rows as the instance).</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../../../org/apache/commons/math3/exception/OutOfRangeException.html" title="class in org.apache.commons.math3.exception">OutOfRangeException</a></code> - if the specified column index is invalid.</dd> +<dd><code><a href="../../../../../org/apache/commons/math3/linear/MatrixDimensionMismatchException.html" title="class in org.apache.commons.math3.linear">MatrixDimensionMismatchException</a></code> - if the column dimension of the + <code>matrix</code> is not <code>1</code>, or the row dimensions of <code>this</code> + and <code>matrix</code> do not match.</dd></dl> +</li> +</ul> +<a name="getRowVector(int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getRowVector</h4> +<pre><a href="../../../../../org/apache/commons/math3/linear/RealVector.html" title="class in org.apache.commons.math3.linear">RealVector</a> getRowVector(int row) + throws <a href="../../../../../org/apache/commons/math3/exception/OutOfRangeException.html" title="class in org.apache.commons.math3.exception">OutOfRangeException</a></pre> +<div class="block">Returns the entries in row number <code>row</code> as a vector. Row indices + start at 0.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>row</code> - Row to be fetched.</dd> +<dt><span class="strong">Returns:</span></dt><dd>a row vector.</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../../../org/apache/commons/math3/exception/OutOfRangeException.html" title="class in org.apache.commons.math3.exception">OutOfRangeException</a></code> - if the specified row index is invalid.</dd></dl> +</li> +</ul> +<a name="setRowVector(int, org.apache.commons.math3.linear.RealVector)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setRowVector</h4> +<pre>void setRowVector(int row, + <a href="../../../../../org/apache/commons/math3/linear/RealVector.html" title="class in org.apache.commons.math3.linear">RealVector</a> vector) + throws <a href="../../../../../org/apache/commons/math3/exception/OutOfRangeException.html" title="class in org.apache.commons.math3.exception">OutOfRangeException</a>, + <a href="../../../../../org/apache/commons/math3/linear/MatrixDimensionMismatchException.html" title="class in org.apache.commons.math3.linear">MatrixDimensionMismatchException</a></pre> +<div class="block">Sets the specified <code>row</code> of <code>this</code> matrix to the entries of + the specified <code>vector</code>. Row indices start at 0.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>row</code> - Row to be set.</dd><dd><code>vector</code> - row vector to be copied (must have the same number of + column as the instance).</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../../../org/apache/commons/math3/exception/OutOfRangeException.html" title="class in org.apache.commons.math3.exception">OutOfRangeException</a></code> - if the specified row index is invalid.</dd> +<dd><code><a href="../../../../../org/apache/commons/math3/linear/MatrixDimensionMismatchException.html" title="class in org.apache.commons.math3.linear">MatrixDimensionMismatchException</a></code> - if the <code>vector</code> dimension + does not match the column dimension of <code>this</code> matrix.</dd></dl> +</li> +</ul> +<a name="getColumnVector(int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getColumnVector</h4> +<pre><a href="../../../../../org/apache/commons/math3/linear/RealVector.html" title="class in org.apache.commons.math3.linear">RealVector</a> getColumnVector(int column) + throws <a href="../../../../../org/apache/commons/math3/exception/OutOfRangeException.html" title="class in org.apache.commons.math3.exception">OutOfRangeException</a></pre> +<div class="block">Get the entries at the given column index as a vector. Column indices + start at 0.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>column</code> - Column to be fetched.</dd> +<dt><span class="strong">Returns:</span></dt><dd>a column vector.</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../../../org/apache/commons/math3/exception/OutOfRangeException.html" title="class in org.apache.commons.math3.exception">OutOfRangeException</a></code> - if the specified column index is invalid</dd></dl> +</li> +</ul> +<a name="setColumnVector(int, org.apache.commons.math3.linear.RealVector)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setColumnVector</h4> +<pre>void setColumnVector(int column, + <a href="../../../../../org/apache/commons/math3/linear/RealVector.html" title="class in org.apache.commons.math3.linear">RealVector</a> vector) + throws <a href="../../../../../org/apache/commons/math3/exception/OutOfRangeException.html" title="class in org.apache.commons.math3.exception">OutOfRangeException</a>, + <a href="../../../../../org/apache/commons/math3/linear/MatrixDimensionMismatchException.html" title="class in org.apache.commons.math3.linear">MatrixDimensionMismatchException</a></pre> +<div class="block">Sets the specified <code>column</code> of <code>this</code> matrix to the entries + of the specified <code>vector</code>. Column indices start at 0.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>column</code> - Column to be set.</dd><dd><code>vector</code> - column vector to be copied (must have the same number of + rows as the instance).</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../../../org/apache/commons/math3/exception/OutOfRangeException.html" title="class in org.apache.commons.math3.exception">OutOfRangeException</a></code> - if the specified column index is invalid.</dd> +<dd><code><a href="../../../../../org/apache/commons/math3/linear/MatrixDimensionMismatchException.html" title="class in org.apache.commons.math3.linear">MatrixDimensionMismatchException</a></code> - if the <code>vector</code> dimension + does not match the row dimension of <code>this</code> matrix.</dd></dl> +</li> +</ul> +<a name="getRow(int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getRow</h4> +<pre>double[] getRow(int row) + throws <a href="../../../../../org/apache/commons/math3/exception/OutOfRangeException.html" title="class in org.apache.commons.math3.exception">OutOfRangeException</a></pre> +<div class="block">Get the entries at the given row index. Row indices start at 0.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>row</code> - Row to be fetched.</dd> +<dt><span class="strong">Returns:</span></dt><dd>the array of entries in the row.</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../../../org/apache/commons/math3/exception/OutOfRangeException.html" title="class in org.apache.commons.math3.exception">OutOfRangeException</a></code> - if the specified row index is not valid.</dd></dl> +</li> +</ul> +<a name="setRow(int, double[])"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setRow</h4> +<pre>void setRow(int row, + double[] array) + throws <a href="../../../../../org/apache/commons/math3/exception/OutOfRangeException.html" title="class in org.apache.commons.math3.exception">OutOfRangeException</a>, + <a href="../../../../../org/apache/commons/math3/linear/MatrixDimensionMismatchException.html" title="class in org.apache.commons.math3.linear">MatrixDimensionMismatchException</a></pre> +<div class="block">Sets the specified <code>row</code> of <code>this</code> matrix to the entries + of the specified <code>array</code>. Row indices start at 0.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>row</code> - Row to be set.</dd><dd><code>array</code> - Row matrix to be copied (must have the same number of + columns as the instance)</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../../../org/apache/commons/math3/exception/OutOfRangeException.html" title="class in org.apache.commons.math3.exception">OutOfRangeException</a></code> - if the specified row index is invalid.</dd> +<dd><code><a href="../../../../../org/apache/commons/math3/linear/MatrixDimensionMismatchException.html" title="class in org.apache.commons.math3.linear">MatrixDimensionMismatchException</a></code> - if the <code>array</code> length does + not match the column dimension of <code>this</code> matrix.</dd></dl> +</li> +</ul> +<a name="getColumn(int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getColumn</h4> +<pre>double[] getColumn(int column) + throws <a href="../../../../../org/apache/commons/math3/exception/OutOfRangeException.html" title="class in org.apache.commons.math3.exception">OutOfRangeException</a></pre> +<div class="block">Get the entries at the given column index as an array. Column indices + start at 0.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>column</code> - Column to be fetched.</dd> +<dt><span class="strong">Returns:</span></dt><dd>the array of entries in the column.</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../../../org/apache/commons/math3/exception/OutOfRangeException.html" title="class in org.apache.commons.math3.exception">OutOfRangeException</a></code> - if the specified column index is not valid.</dd></dl> +</li> +</ul> +<a name="setColumn(int, double[])"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setColumn</h4> +<pre>void setColumn(int column, + double[] array) + throws <a href="../../../../../org/apache/commons/math3/exception/OutOfRangeException.html" title="class in org.apache.commons.math3.exception">OutOfRangeException</a>, + <a href="../../../../../org/apache/commons/math3/linear/MatrixDimensionMismatchException.html" title="class in org.apache.commons.math3.linear">MatrixDimensionMismatchException</a></pre> +<div class="block">Sets the specified <code>column</code> of <code>this</code> matrix to the entries + of the specified <code>array</code>. Column indices start at 0.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>column</code> - Column to be set.</dd><dd><code>array</code> - Column array to be copied (must have the same number of + rows as the instance).</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../../../org/apache/commons/math3/exception/OutOfRangeException.html" title="class in org.apache.commons.math3.exception">OutOfRangeException</a></code> - if the specified column index is invalid.</dd> +<dd><code><a href="../../../../../org/apache/commons/math3/linear/MatrixDimensionMismatchException.html" title="class in org.apache.commons.math3.linear">MatrixDimensionMismatchException</a></code> - if the <code>array</code> length does + not match the row dimension of <code>this</code> matrix.</dd></dl> +</li> +</ul> +<a name="getEntry(int, int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getEntry</h4> +<pre>double getEntry(int row, + int column) + throws <a href="../../../../../org/apache/commons/math3/exception/OutOfRangeException.html" title="class in org.apache.commons.math3.exception">OutOfRangeException</a></pre> +<div class="block">Get the entry in the specified row and column. Row and column indices + start at 0.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>row</code> - Row index of entry to be fetched.</dd><dd><code>column</code> - Column index of entry to be fetched.</dd> +<dt><span class="strong">Returns:</span></dt><dd>the matrix entry at <code>(row, column)</code>.</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../../../org/apache/commons/math3/exception/OutOfRangeException.html" title="class in org.apache.commons.math3.exception">OutOfRangeException</a></code> - if the row or column index is not valid.</dd></dl> +</li> +</ul> +<a name="setEntry(int, int, double)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setEntry</h4> +<pre>void setEntry(int row, + int column, + double value) + throws <a href="../../../../../org/apache/commons/math3/exception/OutOfRangeException.html" title="class in org.apache.commons.math3.exception">OutOfRangeException</a></pre> +<div class="block">Set the entry in the specified row and column. Row and column indices + start at 0.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>row</code> - Row index of entry to be set.</dd><dd><code>column</code> - Column index of entry to be set.</dd><dd><code>value</code> - the new value of the entry.</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../../../org/apache/commons/math3/exception/OutOfRangeException.html" title="class in org.apache.commons.math3.exception">OutOfRangeException</a></code> - if the row or column index is not valid</dd><dt><span class="strong">Since:</span></dt> + <dd>2.0</dd></dl> +</li> +</ul> +<a name="addToEntry(int, int, double)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>addToEntry</h4> +<pre>void addToEntry(int row, + int column, + double increment) + throws <a href="../../../../../org/apache/commons/math3/exception/OutOfRangeException.html" title="class in org.apache.commons.math3.exception">OutOfRangeException</a></pre> +<div class="block">Adds (in place) the specified value to the specified entry of + <code>this</code> matrix. Row and column indices start at 0.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>row</code> - Row index of the entry to be modified.</dd><dd><code>column</code> - Column index of the entry to be modified.</dd><dd><code>increment</code> - value to add to the matrix entry.</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../../../org/apache/commons/math3/exception/OutOfRangeException.html" title="class in org.apache.commons.math3.exception">OutOfRangeException</a></code> - if the row or column index is not valid.</dd><dt><span class="strong">Since:</span></dt> + <dd>2.0</dd></dl> +</li> +</ul> +<a name="multiplyEntry(int, int, double)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>multiplyEntry</h4> +<pre>void multiplyEntry(int row, + int column, + double factor) + throws <a href="../../../../../org/apache/commons/math3/exception/OutOfRangeException.html" title="class in org.apache.commons.math3.exception">OutOfRangeException</a></pre> +<div class="block">Multiplies (in place) the specified entry of <code>this</code> matrix by the + specified value. Row and column indices start at 0.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>row</code> - Row index of the entry to be modified.</dd><dd><code>column</code> - Column index of the entry to be modified.</dd><dd><code>factor</code> - Multiplication factor for the matrix entry.</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../../../org/apache/commons/math3/exception/OutOfRangeException.html" title="class in org.apache.commons.math3.exception">OutOfRangeException</a></code> - if the row or column index is not valid.</dd><dt><span class="strong">Since:</span></dt> + <dd>2.0</dd></dl> +</li> +</ul> +<a name="transpose()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>transpose</h4> +<pre><a href="../../../../../org/apache/commons/math3/linear/RealMatrix.html" title="interface in org.apache.commons.math3.linear">RealMatrix</a> transpose()</pre> +<div class="block">Returns the transpose of this matrix.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>transpose matrix</dd></dl> +</li> +</ul> +<a name="getTrace()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getTrace</h4> +<pre>double getTrace() + throws <a href="../../../../../org/apache/commons/math3/linear/NonSquareMatrixException.html" title="class in org.apache.commons.math3.linear">NonSquareMatrixException</a></pre> +<div class="block">Returns the <a href="http://mathworld.wolfram.com/MatrixTrace.html"> + trace</a> of the matrix (the sum of the elements on the main diagonal).</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>the trace.</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../../../org/apache/commons/math3/linear/NonSquareMatrixException.html" title="class in org.apache.commons.math3.linear">NonSquareMatrixException</a></code> - if the matrix is not square.</dd></dl> +</li> +</ul> +<a name="operate(double[])"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>operate</h4> +<pre>double[] operate(double[] v) + throws <a href="../../../../../org/apache/commons/math3/exception/DimensionMismatchException.html" title="class in org.apache.commons.math3.exception">DimensionMismatchException</a></pre> +<div class="block">Returns the result of multiplying this by the vector <code>v</code>.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>v</code> - the vector to operate on</dd> +<dt><span class="strong">Returns:</span></dt><dd><code>this * v</code></dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../../../org/apache/commons/math3/exception/DimensionMismatchException.html" title="class in org.apache.commons.math3.exception">DimensionMismatchException</a></code> - if the length of <code>v</code> does not + match the column dimension of <code>this</code>.</dd></dl> +</li> +</ul> +<a name="operate(org.apache.commons.math3.linear.RealVector)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>operate</h4> +<pre><a href="../../../../../org/apache/commons/math3/linear/RealVector.html" title="class in org.apache.commons.math3.linear">RealVector</a> operate(<a href="../../../../../org/apache/commons/math3/linear/RealVector.html" title="class in org.apache.commons.math3.linear">RealVector</a> v) + throws <a href="../../../../../org/apache/commons/math3/exception/DimensionMismatchException.html" title="class in org.apache.commons.math3.exception">DimensionMismatchException</a></pre> +<div class="block">Returns the result of multiplying this by the vector <code>v</code>.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>v</code> - the vector to operate on</dd> +<dt><span class="strong">Returns:</span></dt><dd><code>this * v</code></dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../../../org/apache/commons/math3/exception/DimensionMismatchException.html" title="class in org.apache.commons.math3.exception">DimensionMismatchException</a></code> - if the dimension of <code>v</code> does not + match the column dimension of <code>this</code>.</dd></dl> +</li> +</ul> +<a name="preMultiply(double[])"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>preMultiply</h4> +<pre>double[] preMultiply(double[] v) + throws <a href="../../../../../org/apache/commons/math3/exception/DimensionMismatchException.html" title="class in org.apache.commons.math3.exception">DimensionMismatchException</a></pre> +<div class="block">Returns the (row) vector result of premultiplying this by the vector <code>v</code>.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>v</code> - the row vector to premultiply by</dd> +<dt><span class="strong">Returns:</span></dt><dd><code>v * this</code></dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../../../org/apache/commons/math3/exception/DimensionMismatchException.html" title="class in org.apache.commons.math3.exception">DimensionMismatchException</a></code> - if the length of <code>v</code> does not + match the row dimension of <code>this</code>.</dd></dl> +</li> +</ul> +<a name="preMultiply(org.apache.commons.math3.linear.RealVector)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>preMultiply</h4> +<pre><a href="../../../../../org/apache/commons/math3/linear/RealVector.html" title="class in org.apache.commons.math3.linear">RealVector</a> preMultiply(<a href="../../../../../org/apache/commons/math3/linear/RealVector.html" title="class in org.apache.commons.math3.linear">RealVector</a> v) + throws <a href="../../../../../org/apache/commons/math3/exception/DimensionMismatchException.html" title="class in org.apache.commons.math3.exception">DimensionMismatchException</a></pre> +<div class="block">Returns the (row) vector result of premultiplying this by the vector <code>v</code>.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>v</code> - the row vector to premultiply by</dd> +<dt><span class="strong">Returns:</span></dt><dd><code>v * this</code></dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../../../org/apache/commons/math3/exception/DimensionMismatchException.html" title="class in org.apache.commons.math3.exception">DimensionMismatchException</a></code> - if the dimension of <code>v</code> does not + match the row dimension of <code>this</code>.</dd></dl> +</li> +</ul> +<a name="walkInRowOrder(org.apache.commons.math3.linear.RealMatrixChangingVisitor)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>walkInRowOrder</h4> +<pre>double walkInRowOrder(<a href="../../../../../org/apache/commons/math3/linear/RealMatrixChangingVisitor.html" title="interface in org.apache.commons.math3.linear">RealMatrixChangingVisitor</a> visitor)</pre> +<div class="block">Visit (and possibly change) all matrix entries in row order. + <p>Row order starts at upper left and iterating through all elements + of a row from left to right before going to the leftmost element + of the next row.</p></div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>visitor</code> - visitor used to process all matrix entries</dd> +<dt><span class="strong">Returns:</span></dt><dd>the value returned by <a href="../../../../../org/apache/commons/math3/linear/RealMatrixChangingVisitor.html#end()"><code>RealMatrixChangingVisitor.end()</code></a> at the end + of the walk</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../org/apache/commons/math3/linear/RealMatrix.html#walkInRowOrder(org.apache.commons.math3.linear.RealMatrixPreservingVisitor)"><code>walkInRowOrder(RealMatrixPreservingVisitor)</code></a>, +<a href="../../../../../org/apache/commons/math3/linear/RealMatrix.html#walkInRowOrder(org.apache.commons.math3.linear.RealMatrixChangingVisitor,%20int,%20int,%20int,%20int)"><code>walkInRowOrder(RealMatrixChangingVisitor, int, int, int, int)</code></a>, +<a href="../../../../../org/apache/commons/math3/linear/RealMatrix.html#walkInRowOrder(org.apache.commons.math3.linear.RealMatrixPreservingVisitor,%20int,%20int,%20int,%20int)"><code>walkInRowOrder(RealMatrixPreservingVisitor, int, int, int, int)</code></a>, +<a href="../../../../../org/apache/commons/math3/linear/RealMatrix.html#walkInColumnOrder(org.apache.commons.math3.linear.RealMatrixChangingVisitor)"><code>walkInColumnOrder(RealMatrixChangingVisitor)</code></a>, +<a href="../../../../../org/apache/commons/math3/linear/RealMatrix.html#walkInColumnOrder(org.apache.commons.math3.linear.RealMatrixPreservingVisitor)"><code>walkInColumnOrder(RealMatrixPreservingVisitor)</code></a>, +<a href="../../../../../org/apache/commons/math3/linear/RealMatrix.html#walkInColumnOrder(org.apache.commons.math3.linear.RealMatrixChangingVisitor,%20int,%20int,%20int,%20int)"><code>walkInColumnOrder(RealMatrixChangingVisitor, int, int, int, int)</code></a>, +<a href="../../../../../org/apache/commons/math3/linear/RealMatrix.html#walkInColumnOrder(org.apache.commons.math3.linear.RealMatrixPreservingVisitor,%20int,%20int,%20int,%20int)"><code>walkInColumnOrder(RealMatrixPreservingVisitor, int, int, int, int)</code></a>, +<a href="../../../../../org/apache/commons/math3/linear/RealMatrix.html#walkInOptimizedOrder(org.apache.commons.math3.linear.RealMatrixChangingVisitor)"><code>walkInOptimizedOrder(RealMatrixChangingVisitor)</code></a>, +<a href="../../../../../org/apache/commons/math3/linear/RealMatrix.html#walkInOptimizedOrder(org.apache.commons.math3.linear.RealMatrixPreservingVisitor)"><code>walkInOptimizedOrder(RealMatrixPreservingVisitor)</code></a>, +<a href="../../../../../org/apache/commons/math3/linear/RealMatrix.html#walkInOptimizedOrder(org.apache.commons.math3.linear.RealMatrixChangingVisitor,%20int,%20int,%20int,%20int)"><code>walkInOptimizedOrder(RealMatrixChangingVisitor, int, int, int, int)</code></a>, +<a href="../../../../../org/apache/commons/math3/linear/RealMatrix.html#walkInOptimizedOrder(org.apache.commons.math3.linear.RealMatrixPreservingVisitor,%20int,%20int,%20int,%20int)"><code>walkInOptimizedOrder(RealMatrixPreservingVisitor, int, int, int, int)</code></a></dd></dl> +</li> +</ul> +<a name="walkInRowOrder(org.apache.commons.math3.linear.RealMatrixPreservingVisitor)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>walkInRowOrder</h4> +<pre>double walkInRowOrder(<a href="../../../../../org/apache/commons/math3/linear/RealMatrixPreservingVisitor.html" title="interface in org.apache.commons.math3.linear">RealMatrixPreservingVisitor</a> visitor)</pre> +<div class="block">Visit (but don't change) all matrix entries in row order. + <p>Row order starts at upper left and iterating through all elements + of a row from left to right before going to the leftmost element + of the next row.</p></div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>visitor</code> - visitor used to process all matrix entries</dd> +<dt><span class="strong">Returns:</span></dt><dd>the value returned by <a href="../../../../../org/apache/commons/math3/linear/RealMatrixPreservingVisitor.html#end()"><code>RealMatrixPreservingVisitor.end()</code></a> at the end + of the walk</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../org/apache/commons/math3/linear/RealMatrix.html#walkInRowOrder(org.apache.commons.math3.linear.RealMatrixChangingVisitor)"><code>walkInRowOrder(RealMatrixChangingVisitor)</code></a>, +<a href="../../../../../org/apache/commons/math3/linear/RealMatrix.html#walkInRowOrder(org.apache.commons.math3.linear.RealMatrixChangingVisitor,%20int,%20int,%20int,%20int)"><code>walkInRowOrder(RealMatrixChangingVisitor, int, int, int, int)</code></a>, +<a href="../../../../../org/apache/commons/math3/linear/RealMatrix.html#walkInRowOrder(org.apache.commons.math3.linear.RealMatrixPreservingVisitor,%20int,%20int,%20int,%20int)"><code>walkInRowOrder(RealMatrixPreservingVisitor, int, int, int, int)</code></a>, +<a href="../../../../../org/apache/commons/math3/linear/RealMatrix.html#walkInColumnOrder(org.apache.commons.math3.linear.RealMatrixChangingVisitor)"><code>walkInColumnOrder(RealMatrixChangingVisitor)</code></a>, +<a href="../../../../../org/apache/commons/math3/linear/RealMatrix.html#walkInColumnOrder(org.apache.commons.math3.linear.RealMatrixPreservingVisitor)"><code>walkInColumnOrder(RealMatrixPreservingVisitor)</code></a>, +<a href="../../../../../org/apache/commons/math3/linear/RealMatrix.html#walkInColumnOrder(org.apache.commons.math3.linear.RealMatrixChangingVisitor,%20int,%20int,%20int,%20int)"><code>walkInColumnOrder(RealMatrixChangingVisitor, int, int, int, int)</code></a>, +<a href="../../../../../org/apache/commons/math3/linear/RealMatrix.html#walkInColumnOrder(org.apache.commons.math3.linear.RealMatrixPreservingVisitor,%20int,%20int,%20int,%20int)"><code>walkInColumnOrder(RealMatrixPreservingVisitor, int, int, int, int)</code></a>, +<a href="../../../../../org/apache/commons/math3/linear/RealMatrix.html#walkInOptimizedOrder(org.apache.commons.math3.linear.RealMatrixChangingVisitor)"><code>walkInOptimizedOrder(RealMatrixChangingVisitor)</code></a>, +<a href="../../../../../org/apache/commons/math3/linear/RealMatrix.html#walkInOptimizedOrder(org.apache.commons.math3.linear.RealMatrixPreservingVisitor)"><code>walkInOptimizedOrder(RealMatrixPreservingVisitor)</code></a>, +<a href="../../../../../org/apache/commons/math3/linear/RealMatrix.html#walkInOptimizedOrder(org.apache.commons.math3.linear.RealMatrixChangingVisitor,%20int,%20int,%20int,%20int)"><code>walkInOptimizedOrder(RealMatrixChangingVisitor, int, int, int, int)</code></a>, +<a href="../../../../../org/apache/commons/math3/linear/RealMatrix.html#walkInOptimizedOrder(org.apache.commons.math3.linear.RealMatrixPreservingVisitor,%20int,%20int,%20int,%20int)"><code>walkInOptimizedOrder(RealMatrixPreservingVisitor, int, int, int, int)</code></a></dd></dl> +</li> +</ul> +<a name="walkInRowOrder(org.apache.commons.math3.linear.RealMatrixChangingVisitor, int, int, int, int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>walkInRowOrder</h4> +<pre>double walkInRowOrder(<a href="../../../../../org/apache/commons/math3/linear/RealMatrixChangingVisitor.html" title="interface in org.apache.commons.math3.linear">RealMatrixChangingVisitor</a> visitor, + int startRow, + int endRow, + int startColumn, + int endColumn) + throws <a href="../../../../../org/apache/commons/math3/exception/OutOfRangeException.html" title="class in org.apache.commons.math3.exception">OutOfRangeException</a>, + <a href="../../../../../org/apache/commons/math3/exception/NumberIsTooSmallException.html" title="class in org.apache.commons.math3.exception">NumberIsTooSmallException</a></pre> +<div class="block">Visit (and possibly change) some matrix entries in row order. + <p>Row order starts at upper left and iterating through all elements + of a row from left to right before going to the leftmost element + of the next row.</p></div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>visitor</code> - visitor used to process all matrix entries</dd><dd><code>startRow</code> - Initial row index</dd><dd><code>endRow</code> - Final row index (inclusive)</dd><dd><code>startColumn</code> - Initial column index</dd><dd><code>endColumn</code> - Final column index</dd> +<dt><span class="strong">Returns:</span></dt><dd>the value returned by <a href="../../../../../org/apache/commons/math3/linear/RealMatrixChangingVisitor.html#end()"><code>RealMatrixChangingVisitor.end()</code></a> at the end + of the walk</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../../../org/apache/commons/math3/exception/OutOfRangeException.html" title="class in org.apache.commons.math3.exception">OutOfRangeException</a></code> - if the indices are not valid.</dd> +<dd><code><a href="../../../../../org/apache/commons/math3/exception/NumberIsTooSmallException.html" title="class in org.apache.commons.math3.exception">NumberIsTooSmallException</a></code> - if <code>endRow < startRow</code> or + <code>endColumn < startColumn</code>.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../org/apache/commons/math3/linear/RealMatrix.html#walkInRowOrder(org.apache.commons.math3.linear.RealMatrixChangingVisitor)"><code>walkInRowOrder(RealMatrixChangingVisitor)</code></a>, +<a href="../../../../../org/apache/commons/math3/linear/RealMatrix.html#walkInRowOrder(org.apache.commons.math3.linear.RealMatrixPreservingVisitor)"><code>walkInRowOrder(RealMatrixPreservingVisitor)</code></a>, +<a href="../../../../../org/apache/commons/math3/linear/RealMatrix.html#walkInRowOrder(org.apache.commons.math3.linear.RealMatrixPreservingVisitor,%20int,%20int,%20int,%20int)"><code>walkInRowOrder(RealMatrixPreservingVisitor, int, int, int, int)</code></a>, +<a href="../../../../../org/apache/commons/math3/linear/RealMatrix.html#walkInColumnOrder(org.apache.commons.math3.linear.RealMatrixChangingVisitor)"><code>walkInColumnOrder(RealMatrixChangingVisitor)</code></a>, +<a href="../../../../../org/apache/commons/math3/linear/RealMatrix.html#walkInColumnOrder(org.apache.commons.math3.linear.RealMatrixPreservingVisitor)"><code>walkInColumnOrder(RealMatrixPreservingVisitor)</code></a>, +<a href="../../../../../org/apache/commons/math3/linear/RealMatrix.html#walkInColumnOrder(org.apache.commons.math3.linear.RealMatrixChangingVisitor,%20int,%20int,%20int,%20int)"><code>walkInColumnOrder(RealMatrixChangingVisitor, int, int, int, int)</code></a>, +<a href="../../../../../org/apache/commons/math3/linear/RealMatrix.html#walkInColumnOrder(org.apache.commons.math3.linear.RealMatrixPreservingVisitor,%20int,%20int,%20int,%20int)"><code>walkInColumnOrder(RealMatrixPreservingVisitor, int, int, int, int)</code></a>, +<a href="../../../../../org/apache/commons/math3/linear/RealMatrix.html#walkInOptimizedOrder(org.apache.commons.math3.linear.RealMatrixChangingVisitor)"><code>walkInOptimizedOrder(RealMatrixChangingVisitor)</code></a>, +<a href="../../../../../org/apache/commons/math3/linear/RealMatrix.html#walkInOptimizedOrder(org.apache.commons.math3.linear.RealMatrixPreservingVisitor)"><code>walkInOptimizedOrder(RealMatrixPreservingVisitor)</code></a>, +<a href="../../../../../org/apache/commons/math3/linear/RealMatrix.html#walkInOptimizedOrder(org.apache.commons.math3.linear.RealMatrixChangingVisitor,%20int,%20int,%20int,%20int)"><code>walkInOptimizedOrder(RealMatrixChangingVisitor, int, int, int, int)</code></a>, +<a href="../../../../../org/apache/commons/math3/linear/RealMatrix.html#walkInOptimizedOrder(org.apache.commons.math3.linear.RealMatrixPreservingVisitor,%20int,%20int,%20int,%20int)"><code>walkInOptimizedOrder(RealMatrixPreservingVisitor, int, int, int, int)</code></a></dd></dl> +</li> +</ul> +<a name="walkInRowOrder(org.apache.commons.math3.linear.RealMatrixPreservingVisitor, int, int, int, int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>walkInRowOrder</h4> +<pre>double walkInRowOrder(<a href="../../../../../org/apache/commons/math3/linear/RealMatrixPreservingVisitor.html" title="interface in org.apache.commons.math3.linear">RealMatrixPreservingVisitor</a> visitor, + int startRow, + int endRow, + int startColumn, + int endColumn) + throws <a href="../../../../../org/apache/commons/math3/exception/OutOfRangeException.html" title="class in org.apache.commons.math3.exception">OutOfRangeException</a>, + <a href="../../../../../org/apache/commons/math3/exception/NumberIsTooSmallException.html" title="class in org.apache.commons.math3.exception">NumberIsTooSmallException</a></pre> +<div class="block">Visit (but don't change) some matrix entries in row order. + <p>Row order starts at upper left and iterating through all elements + of a row from left to right before going to the leftmost element + of the next row.</p></div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>visitor</code> - visitor used to process all matrix entries</dd><dd><code>startRow</code> - Initial row index</dd><dd><code>endRow</code> - Final row index (inclusive)</dd><dd><code>startColumn</code> - Initial column index</dd><dd><code>endColumn</code> - Final column index</dd> +<dt><span class="strong">Returns:</span></dt><dd>the value returned by <a href="../../../../../org/apache/commons/math3/linear/RealMatrixPreservingVisitor.html#end()"><code>RealMatrixPreservingVisitor.end()</code></a> at the end + of the walk</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../../../org/apache/commons/math3/exception/OutOfRangeException.html" title="class in org.apache.commons.math3.exception">OutOfRangeException</a></code> - if the indices are not valid.</dd> +<dd><code><a href="../../../../../org/apache/commons/math3/exception/NumberIsTooSmallException.html" title="class in org.apache.commons.math3.exception">NumberIsTooSmallException</a></code> - if <code>endRow < startRow</code> or + <code>endColumn < startColumn</code>.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../org/apache/commons/math3/linear/RealMatrix.html#walkInRowOrder(org.apache.commons.math3.linear.RealMatrixChangingVisitor)"><code>walkInRowOrder(RealMatrixChangingVisitor)</code></a>, +<a href="../../../../../org/apache/commons/math3/linear/RealMatrix.html#walkInRowOrder(org.apache.commons.math3.linear.RealMatrixPreservingVisitor)"><code>walkInRowOrder(RealMatrixPreservingVisitor)</code></a>, +<a href="../../../../../org/apache/commons/math3/linear/RealMatrix.html#walkInRowOrder(org.apache.commons.math3.linear.RealMatrixChangingVisitor,%20int,%20int,%20int,%20int)"><code>walkInRowOrder(RealMatrixChangingVisitor, int, int, int, int)</code></a>, +<a href="../../../../../org/apache/commons/math3/linear/RealMatrix.html#walkInColumnOrder(org.apache.commons.math3.linear.RealMatrixChangingVisitor)"><code>walkInColumnOrder(RealMatrixChangingVisitor)</code></a>, +<a href="../../../../../org/apache/commons/math3/linear/RealMatrix.html#walkInColumnOrder(org.apache.commons.math3.linear.RealMatrixPreservingVisitor)"><code>walkInColumnOrder(RealMatrixPreservingVisitor)</code></a>, +<a href="../../../../../org/apache/commons/math3/linear/RealMatrix.html#walkInColumnOrder(org.apache.commons.math3.linear.RealMatrixChangingVisitor,%20int,%20int,%20int,%20int)"><code>walkInColumnOrder(RealMatrixChangingVisitor, int, int, int, int)</code></a>, +<a href="../../../../../org/apache/commons/math3/linear/RealMatrix.html#walkInColumnOrder(org.apache.commons.math3.linear.RealMatrixPreservingVisitor,%20int,%20int,%20int,%20int)"><code>walkInColumnOrder(RealMatrixPreservingVisitor, int, int, int, int)</code></a>, +<a href="../../../../../org/apache/commons/math3/linear/RealMatrix.html#walkInOptimizedOrder(org.apache.commons.math3.linear.RealMatrixChangingVisitor)"><code>walkInOptimizedOrder(RealMatrixChangingVisitor)</code></a>, +<a href="../../../../../org/apache/commons/math3/linear/RealMatrix.html#walkInOptimizedOrder(org.apache.commons.math3.linear.RealMatrixPreservingVisitor)"><code>walkInOptimizedOrder(RealMatrixPreservingVisitor)</code></a>, +<a href="../../../../../org/apache/commons/math3/linear/RealMatrix.html#walkInOptimizedOrder(org.apache.commons.math3.linear.RealMatrixChangingVisitor,%20int,%20int,%20int,%20int)"><code>walkInOptimizedOrder(RealMatrixChangingVisitor, int, int, int, int)</code></a>, +<a href="../../../../../org/apache/commons/math3/linear/RealMatrix.html#walkInOptimizedOrder(org.apache.commons.math3.linear.RealMatrixPreservingVisitor,%20int,%20int,%20int,%20int)"><code>walkInOptimizedOrder(RealMatrixPreservingVisitor, int, int, int, int)</code></a></dd></dl> +</li> +</ul> +<a name="walkInColumnOrder(org.apache.commons.math3.linear.RealMatrixChangingVisitor)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>walkInColumnOrder</h4> +<pre>double walkInColumnOrder(<a href="../../../../../org/apache/commons/math3/linear/RealMatrixChangingVisitor.html" title="interface in org.apache.commons.math3.linear">RealMatrixChangingVisitor</a> visitor)</pre> +<div class="block">Visit (and possibly change) all matrix entries in column order. + <p>Column order starts at upper left and iterating through all elements + of a column from top to bottom before going to the topmost element + of the next column.</p></div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>visitor</code> - visitor used to process all matrix entries</dd> +<dt><span class="strong">Returns:</span></dt><dd>the value returned by <a href="../../../../../org/apache/commons/math3/linear/RealMatrixChangingVisitor.html#end()"><code>RealMatrixChangingVisitor.end()</code></a> at the end + of the walk</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../org/apache/commons/math3/linear/RealMatrix.html#walkInRowOrder(org.apache.commons.math3.linear.RealMatrixChangingVisitor)"><code>walkInRowOrder(RealMatrixChangingVisitor)</code></a>, +<a href="../../../../../org/apache/commons/math3/linear/RealMatrix.html#walkInRowOrder(org.apache.commons.math3.linear.RealMatrixPreservingVisitor)"><code>walkInRowOrder(RealMatrixPreservingVisitor)</code></a>, +<a href="../../../../../org/apache/commons/math3/linear/RealMatrix.html#walkInRowOrder(org.apache.commons.math3.linear.RealMatrixChangingVisitor,%20int,%20int,%20int,%20int)"><code>walkInRowOrder(RealMatrixChangingVisitor, int, int, int, int)</code></a>, +<a href="../../../../../org/apache/commons/math3/linear/RealMatrix.html#walkInRowOrder(org.apache.commons.math3.linear.RealMatrixPreservingVisitor,%20int,%20int,%20int,%20int)"><code>walkInRowOrder(RealMatrixPreservingVisitor, int, int, int, int)</code></a>, +<a href="../../../../../org/apache/commons/math3/linear/RealMatrix.html#walkInColumnOrder(org.apache.commons.math3.linear.RealMatrixPreservingVisitor)"><code>walkInColumnOrder(RealMatrixPreservingVisitor)</code></a>, +<a href="../../../../../org/apache/commons/math3/linear/RealMatrix.html#walkInColumnOrder(org.apache.commons.math3.linear.RealMatrixChangingVisitor,%20int,%20int,%20int,%20int)"><code>walkInColumnOrder(RealMatrixChangingVisitor, int, int, int, int)</code></a>, +<a href="../../../../../org/apache/commons/math3/linear/RealMatrix.html#walkInColumnOrder(org.apache.commons.math3.linear.RealMatrixPreservingVisitor,%20int,%20int,%20int,%20int)"><code>walkInColumnOrder(RealMatrixPreservingVisitor, int, int, int, int)</code></a>, +<a href="../../../../../org/apache/commons/math3/linear/RealMatrix.html#walkInOptimizedOrder(org.apache.commons.math3.linear.RealMatrixChangingVisitor)"><code>walkInOptimizedOrder(RealMatrixChangingVisitor)</code></a>, +<a href="../../../../../org/apache/commons/math3/linear/RealMatrix.html#walkInOptimizedOrder(org.apache.commons.math3.linear.RealMatrixPreservingVisitor)"><code>walkInOptimizedOrder(RealMatrixPreservingVisitor)</code></a>, +<a href="../../../../../org/apache/commons/math3/linear/RealMatrix.html#walkInOptimizedOrder(org.apache.commons.math3.linear.RealMatrixChangingVisitor,%20int,%20int,%20int,%20int)"><code>walkInOptimizedOrder(RealMatrixChangingVisitor, int, int, int, int)</code></a>, +<a href="../../../../../org/apache/commons/math3/linear/RealMatrix.html#walkInOptimizedOrder(org.apache.commons.math3.linear.RealMatrixPreservingVisitor,%20int,%20int,%20int,%20int)"><code>walkInOptimizedOrder(RealMatrixPreservingVisitor, int, int, int, int)</code></a></dd></dl> +</li> +</ul> +<a name="walkInColumnOrder(org.apache.commons.math3.linear.RealMatrixPreservingVisitor)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>walkInColumnOrder</h4> +<pre>double walkInColumnOrder(<a href="../../../../../org/apache/commons/math3/linear/RealMatrixPreservingVisitor.html" title="interface in org.apache.commons.math3.linear">RealMatrixPreservingVisitor</a> visitor)</pre> +<div class="block">Visit (but don't change) all matrix entries in column order. + <p>Column order starts at upper left and iterating through all elements + of a column from top to bottom before going to the topmost element + of the next column.</p></div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>visitor</code> - visitor used to process all matrix entries</dd> +<dt><span class="strong">Returns:</span></dt><dd>the value returned by <a href="../../../../../org/apache/commons/math3/linear/RealMatrixPreservingVisitor.html#end()"><code>RealMatrixPreservingVisitor.end()</code></a> at the end + of the walk</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../org/apache/commons/math3/linear/RealMatrix.html#walkInRowOrder(org.apache.commons.math3.linear.RealMatrixChangingVisitor)"><code>walkInRowOrder(RealMatrixChangingVisitor)</code></a>, +<a href="../../../../../org/apache/commons/math3/linear/RealMatrix.html#walkInRowOrder(org.apache.commons.math3.linear.RealMatrixPreservingVisitor)"><code>walkInRowOrder(RealMatrixPreservingVisitor)</code></a>, +<a href="../../../../../org/apache/commons/math3/linear/RealMatrix.html#walkInRowOrder(org.apache.commons.math3.linear.RealMatrixChangingVisitor,%20int,%20int,%20int,%20int)"><code>walkInRowOrder(RealMatrixChangingVisitor, int, int, int, int)</code></a>, +<a href="../../../../../org/apache/commons/math3/linear/RealMatrix.html#walkInRowOrder(org.apache.commons.math3.linear.RealMatrixPreservingVisitor,%20int,%20int,%20int,%20int)"><code>walkInRowOrder(RealMatrixPreservingVisitor, int, int, int, int)</code></a>, +<a href="../../../../../org/apache/commons/math3/linear/RealMatrix.html#walkInColumnOrder(org.apache.commons.math3.linear.RealMatrixChangingVisitor)"><code>walkInColumnOrder(RealMatrixChangingVisitor)</code></a>, +<a href="../../../../../org/apache/commons/math3/linear/RealMatrix.html#walkInColumnOrder(org.apache.commons.math3.linear.RealMatrixChangingVisitor,%20int,%20int,%20int,%20int)"><code>walkInColumnOrder(RealMatrixChangingVisitor, int, int, int, int)</code></a>, +<a href="../../../../../org/apache/commons/math3/linear/RealMatrix.html#walkInColumnOrder(org.apache.commons.math3.linear.RealMatrixPreservingVisitor,%20int,%20int,%20int,%20int)"><code>walkInColumnOrder(RealMatrixPreservingVisitor, int, int, int, int)</code></a>, +<a href="../../../../../org/apache/commons/math3/linear/RealMatrix.html#walkInOptimizedOrder(org.apache.commons.math3.linear.RealMatrixChangingVisitor)"><code>walkInOptimizedOrder(RealMatrixChangingVisitor)</code></a>, +<a href="../../../../../org/apache/commons/math3/linear/RealMatrix.html#walkInOptimizedOrder(org.apache.commons.math3.linear.RealMatrixPreservingVisitor)"><code>walkInOptimizedOrder(RealMatrixPreservingVisitor)</code></a>, +<a href="../../../../../org/apache/commons/math3/linear/RealMatrix.html#walkInOptimizedOrder(org.apache.commons.math3.linear.RealMatrixChangingVisitor,%20int,%20int,%20int,%20int)"><code>walkInOptimizedOrder(RealMatrixChangingVisitor, int, int, int, int)</code></a>, +<a href="../../../../../org/apache/commons/math3/linear/RealMatrix.html#walkInOptimizedOrder(org.apache.commons.math3.linear.RealMatrixPreservingVisitor,%20int,%20int,%20int,%20int)"><code>walkInOptimizedOrder(RealMatrixPreservingVisitor, int, int, int, int)</code></a></dd></dl> +</li> +</ul> +<a name="walkInColumnOrder(org.apache.commons.math3.linear.RealMatrixChangingVisitor, int, int, int, int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>walkInColumnOrder</h4> +<pre>double walkInColumnOrder(<a href="../../../../../org/apache/commons/math3/linear/RealMatrixChangingVisitor.html" title="interface in org.apache.commons.math3.linear">RealMatrixChangingVisitor</a> visitor, + int startRow, + int endRow, + int startColumn, + int endColumn) + throws <a href="../../../../../org/apache/commons/math3/exception/OutOfRangeException.html" title="class in org.apache.commons.math3.exception">OutOfRangeException</a>, + <a href="../../../../../org/apache/commons/math3/exception/NumberIsTooSmallException.html" title="class in org.apache.commons.math3.exception">NumberIsTooSmallException</a></pre> +<div class="block">Visit (and possibly change) some matrix entries in column order. + <p>Column order starts at upper left and iterating through all elements + of a column from top to bottom before going to the topmost element + of the next column.</p></div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>visitor</code> - visitor used to process all matrix entries</dd><dd><code>startRow</code> - Initial row index</dd><dd><code>endRow</code> - Final row index (inclusive)</dd><dd><code>startColumn</code> - Initial column index</dd><dd><code>endColumn</code> - Final column index</dd> +<dt><span class="strong">Returns:</span></dt><dd>the value returned by <a href="../../../../../org/apache/commons/math3/linear/RealMatrixChangingVisitor.html#end()"><code>RealMatrixChangingVisitor.end()</code></a> at the end + of the walk</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../../../org/apache/commons/math3/exception/OutOfRangeException.html" title="class in org.apache.commons.math3.exception">OutOfRangeException</a></code> - if the indices are not valid.</dd> +<dd><code><a href="../../../../../org/apache/commons/math3/exception/NumberIsTooSmallException.html" title="class in org.apache.commons.math3.exception">NumberIsTooSmallException</a></code> - if <code>endRow < startRow</code> or + <code>endColumn < startColumn</code>.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../org/apache/commons/math3/linear/RealMatrix.html#walkInRowOrder(org.apache.commons.math3.linear.RealMatrixChangingVisitor)"><code>walkInRowOrder(RealMatrixChangingVisitor)</code></a>, +<a href="../../../../../org/apache/commons/math3/linear/RealMatrix.html#walkInRowOrder(org.apache.commons.math3.linear.RealMatrixPreservingVisitor)"><code>walkInRowOrder(RealMatrixPreservingVisitor)</code></a>, +<a href="../../../../../org/apache/commons/math3/linear/RealMatrix.html#walkInRowOrder(org.apache.commons.math3.linear.RealMatrixChangingVisitor,%20int,%20int,%20int,%20int)"><code>walkInRowOrder(RealMatrixChangingVisitor, int, int, int, int)</code></a>, +<a href="../../../../../org/apache/commons/math3/linear/RealMatrix.html#walkInRowOrder(org.apache.commons.math3.linear.RealMatrixPreservingVisitor,%20int,%20int,%20int,%20int)"><code>walkInRowOrder(RealMatrixPreservingVisitor, int, int, int, int)</code></a>, +<a href="../../../../../org/apache/commons/math3/linear/RealMatrix.html#walkInColumnOrder(org.apache.commons.math3.linear.RealMatrixChangingVisitor)"><code>walkInColumnOrder(RealMatrixChangingVisitor)</code></a>, +<a href="../../../../../org/apache/commons/math3/linear/RealMatrix.html#walkInColumnOrder(org.apache.commons.math3.linear.RealMatrixPreservingVisitor)"><code>walkInColumnOrder(RealMatrixPreservingVisitor)</code></a>, +<a href="../../../../../org/apache/commons/math3/linear/RealMatrix.html#walkInColumnOrder(org.apache.commons.math3.linear.RealMatrixPreservingVisitor,%20int,%20int,%20int,%20int)"><code>walkInColumnOrder(RealMatrixPreservingVisitor, int, int, int, int)</code></a>, +<a href="../../../../../org/apache/commons/math3/linear/RealMatrix.html#walkInOptimizedOrder(org.apache.commons.math3.linear.RealMatrixChangingVisitor)"><code>walkInOptimizedOrder(RealMatrixChangingVisitor)</code></a>, +<a href="../../../../../org/apache/commons/math3/linear/RealMatrix.html#walkInOptimizedOrder(org.apache.commons.math3.linear.RealMatrixPreservingVisitor)"><code>walkInOptimizedOrder(RealMatrixPreservingVisitor)</code></a>, +<a href="../../../../../org/apache/commons/math3/linear/RealMatrix.html#walkInOptimizedOrder(org.apache.commons.math3.linear.RealMatrixChangingVisitor,%20int,%20int,%20int,%20int)"><code>walkInOptimizedOrder(RealMatrixChangingVisitor, int, int, int, int)</code></a>, +<a href="../../../../../org/apache/commons/math3/linear/RealMatrix.html#walkInOptimizedOrder(org.apache.commons.math3.linear.RealMatrixPreservingVisitor,%20int,%20int,%20int,%20int)"><code>walkInOptimizedOrder(RealMatrixPreservingVisitor, int, int, int, int)</code></a></dd></dl> +</li> +</ul> +<a name="walkInColumnOrder(org.apache.commons.math3.linear.RealMatrixPreservingVisitor, int, int, int, int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>walkInColumnOrder</h4> +<pre>double walkInColumnOrder(<a href="../../../../../org/apache/commons/math3/linear/RealMatrixPreservingVisitor.html" title="interface in org.apache.commons.math3.linear">RealMatrixPreservingVisitor</a> visitor, + int startRow, + int endRow, + int startColumn, + int endColumn) + throws <a href="../../../../../org/apache/commons/math3/exception/OutOfRangeException.html" title="class in org.apache.commons.math3.exception">OutOfRangeException</a>, + <a href="../../../../../org/apache/commons/math3/exception/NumberIsTooSmallException.html" title="class in org.apache.commons.math3.exception">NumberIsTooSmallException</a></pre> +<div class="block">Visit (but don't change) some matrix entries in column order. + <p>Column order starts at upper left and iterating through all elements + of a column from top to bottom before going to the topmost element + of the next column.</p></div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>visitor</code> - visitor used to process all matrix entries</dd><dd><code>startRow</code> - Initial row index</dd><dd><code>endRow</code> - Final row index (inclusive)</dd><dd><code>startColumn</code> - Initial column index</dd><dd><code>endColumn</code> - Final column index</dd> +<dt><span class="strong">Returns:</span></dt><dd>the value returned by <a href="../../../../../org/apache/commons/math3/linear/RealMatrixPreservingVisitor.html#end()"><code>RealMatrixPreservingVisitor.end()</code></a> at the end + of the walk</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../../../org/apache/commons/math3/exception/OutOfRangeException.html" title="class in org.apache.commons.math3.exception">OutOfRangeException</a></code> - if the indices are not valid.</dd> +<dd><code><a href="../../../../../org/apache/commons/math3/exception/NumberIsTooSmallException.html" title="class in org.apache.commons.math3.exception">NumberIsTooSmallException</a></code> - if <code>endRow < startRow</code> or + <code>endColumn < startColumn</code>.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../org/apache/commons/math3/linear/RealMatrix.html#walkInRowOrder(org.apache.commons.math3.linear.RealMatrixChangingVisitor)"><code>walkInRowOrder(RealMatrixChangingVisitor)</code></a>, +<a href="../../../../../org/apache/commons/math3/linear/RealMatrix.html#walkInRowOrder(org.apache.commons.math3.linear.RealMatrixPreservingVisitor)"><code>walkInRowOrder(RealMatrixPreservingVisitor)</code></a>, +<a href="../../../../../org/apache/commons/math3/linear/RealMatrix.html#walkInRowOrder(org.apache.commons.math3.linear.RealMatrixChangingVisitor,%20int,%20int,%20int,%20int)"><code>walkInRowOrder(RealMatrixChangingVisitor, int, int, int, int)</code></a>, +<a href="../../../../../org/apache/commons/math3/linear/RealMatrix.html#walkInRowOrder(org.apache.commons.math3.linear.RealMatrixPreservingVisitor,%20int,%20int,%20int,%20int)"><code>walkInRowOrder(RealMatrixPreservingVisitor, int, int, int, int)</code></a>, +<a href="../../../../../org/apache/commons/math3/linear/RealMatrix.html#walkInColumnOrder(org.apache.commons.math3.linear.RealMatrixChangingVisitor)"><code>walkInColumnOrder(RealMatrixChangingVisitor)</code></a>, +<a href="../../../../../org/apache/commons/math3/linear/RealMatrix.html#walkInColumnOrder(org.apache.commons.math3.linear.RealMatrixPreservingVisitor)"><code>walkInColumnOrder(RealMatrixPreservingVisitor)</code></a>, +<a href="../../../../../org/apache/commons/math3/linear/RealMatrix.html#walkInColumnOrder(org.apache.commons.math3.linear.RealMatrixChangingVisitor,%20int,%20int,%20int,%20int)"><code>walkInColumnOrder(RealMatrixChangingVisitor, int, int, int, int)</code></a>, +<a href="../../../../../org/apache/commons/math3/linear/RealMatrix.html#walkInOptimizedOrder(org.apache.commons.math3.linear.RealMatrixChangingVisitor)"><code>walkInOptimizedOrder(RealMatrixChangingVisitor)</code></a>, +<a href="../../../../../org/apache/commons/math3/linear/RealMatrix.html#walkInOptimizedOrder(org.apache.commons.math3.linear.RealMatrixPreservingVisitor)"><code>walkInOptimizedOrder(RealMatrixPreservingVisitor)</code></a>, +<a href="../../../../../org/apache/commons/math3/linear/RealMatrix.html#walkInOptimizedOrder(org.apache.commons.math3.linear.RealMatrixChangingVisitor,%20int,%20int,%20int,%20int)"><code>walkInOptimizedOrder(RealMatrixChangingVisitor, int, int, int, int)</code></a>, +<a href="../../../../../org/apache/commons/math3/linear/RealMatrix.html#walkInOptimizedOrder(org.apache.commons.math3.linear.RealMatrixPreservingVisitor,%20int,%20int,%20int,%20int)"><code>walkInOptimizedOrder(RealMatrixPreservingVisitor, int, int, int, int)</code></a></dd></dl> +</li> +</ul> +<a name="walkInOptimizedOrder(org.apache.commons.math3.linear.RealMatrixChangingVisitor)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>walkInOptimizedOrder</h4> +<pre>double walkInOptimizedOrder(<a href="../../../../../org/apache/commons/math3/linear/RealMatrixChangingVisitor.html" title="interface in org.apache.commons.math3.linear">RealMatrixChangingVisitor</a> visitor)</pre> +<div class="block">Visit (and possibly change) all matrix entries using the fastest possible order. + <p>The fastest walking order depends on the exact matrix class. It may be + different from traditional row or column orders.</p></div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>visitor</code> - visitor used to process all matrix entries</dd> +<dt><span class="strong">Returns:</span></dt><dd>the value returned by <a href="../../../../../org/apache/commons/math3/linear/RealMatrixChangingVisitor.html#end()"><code>RealMatrixChangingVisitor.end()</code></a> at the end + of the walk</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../org/apache/commons/math3/linear/RealMatrix.html#walkInRowOrder(org.apache.commons.math3.linear.RealMatrixChangingVisitor)"><code>walkInRowOrder(RealMatrixChangingVisitor)</code></a>, +<a href="../../../../../org/apache/commons/math3/linear/RealMatrix.html#walkInRowOrder(org.apache.commons.math3.linear.RealMatrixPreservingVisitor)"><code>walkInRowOrder(RealMatrixPreservingVisitor)</code></a>, +<a href="../../../../../org/apache/commons/math3/linear/RealMatrix.html#walkInRowOrder(org.apache.commons.math3.linear.RealMatrixChangingVisitor,%20int,%20int,%20int,%20int)"><code>walkInRowOrder(RealMatrixChangingVisitor, int, int, int, int)</code></a>, +<a href="../../../../../org/apache/commons/math3/linear/RealMatrix.html#walkInRowOrder(org.apache.commons.math3.linear.RealMatrixPreservingVisitor,%20int,%20int,%20int,%20int)"><code>walkInRowOrder(RealMatrixPreservingVisitor, int, int, int, int)</code></a>, +<a href="../../../../../org/apache/commons/math3/linear/RealMatrix.html#walkInColumnOrder(org.apache.commons.math3.linear.RealMatrixChangingVisitor)"><code>walkInColumnOrder(RealMatrixChangingVisitor)</code></a>, +<a href="../../../../../org/apache/commons/math3/linear/RealMatrix.html#walkInColumnOrder(org.apache.commons.math3.linear.RealMatrixPreservingVisitor)"><code>walkInColumnOrder(RealMatrixPreservingVisitor)</code></a>, +<a href="../../../../../org/apache/commons/math3/linear/RealMatrix.html#walkInColumnOrder(org.apache.commons.math3.linear.RealMatrixChangingVisitor,%20int,%20int,%20int,%20int)"><code>walkInColumnOrder(RealMatrixChangingVisitor, int, int, int, int)</code></a>, +<a href="../../../../../org/apache/commons/math3/linear/RealMatrix.html#walkInColumnOrder(org.apache.commons.math3.linear.RealMatrixPreservingVisitor,%20int,%20int,%20int,%20int)"><code>walkInColumnOrder(RealMatrixPreservingVisitor, int, int, int, int)</code></a>, +<a href="../../../../../org/apache/commons/math3/linear/RealMatrix.html#walkInOptimizedOrder(org.apache.commons.math3.linear.RealMatrixPreservingVisitor)"><code>walkInOptimizedOrder(RealMatrixPreservingVisitor)</code></a>, +<a href="../../../../../org/apache/commons/math3/linear/RealMatrix.html#walkInOptimizedOrder(org.apache.commons.math3.linear.RealMatrixChangingVisitor,%20int,%20int,%20int,%20int)"><code>walkInOptimizedOrder(RealMatrixChangingVisitor, int, int, int, int)</code></a>, +<a href="../../../../../org/apache/commons/math3/linear/RealMatrix.html#walkInOptimizedOrder(org.apache.commons.math3.linear.RealMatrixPreservingVisitor,%20int,%20int,%20int,%20int)"><code>walkInOptimizedOrder(RealMatrixPreservingVisitor, int, int, int, int)</code></a></dd></dl> +</li> +</ul> +<a name="walkInOptimizedOrder(org.apache.commons.math3.linear.RealMatrixPreservingVisitor)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>walkInOptimizedOrder</h4> +<pre>double walkInOptimizedOrder(<a href="../../../../../org/apache/commons/math3/linear/RealMatrixPreservingVisitor.html" title="interface in org.apache.commons.math3.linear">RealMatrixPreservingVisitor</a> visitor)</pre> +<div class="block">Visit (but don't change) all matrix entries using the fastest possible order. + <p>The fastest walking order depends on the exact matrix class. It may be + different from traditional row or column orders.</p></div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>visitor</code> - visitor used to process all matrix entries</dd> +<dt><span class="strong">Returns:</span></dt><dd>the value returned by <a href="../../../../../org/apache/commons/math3/linear/RealMatrixPreservingVisitor.html#end()"><code>RealMatrixPreservingVisitor.end()</code></a> at the end + of the walk</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../org/apache/commons/math3/linear/RealMatrix.html#walkInRowOrder(org.apache.commons.math3.linear.RealMatrixChangingVisitor)"><code>walkInRowOrder(RealMatrixChangingVisitor)</code></a>, +<a href="../../../../../org/apache/commons/math3/linear/RealMatrix.html#walkInRowOrder(org.apache.commons.math3.linear.RealMatrixPreservingVisitor)"><code>walkInRowOrder(RealMatrixPreservingVisitor)</code></a>, +<a href="../../../../../org/apache/commons/math3/linear/RealMatrix.html#walkInRowOrder(org.apache.commons.math3.linear.RealMatrixChangingVisitor,%20int,%20int,%20int,%20int)"><code>walkInRowOrder(RealMatrixChangingVisitor, int, int, int, int)</code></a>, +<a href="../../../../../org/apache/commons/math3/linear/RealMatrix.html#walkInRowOrder(org.apache.commons.math3.linear.RealMatrixPreservingVisitor,%20int,%20int,%20int,%20int)"><code>walkInRowOrder(RealMatrixPreservingVisitor, int, int, int, int)</code></a>, +<a href="../../../../../org/apache/commons/math3/linear/RealMatrix.html#walkInColumnOrder(org.apache.commons.math3.linear.RealMatrixChangingVisitor)"><code>walkInColumnOrder(RealMatrixChangingVisitor)</code></a>, +<a href="../../../../../org/apache/commons/math3/linear/RealMatrix.html#walkInColumnOrder(org.apache.commons.math3.linear.RealMatrixPreservingVisitor)"><code>walkInColumnOrder(RealMatrixPreservingVisitor)</code></a>, +<a href="../../../../../org/apache/commons/math3/linear/RealMatrix.html#walkInColumnOrder(org.apache.commons.math3.linear.RealMatrixChangingVisitor,%20int,%20int,%20int,%20int)"><code>walkInColumnOrder(RealMatrixChangingVisitor, int, int, int, int)</code></a>, +<a href="../../../../../org/apache/commons/math3/linear/RealMatrix.html#walkInColumnOrder(org.apache.commons.math3.linear.RealMatrixPreservingVisitor,%20int,%20int,%20int,%20int)"><code>walkInColumnOrder(RealMatrixPreservingVisitor, int, int, int, int)</code></a>, +<a href="../../../../../org/apache/commons/math3/linear/RealMatrix.html#walkInOptimizedOrder(org.apache.commons.math3.linear.RealMatrixChangingVisitor)"><code>walkInOptimizedOrder(RealMatrixChangingVisitor)</code></a>, +<a href="../../../../../org/apache/commons/math3/linear/RealMatrix.html#walkInOptimizedOrder(org.apache.commons.math3.linear.RealMatrixChangingVisitor,%20int,%20int,%20int,%20int)"><code>walkInOptimizedOrder(RealMatrixChangingVisitor, int, int, int, int)</code></a>, +<a href="../../../../../org/apache/commons/math3/linear/RealMatrix.html#walkInOptimizedOrder(org.apache.commons.math3.linear.RealMatrixPreservingVisitor,%20int,%20int,%20int,%20int)"><code>walkInOptimizedOrder(RealMatrixPreservingVisitor, int, int, int, int)</code></a></dd></dl> +</li> +</ul> +<a name="walkInOptimizedOrder(org.apache.commons.math3.linear.RealMatrixChangingVisitor, int, int, int, int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>walkInOptimizedOrder</h4> +<pre>double walkInOptimizedOrder(<a href="../../../../../org/apache/commons/math3/linear/RealMatrixChangingVisitor.html" title="interface in org.apache.commons.math3.linear">RealMatrixChangingVisitor</a> visitor, + int startRow, + int endRow, + int startColumn, + int endColumn) + throws <a href="../../../../../org/apache/commons/math3/exception/OutOfRangeException.html" title="class in org.apache.commons.math3.exception">OutOfRangeException</a>, + <a href="../../../../../org/apache/commons/math3/exception/NumberIsTooSmallException.html" title="class in org.apache.commons.math3.exception">NumberIsTooSmallException</a></pre> +<div class="block">Visit (and possibly change) some matrix entries using the fastest possible order. + <p>The fastest walking order depends on the exact matrix class. It may be + different from traditional row or column orders.</p></div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>visitor</code> - visitor used to process all matrix entries</dd><dd><code>startRow</code> - Initial row index</dd><dd><code>endRow</code> - Final row index (inclusive)</dd><dd><code>startColumn</code> - Initial column index</dd><dd><code>endColumn</code> - Final column index (inclusive)</dd> +<dt><span class="strong">Returns:</span></dt><dd>the value returned by <a href="../../../../../org/apache/commons/math3/linear/RealMatrixChangingVisitor.html#end()"><code>RealMatrixChangingVisitor.end()</code></a> at the end + of the walk</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../../../org/apache/commons/math3/exception/OutOfRangeException.html" title="class in org.apache.commons.math3.exception">OutOfRangeException</a></code> - if the indices are not valid.</dd> +<dd><code><a href="../../../../../org/apache/commons/math3/exception/NumberIsTooSmallException.html" title="class in org.apache.commons.math3.exception">NumberIsTooSmallException</a></code> - if <code>endRow < startRow</code> or + <code>endColumn < startColumn</code>.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../org/apache/commons/math3/linear/RealMatrix.html#walkInRowOrder(org.apache.commons.math3.linear.RealMatrixChangingVisitor)"><code>walkInRowOrder(RealMatrixChangingVisitor)</code></a>, +<a href="../../../../../org/apache/commons/math3/linear/RealMatrix.html#walkInRowOrder(org.apache.commons.math3.linear.RealMatrixPreservingVisitor)"><code>walkInRowOrder(RealMatrixPreservingVisitor)</code></a>, +<a href="../../../../../org/apache/commons/math3/linear/RealMatrix.html#walkInRowOrder(org.apache.commons.math3.linear.RealMatrixChangingVisitor,%20int,%20int,%20int,%20int)"><code>walkInRowOrder(RealMatrixChangingVisitor, int, int, int, int)</code></a>, +<a href="../../../../../org/apache/commons/math3/linear/RealMatrix.html#walkInRowOrder(org.apache.commons.math3.linear.RealMatrixPreservingVisitor,%20int,%20int,%20int,%20int)"><code>walkInRowOrder(RealMatrixPreservingVisitor, int, int, int, int)</code></a>, +<a href="../../../../../org/apache/commons/math3/linear/RealMatrix.html#walkInColumnOrder(org.apache.commons.math3.linear.RealMatrixChangingVisitor)"><code>walkInColumnOrder(RealMatrixChangingVisitor)</code></a>, +<a href="../../../../../org/apache/commons/math3/linear/RealMatrix.html#walkInColumnOrder(org.apache.commons.math3.linear.RealMatrixPreservingVisitor)"><code>walkInColumnOrder(RealMatrixPreservingVisitor)</code></a>, +<a href="../../../../../org/apache/commons/math3/linear/RealMatrix.html#walkInColumnOrder(org.apache.commons.math3.linear.RealMatrixChangingVisitor,%20int,%20int,%20int,%20int)"><code>walkInColumnOrder(RealMatrixChangingVisitor, int, int, int, int)</code></a>, +<a href="../../../../../org/apache/commons/math3/linear/RealMatrix.html#walkInColumnOrder(org.apache.commons.math3.linear.RealMatrixPreservingVisitor,%20int,%20int,%20int,%20int)"><code>walkInColumnOrder(RealMatrixPreservingVisitor, int, int, int, int)</code></a>, +<a href="../../../../../org/apache/commons/math3/linear/RealMatrix.html#walkInOptimizedOrder(org.apache.commons.math3.linear.RealMatrixChangingVisitor)"><code>walkInOptimizedOrder(RealMatrixChangingVisitor)</code></a>, +<a href="../../../../../org/apache/commons/math3/linear/RealMatrix.html#walkInOptimizedOrder(org.apache.commons.math3.linear.RealMatrixPreservingVisitor)"><code>walkInOptimizedOrder(RealMatrixPreservingVisitor)</code></a>, +<a href="../../../../../org/apache/commons/math3/linear/RealMatrix.html#walkInOptimizedOrder(org.apache.commons.math3.linear.RealMatrixPreservingVisitor,%20int,%20int,%20int,%20int)"><code>walkInOptimizedOrder(RealMatrixPreservingVisitor, int, int, int, int)</code></a></dd></dl> +</li> +</ul> +<a name="walkInOptimizedOrder(org.apache.commons.math3.linear.RealMatrixPreservingVisitor, int, int, int, int)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>walkInOptimizedOrder</h4> +<pre>double walkInOptimizedOrder(<a href="../../../../../org/apache/commons/math3/linear/RealMatrixPreservingVisitor.html" title="interface in org.apache.commons.math3.linear">RealMatrixPreservingVisitor</a> visitor, + int startRow, + int endRow, + int startColumn, + int endColumn) + throws <a href="../../../../../org/apache/commons/math3/exception/OutOfRangeException.html" title="class in org.apache.commons.math3.exception">OutOfRangeException</a>, + <a href="../../../../../org/apache/commons/math3/exception/NumberIsTooSmallException.html" title="class in org.apache.commons.math3.exception">NumberIsTooSmallException</a></pre> +<div class="block">Visit (but don't change) some matrix entries using the fastest possible order. + <p>The fastest walking order depends on the exact matrix class. It may be + different from traditional row or column orders.</p></div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>visitor</code> - visitor used to process all matrix entries</dd><dd><code>startRow</code> - Initial row index</dd><dd><code>endRow</code> - Final row index (inclusive)</dd><dd><code>startColumn</code> - Initial column index</dd><dd><code>endColumn</code> - Final column index (inclusive)</dd> +<dt><span class="strong">Returns:</span></dt><dd>the value returned by <a href="../../../../../org/apache/commons/math3/linear/RealMatrixPreservingVisitor.html#end()"><code>RealMatrixPreservingVisitor.end()</code></a> at the end + of the walk</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../../../org/apache/commons/math3/exception/OutOfRangeException.html" title="class in org.apache.commons.math3.exception">OutOfRangeException</a></code> - if the indices are not valid.</dd> +<dd><code><a href="../../../../../org/apache/commons/math3/exception/NumberIsTooSmallException.html" title="class in org.apache.commons.math3.exception">NumberIsTooSmallException</a></code> - if <code>endRow < startRow</code> or + <code>endColumn < startColumn</code>.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../org/apache/commons/math3/linear/RealMatrix.html#walkInRowOrder(org.apache.commons.math3.linear.RealMatrixChangingVisitor)"><code>walkInRowOrder(RealMatrixChangingVisitor)</code></a>, +<a href="../../../../../org/apache/commons/math3/linear/RealMatrix.html#walkInRowOrder(org.apache.commons.math3.linear.RealMatrixPreservingVisitor)"><code>walkInRowOrder(RealMatrixPreservingVisitor)</code></a>, +<a href="../../../../../org/apache/commons/math3/linear/RealMatrix.html#walkInRowOrder(org.apache.commons.math3.linear.RealMatrixChangingVisitor,%20int,%20int,%20int,%20int)"><code>walkInRowOrder(RealMatrixChangingVisitor, int, int, int, int)</code></a>, +<a href="../../../../../org/apache/commons/math3/linear/RealMatrix.html#walkInRowOrder(org.apache.commons.math3.linear.RealMatrixPreservingVisitor,%20int,%20int,%20int,%20int)"><code>walkInRowOrder(RealMatrixPreservingVisitor, int, int, int, int)</code></a>, +<a href="../../../../../org/apache/commons/math3/linear/RealMatrix.html#walkInColumnOrder(org.apache.commons.math3.linear.RealMatrixChangingVisitor)"><code>walkInColumnOrder(RealMatrixChangingVisitor)</code></a>, +<a href="../../../../../org/apache/commons/math3/linear/RealMatrix.html#walkInColumnOrder(org.apache.commons.math3.linear.RealMatrixPreservingVisitor)"><code>walkInColumnOrder(RealMatrixPreservingVisitor)</code></a>, +<a href="../../../../../org/apache/commons/math3/linear/RealMatrix.html#walkInColumnOrder(org.apache.commons.math3.linear.RealMatrixChangingVisitor,%20int,%20int,%20int,%20int)"><code>walkInColumnOrder(RealMatrixChangingVisitor, int, int, int, int)</code></a>, +<a href="../../../../../org/apache/commons/math3/linear/RealMatrix.html#walkInColumnOrder(org.apache.commons.math3.linear.RealMatrixPreservingVisitor,%20int,%20int,%20int,%20int)"><code>walkInColumnOrder(RealMatrixPreservingVisitor, int, int, int, int)</code></a>, +<a href="../../../../../org/apache/commons/math3/linear/RealMatrix.html#walkInOptimizedOrder(org.apache.commons.math3.linear.RealMatrixChangingVisitor)"><code>walkInOptimizedOrder(RealMatrixChangingVisitor)</code></a>, +<a href="../../../../../org/apache/commons/math3/linear/RealMatrix.html#walkInOptimizedOrder(org.apache.commons.math3.linear.RealMatrixPreservingVisitor)"><code>walkInOptimizedOrder(RealMatrixPreservingVisitor)</code></a>, +<a href="../../../../../org/apache/commons/math3/linear/RealMatrix.html#walkInOptimizedOrder(org.apache.commons.math3.linear.RealMatrixChangingVisitor,%20int,%20int,%20int,%20int)"><code>walkInOptimizedOrder(RealMatrixChangingVisitor, int, int, int, int)</code></a></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/RealMatrix.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><a href="../../../../../org/apache/commons/math3/linear/RealLinearOperator.html" title="class in org.apache.commons.math3.linear"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/commons/math3/linear/RealMatrixChangingVisitor.html" title="interface in org.apache.commons.math3.linear"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/commons/math3/linear/RealMatrix.html" target="_top">Frames</a></li> +<li><a href="RealMatrix.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: </li> +<li>Nested | </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </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 © 2003–2016 <a href="http://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</body> +</html> |