| <!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>FieldDecompositionSolver (Apache Commons Math 3.3 API)</title> |
| <link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="FieldDecompositionSolver (Apache Commons Math 3.3 API)"; |
| } |
| //--> |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a name="navbar_top"> |
| <!-- --> |
| </a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/FieldDecompositionSolver.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/EigenDecomposition.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/FieldLUDecomposition.html" title="class 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/FieldDecompositionSolver.html" target="_top">Frames</a></li> |
| <li><a href="FieldDecompositionSolver.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 FieldDecompositionSolver" class="title">Interface FieldDecompositionSolver<T extends <a href="../../../../../org/apache/commons/math3/FieldElement.html" title="interface in org.apache.commons.math3">FieldElement</a><T>></h2> |
| </div> |
| <div class="contentContainer"> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl><dt><span class="strong">Type Parameters:</span></dt><dd><code>T</code> - the type of the field elements</dd></dl> |
| <hr> |
| <br> |
| <pre>public interface <span class="strong">FieldDecompositionSolver<T extends <a href="../../../../../org/apache/commons/math3/FieldElement.html" title="interface in org.apache.commons.math3">FieldElement</a><T>></span></pre> |
| <div class="block">Interface handling decomposition algorithms that can solve A × X = B. |
| <p>Decomposition algorithms decompose an A matrix has a product of several specific |
| matrices from which they can solve A × X = B in least squares sense: they find X |
| such that ||A × X - B|| is minimal.</p> |
| <p>Some solvers like <a href="../../../../../org/apache/commons/math3/linear/FieldLUDecomposition.html" title="class in org.apache.commons.math3.linear"><code>FieldLUDecomposition</code></a> can only find the solution for |
| square matrices and when the solution is an exact linear solution, i.e. when |
| ||A × X - B|| is exactly 0. Other solvers can also find solutions |
| with non-square matrix A and with non-null minimal norm. If an exact linear |
| solution exists it is also the minimal norm solution.</p></div> |
| <dl><dt><span class="strong">Since:</span></dt> |
| <dd>2.0</dd> |
| <dt><span class="strong">Version:</span></dt> |
| <dd>$Id: FieldDecompositionSolver.java 1416643 2012-12-03 19:37:14Z tn $</dd></dl> |
| </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/FieldMatrix.html" title="interface in org.apache.commons.math3.linear">FieldMatrix</a><<a href="../../../../../org/apache/commons/math3/linear/FieldDecompositionSolver.html" title="type parameter in FieldDecompositionSolver">T</a>></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/commons/math3/linear/FieldDecompositionSolver.html#getInverse()">getInverse</a></strong>()</code> |
| <div class="block">Get the inverse (or pseudo-inverse) of the decomposed matrix.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/commons/math3/linear/FieldDecompositionSolver.html#isNonSingular()">isNonSingular</a></strong>()</code> |
| <div class="block">Check if the decomposed matrix is non-singular.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/commons/math3/linear/FieldMatrix.html" title="interface in org.apache.commons.math3.linear">FieldMatrix</a><<a href="../../../../../org/apache/commons/math3/linear/FieldDecompositionSolver.html" title="type parameter in FieldDecompositionSolver">T</a>></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/commons/math3/linear/FieldDecompositionSolver.html#solve(org.apache.commons.math3.linear.FieldMatrix)">solve</a></strong>(<a href="../../../../../org/apache/commons/math3/linear/FieldMatrix.html" title="interface in org.apache.commons.math3.linear">FieldMatrix</a><<a href="../../../../../org/apache/commons/math3/linear/FieldDecompositionSolver.html" title="type parameter in FieldDecompositionSolver">T</a>> b)</code> |
| <div class="block">Solve the linear equation A × X = B for matrices A.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/commons/math3/linear/FieldVector.html" title="interface in org.apache.commons.math3.linear">FieldVector</a><<a href="../../../../../org/apache/commons/math3/linear/FieldDecompositionSolver.html" title="type parameter in FieldDecompositionSolver">T</a>></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/commons/math3/linear/FieldDecompositionSolver.html#solve(org.apache.commons.math3.linear.FieldVector)">solve</a></strong>(<a href="../../../../../org/apache/commons/math3/linear/FieldVector.html" title="interface in org.apache.commons.math3.linear">FieldVector</a><<a href="../../../../../org/apache/commons/math3/linear/FieldDecompositionSolver.html" title="type parameter in FieldDecompositionSolver">T</a>> b)</code> |
| <div class="block">Solve the linear equation A × X = B for matrices A.</div> |
| </td> |
| </tr> |
| </table> |
| </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="solve(org.apache.commons.math3.linear.FieldVector)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>solve</h4> |
| <pre><a href="../../../../../org/apache/commons/math3/linear/FieldVector.html" title="interface in org.apache.commons.math3.linear">FieldVector</a><<a href="../../../../../org/apache/commons/math3/linear/FieldDecompositionSolver.html" title="type parameter in FieldDecompositionSolver">T</a>> solve(<a href="../../../../../org/apache/commons/math3/linear/FieldVector.html" title="interface in org.apache.commons.math3.linear">FieldVector</a><<a href="../../../../../org/apache/commons/math3/linear/FieldDecompositionSolver.html" title="type parameter in FieldDecompositionSolver">T</a>> b)</pre> |
| <div class="block">Solve the linear equation A × X = B for matrices A. |
| <p>The A matrix is implicit, it is provided by the underlying |
| decomposition algorithm.</p></div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>b</code> - right-hand side of the equation A × X = B</dd> |
| <dt><span class="strong">Returns:</span></dt><dd>a vector X that minimizes the two norm of A × X - B</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 matrices dimensions do not match.</dd> |
| <dd><code><a href="../../../../../org/apache/commons/math3/linear/SingularMatrixException.html" title="class in org.apache.commons.math3.linear">SingularMatrixException</a></code> - if the decomposed matrix is singular.</dd></dl> |
| </li> |
| </ul> |
| <a name="solve(org.apache.commons.math3.linear.FieldMatrix)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>solve</h4> |
| <pre><a href="../../../../../org/apache/commons/math3/linear/FieldMatrix.html" title="interface in org.apache.commons.math3.linear">FieldMatrix</a><<a href="../../../../../org/apache/commons/math3/linear/FieldDecompositionSolver.html" title="type parameter in FieldDecompositionSolver">T</a>> solve(<a href="../../../../../org/apache/commons/math3/linear/FieldMatrix.html" title="interface in org.apache.commons.math3.linear">FieldMatrix</a><<a href="../../../../../org/apache/commons/math3/linear/FieldDecompositionSolver.html" title="type parameter in FieldDecompositionSolver">T</a>> b)</pre> |
| <div class="block">Solve the linear equation A × X = B for matrices A. |
| <p>The A matrix is implicit, it is provided by the underlying |
| decomposition algorithm.</p></div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>b</code> - right-hand side of the equation A × X = B</dd> |
| <dt><span class="strong">Returns:</span></dt><dd>a matrix X that minimizes the two norm of A × X - B</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 matrices dimensions do not match.</dd> |
| <dd><code><a href="../../../../../org/apache/commons/math3/linear/SingularMatrixException.html" title="class in org.apache.commons.math3.linear">SingularMatrixException</a></code> - if the decomposed matrix is singular.</dd></dl> |
| </li> |
| </ul> |
| <a name="isNonSingular()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isNonSingular</h4> |
| <pre>boolean isNonSingular()</pre> |
| <div class="block">Check if the decomposed matrix is non-singular.</div> |
| <dl><dt><span class="strong">Returns:</span></dt><dd>true if the decomposed matrix is non-singular</dd></dl> |
| </li> |
| </ul> |
| <a name="getInverse()"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>getInverse</h4> |
| <pre><a href="../../../../../org/apache/commons/math3/linear/FieldMatrix.html" title="interface in org.apache.commons.math3.linear">FieldMatrix</a><<a href="../../../../../org/apache/commons/math3/linear/FieldDecompositionSolver.html" title="type parameter in FieldDecompositionSolver">T</a>> getInverse()</pre> |
| <div class="block">Get the inverse (or pseudo-inverse) of the decomposed matrix.</div> |
| <dl><dt><span class="strong">Returns:</span></dt><dd>inverse matrix</dd> |
| <dt><span class="strong">Throws:</span></dt> |
| <dd><code><a href="../../../../../org/apache/commons/math3/linear/SingularMatrixException.html" title="class in org.apache.commons.math3.linear">SingularMatrixException</a></code> - if the decomposed matrix is singular.</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/FieldDecompositionSolver.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/EigenDecomposition.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/FieldLUDecomposition.html" title="class 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/FieldDecompositionSolver.html" target="_top">Frames</a></li> |
| <li><a href="FieldDecompositionSolver.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–2014 <a href="http://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> |
| </body> |
| </html> |
