|
15
|
1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
|
|
|
2 <!--NewPage-->
|
|
|
3 <HTML>
|
|
|
4 <HEAD>
|
|
|
5 <!-- Generated by javadoc (build 1.6.0_17) on Sat Mar 27 22:46:13 EDT 2010 -->
|
|
|
6 <META http-equiv="Content-Type" content="text/html; charset=UTF-8">
|
|
|
7 <TITLE>
|
|
|
8 CholeskyDecompositionImpl (Commons Math 2.1 API)
|
|
|
9 </TITLE>
|
|
|
10
|
|
|
11 <META NAME="date" CONTENT="2010-03-27">
|
|
|
12
|
|
|
13 <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style">
|
|
|
14
|
|
|
15 <SCRIPT type="text/javascript">
|
|
|
16 function windowTitle()
|
|
|
17 {
|
|
|
18 if (location.href.indexOf('is-external=true') == -1) {
|
|
|
19 parent.document.title="CholeskyDecompositionImpl (Commons Math 2.1 API)";
|
|
|
20 }
|
|
|
21 }
|
|
|
22 </SCRIPT>
|
|
|
23 <NOSCRIPT>
|
|
|
24 </NOSCRIPT>
|
|
|
25
|
|
|
26 </HEAD>
|
|
|
27
|
|
|
28 <BODY BGCOLOR="white" onload="windowTitle();">
|
|
|
29 <HR>
|
|
|
30
|
|
|
31
|
|
|
32 <!-- ========= START OF TOP NAVBAR ======= -->
|
|
|
33 <A NAME="navbar_top"><!-- --></A>
|
|
|
34 <A HREF="#skip-navbar_top" title="Skip navigation links"></A>
|
|
|
35 <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
|
|
|
36 <TR>
|
|
|
37 <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
|
|
|
38 <A NAME="navbar_top_firstrow"><!-- --></A>
|
|
|
39 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
|
|
|
40 <TR ALIGN="center" VALIGN="top">
|
|
|
41 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
|
|
|
42 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
|
|
|
43 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
|
|
|
44 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/CholeskyDecompositionImpl.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD>
|
|
|
45 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
|
|
|
46 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
|
|
|
47 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
|
|
|
48 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
|
|
|
49 </TR>
|
|
|
50 </TABLE>
|
|
|
51 </TD>
|
|
|
52 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
|
|
|
53 </EM>
|
|
|
54 </TD>
|
|
|
55 </TR>
|
|
|
56
|
|
|
57 <TR>
|
|
|
58 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
|
|
59 <A HREF="../../../../../org/apache/commons/math/linear/CholeskyDecomposition.html" title="interface in org.apache.commons.math.linear"><B>PREV CLASS</B></A>
|
|
|
60 <A HREF="../../../../../org/apache/commons/math/linear/DecompositionSolver.html" title="interface in org.apache.commons.math.linear"><B>NEXT CLASS</B></A></FONT></TD>
|
|
|
61 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
|
|
62 <A HREF="../../../../../index.html?org/apache/commons/math/linear/CholeskyDecompositionImpl.html" target="_top"><B>FRAMES</B></A>
|
|
|
63 <A HREF="CholeskyDecompositionImpl.html" target="_top"><B>NO FRAMES</B></A>
|
|
|
64 <SCRIPT type="text/javascript">
|
|
|
65 <!--
|
|
|
66 if(window==top) {
|
|
|
67 document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
|
|
|
68 }
|
|
|
69 //-->
|
|
|
70 </SCRIPT>
|
|
|
71 <NOSCRIPT>
|
|
|
72 <A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
|
|
|
73 </NOSCRIPT>
|
|
|
74
|
|
|
75
|
|
|
76 </FONT></TD>
|
|
|
77 </TR>
|
|
|
78 <TR>
|
|
|
79 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
|
|
80 SUMMARY: NESTED | <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
|
|
|
81 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
|
|
82 DETAIL: <A HREF="#field_detail">FIELD</A> | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>
|
|
|
83 </TR>
|
|
|
84 </TABLE>
|
|
|
85 <A NAME="skip-navbar_top"></A>
|
|
|
86 <!-- ========= END OF TOP NAVBAR ========= -->
|
|
|
87
|
|
|
88 <HR>
|
|
|
89 <!-- ======== START OF CLASS DATA ======== -->
|
|
|
90 <H2>
|
|
|
91 <FONT SIZE="-1">
|
|
|
92 org.apache.commons.math.linear</FONT>
|
|
|
93 <BR>
|
|
|
94 Class CholeskyDecompositionImpl</H2>
|
|
|
95 <PRE>
|
|
|
96 <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</A>
|
|
|
97 <IMG SRC="../../../../../resources/inherit.gif" ALT="extended by "><B>org.apache.commons.math.linear.CholeskyDecompositionImpl</B>
|
|
|
98 </PRE>
|
|
|
99 <DL>
|
|
|
100 <DT><B>All Implemented Interfaces:</B> <DD><A HREF="../../../../../org/apache/commons/math/linear/CholeskyDecomposition.html" title="interface in org.apache.commons.math.linear">CholeskyDecomposition</A></DD>
|
|
|
101 </DL>
|
|
|
102 <HR>
|
|
|
103 <DL>
|
|
|
104 <DT><PRE>public class <A HREF="../../../../../src-html/org/apache/commons/math/linear/CholeskyDecompositionImpl.html#line.34"><B>CholeskyDecompositionImpl</B></A><DT>extends <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A><DT>implements <A HREF="../../../../../org/apache/commons/math/linear/CholeskyDecomposition.html" title="interface in org.apache.commons.math.linear">CholeskyDecomposition</A></DL>
|
|
|
105 </PRE>
|
|
|
106
|
|
|
107 <P>
|
|
|
108 Calculates the Cholesky decomposition of a matrix.
|
|
|
109 <p>The Cholesky decomposition of a real symmetric positive-definite
|
|
|
110 matrix A consists of a lower triangular matrix L with same size that
|
|
|
111 satisfy: A = LL<sup>T</sup>Q = I). In a sense, this is the square root of A.</p>
|
|
|
112 <P>
|
|
|
113
|
|
|
114 <P>
|
|
|
115 <DL>
|
|
|
116 <DT><B>Since:</B></DT>
|
|
|
117 <DD>2.0</DD>
|
|
|
118 <DT><B>Version:</B></DT>
|
|
|
119 <DD>$Revision: 811685 $ $Date: 2009-09-05 13:36:48 -0400 (Sat, 05 Sep 2009) $</DD>
|
|
|
120 <DT><B>See Also:</B><DD><a href="http://mathworld.wolfram.com/CholeskyDecomposition.html">MathWorld</a>,
|
|
|
121 <a href="http://en.wikipedia.org/wiki/Cholesky_decomposition">Wikipedia</a></DL>
|
|
|
122 <HR>
|
|
|
123
|
|
|
124 <P>
|
|
|
125 <!-- =========== FIELD SUMMARY =========== -->
|
|
|
126
|
|
|
127 <A NAME="field_summary"><!-- --></A>
|
|
|
128 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
|
|
129 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
|
|
|
130 <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
|
|
|
131 <B>Field Summary</B></FONT></TH>
|
|
|
132 </TR>
|
|
|
133 <TR BGCOLOR="white" CLASS="TableRowColor">
|
|
|
134 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
|
135 <CODE>static double</CODE></FONT></TD>
|
|
|
136 <TD><CODE><B><A HREF="../../../../../org/apache/commons/math/linear/CholeskyDecompositionImpl.html#DEFAULT_ABSOLUTE_POSITIVITY_THRESHOLD">DEFAULT_ABSOLUTE_POSITIVITY_THRESHOLD</A></B></CODE>
|
|
|
137
|
|
|
138 <BR>
|
|
|
139 Default threshold below which diagonal elements are considered null
|
|
|
140 and matrix not positive definite.</TD>
|
|
|
141 </TR>
|
|
|
142 <TR BGCOLOR="white" CLASS="TableRowColor">
|
|
|
143 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
|
144 <CODE>static double</CODE></FONT></TD>
|
|
|
145 <TD><CODE><B><A HREF="../../../../../org/apache/commons/math/linear/CholeskyDecompositionImpl.html#DEFAULT_RELATIVE_SYMMETRY_THRESHOLD">DEFAULT_RELATIVE_SYMMETRY_THRESHOLD</A></B></CODE>
|
|
|
146
|
|
|
147 <BR>
|
|
|
148 Default threshold above which off-diagonal elements are considered too different
|
|
|
149 and matrix not symmetric.</TD>
|
|
|
150 </TR>
|
|
|
151 </TABLE>
|
|
|
152
|
|
|
153 <!-- ======== CONSTRUCTOR SUMMARY ======== -->
|
|
|
154
|
|
|
155 <A NAME="constructor_summary"><!-- --></A>
|
|
|
156 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
|
|
157 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
|
|
|
158 <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
|
|
|
159 <B>Constructor Summary</B></FONT></TH>
|
|
|
160 </TR>
|
|
|
161 <TR BGCOLOR="white" CLASS="TableRowColor">
|
|
|
162 <TD><CODE><B><A HREF="../../../../../org/apache/commons/math/linear/CholeskyDecompositionImpl.html#CholeskyDecompositionImpl(org.apache.commons.math.linear.RealMatrix)">CholeskyDecompositionImpl</A></B>(<A HREF="../../../../../org/apache/commons/math/linear/RealMatrix.html" title="interface in org.apache.commons.math.linear">RealMatrix</A> matrix)</CODE>
|
|
|
163
|
|
|
164 <BR>
|
|
|
165 Calculates the Cholesky decomposition of the given matrix.</TD>
|
|
|
166 </TR>
|
|
|
167 <TR BGCOLOR="white" CLASS="TableRowColor">
|
|
|
168 <TD><CODE><B><A HREF="../../../../../org/apache/commons/math/linear/CholeskyDecompositionImpl.html#CholeskyDecompositionImpl(org.apache.commons.math.linear.RealMatrix, double, double)">CholeskyDecompositionImpl</A></B>(<A HREF="../../../../../org/apache/commons/math/linear/RealMatrix.html" title="interface in org.apache.commons.math.linear">RealMatrix</A> matrix,
|
|
|
169 double relativeSymmetryThreshold,
|
|
|
170 double absolutePositivityThreshold)</CODE>
|
|
|
171
|
|
|
172 <BR>
|
|
|
173 Calculates the Cholesky decomposition of the given matrix.</TD>
|
|
|
174 </TR>
|
|
|
175 </TABLE>
|
|
|
176
|
|
|
177 <!-- ========== METHOD SUMMARY =========== -->
|
|
|
178
|
|
|
179 <A NAME="method_summary"><!-- --></A>
|
|
|
180 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
|
|
181 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
|
|
|
182 <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
|
|
|
183 <B>Method Summary</B></FONT></TH>
|
|
|
184 </TR>
|
|
|
185 <TR BGCOLOR="white" CLASS="TableRowColor">
|
|
|
186 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
|
187 <CODE> double</CODE></FONT></TD>
|
|
|
188 <TD><CODE><B><A HREF="../../../../../org/apache/commons/math/linear/CholeskyDecompositionImpl.html#getDeterminant()">getDeterminant</A></B>()</CODE>
|
|
|
189
|
|
|
190 <BR>
|
|
|
191 Return the determinant of the matrix</TD>
|
|
|
192 </TR>
|
|
|
193 <TR BGCOLOR="white" CLASS="TableRowColor">
|
|
|
194 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
|
195 <CODE> <A HREF="../../../../../org/apache/commons/math/linear/RealMatrix.html" title="interface in org.apache.commons.math.linear">RealMatrix</A></CODE></FONT></TD>
|
|
|
196 <TD><CODE><B><A HREF="../../../../../org/apache/commons/math/linear/CholeskyDecompositionImpl.html#getL()">getL</A></B>()</CODE>
|
|
|
197
|
|
|
198 <BR>
|
|
|
199 Returns the matrix L of the decomposition.</TD>
|
|
|
200 </TR>
|
|
|
201 <TR BGCOLOR="white" CLASS="TableRowColor">
|
|
|
202 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
|
203 <CODE> <A HREF="../../../../../org/apache/commons/math/linear/RealMatrix.html" title="interface in org.apache.commons.math.linear">RealMatrix</A></CODE></FONT></TD>
|
|
|
204 <TD><CODE><B><A HREF="../../../../../org/apache/commons/math/linear/CholeskyDecompositionImpl.html#getLT()">getLT</A></B>()</CODE>
|
|
|
205
|
|
|
206 <BR>
|
|
|
207 Returns the transpose of the matrix L of the decomposition.</TD>
|
|
|
208 </TR>
|
|
|
209 <TR BGCOLOR="white" CLASS="TableRowColor">
|
|
|
210 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
|
211 <CODE> <A HREF="../../../../../org/apache/commons/math/linear/DecompositionSolver.html" title="interface in org.apache.commons.math.linear">DecompositionSolver</A></CODE></FONT></TD>
|
|
|
212 <TD><CODE><B><A HREF="../../../../../org/apache/commons/math/linear/CholeskyDecompositionImpl.html#getSolver()">getSolver</A></B>()</CODE>
|
|
|
213
|
|
|
214 <BR>
|
|
|
215 Get a solver for finding the A × X = B solution in least square sense.</TD>
|
|
|
216 </TR>
|
|
|
217 </TABLE>
|
|
|
218 <A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
|
|
|
219 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
|
|
220 <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
|
|
|
221 <TH ALIGN="left"><B>Methods inherited from class java.lang.<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A></B></TH>
|
|
|
222 </TR>
|
|
|
223 <TR BGCOLOR="white" CLASS="TableRowColor">
|
|
|
224 <TD><CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang">clone</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang">equals</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang">finalize</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang">toString</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait(long, int)" title="class or interface in java.lang">wait</A></CODE></TD>
|
|
|
225 </TR>
|
|
|
226 </TABLE>
|
|
|
227
|
|
|
228 <P>
|
|
|
229
|
|
|
230 <!-- ============ FIELD DETAIL =========== -->
|
|
|
231
|
|
|
232 <A NAME="field_detail"><!-- --></A>
|
|
|
233 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
|
|
234 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
|
|
|
235 <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
|
|
|
236 <B>Field Detail</B></FONT></TH>
|
|
|
237 </TR>
|
|
|
238 </TABLE>
|
|
|
239
|
|
|
240 <A NAME="DEFAULT_RELATIVE_SYMMETRY_THRESHOLD"><!-- --></A><H3>
|
|
|
241 DEFAULT_RELATIVE_SYMMETRY_THRESHOLD</H3>
|
|
|
242 <PRE>
|
|
|
243 public static final double <A HREF="../../../../../src-html/org/apache/commons/math/linear/CholeskyDecompositionImpl.html#line.38"><B>DEFAULT_RELATIVE_SYMMETRY_THRESHOLD</B></A></PRE>
|
|
|
244 <DL>
|
|
|
245 <DD>Default threshold above which off-diagonal elements are considered too different
|
|
|
246 and matrix not symmetric.
|
|
|
247 <P>
|
|
|
248 <DL>
|
|
|
249 <DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.apache.commons.math.linear.CholeskyDecompositionImpl.DEFAULT_RELATIVE_SYMMETRY_THRESHOLD">Constant Field Values</A></DL>
|
|
|
250 </DL>
|
|
|
251 <HR>
|
|
|
252
|
|
|
253 <A NAME="DEFAULT_ABSOLUTE_POSITIVITY_THRESHOLD"><!-- --></A><H3>
|
|
|
254 DEFAULT_ABSOLUTE_POSITIVITY_THRESHOLD</H3>
|
|
|
255 <PRE>
|
|
|
256 public static final double <A HREF="../../../../../src-html/org/apache/commons/math/linear/CholeskyDecompositionImpl.html#line.42"><B>DEFAULT_ABSOLUTE_POSITIVITY_THRESHOLD</B></A></PRE>
|
|
|
257 <DL>
|
|
|
258 <DD>Default threshold below which diagonal elements are considered null
|
|
|
259 and matrix not positive definite.
|
|
|
260 <P>
|
|
|
261 <DL>
|
|
|
262 <DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.apache.commons.math.linear.CholeskyDecompositionImpl.DEFAULT_ABSOLUTE_POSITIVITY_THRESHOLD">Constant Field Values</A></DL>
|
|
|
263 </DL>
|
|
|
264
|
|
|
265 <!-- ========= CONSTRUCTOR DETAIL ======== -->
|
|
|
266
|
|
|
267 <A NAME="constructor_detail"><!-- --></A>
|
|
|
268 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
|
|
269 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
|
|
|
270 <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
|
|
|
271 <B>Constructor Detail</B></FONT></TH>
|
|
|
272 </TR>
|
|
|
273 </TABLE>
|
|
|
274
|
|
|
275 <A NAME="CholeskyDecompositionImpl(org.apache.commons.math.linear.RealMatrix)"><!-- --></A><H3>
|
|
|
276 CholeskyDecompositionImpl</H3>
|
|
|
277 <PRE>
|
|
|
278 public <A HREF="../../../../../src-html/org/apache/commons/math/linear/CholeskyDecompositionImpl.html#line.71"><B>CholeskyDecompositionImpl</B></A>(<A HREF="../../../../../org/apache/commons/math/linear/RealMatrix.html" title="interface in org.apache.commons.math.linear">RealMatrix</A> matrix)
|
|
|
279 throws <A HREF="../../../../../org/apache/commons/math/linear/NonSquareMatrixException.html" title="class in org.apache.commons.math.linear">NonSquareMatrixException</A>,
|
|
|
280 <A HREF="../../../../../org/apache/commons/math/linear/NotSymmetricMatrixException.html" title="class in org.apache.commons.math.linear">NotSymmetricMatrixException</A>,
|
|
|
281 <A HREF="../../../../../org/apache/commons/math/linear/NotPositiveDefiniteMatrixException.html" title="class in org.apache.commons.math.linear">NotPositiveDefiniteMatrixException</A></PRE>
|
|
|
282 <DL>
|
|
|
283 <DD>Calculates the Cholesky decomposition of the given matrix.
|
|
|
284 <p>
|
|
|
285 Calling this constructor is equivalent to call <A HREF="../../../../../org/apache/commons/math/linear/CholeskyDecompositionImpl.html#CholeskyDecompositionImpl(org.apache.commons.math.linear.RealMatrix, double, double)"><CODE>CholeskyDecompositionImpl(RealMatrix, double, double)</CODE></A> with the
|
|
|
286 thresholds set to the default values <A HREF="../../../../../org/apache/commons/math/linear/CholeskyDecompositionImpl.html#DEFAULT_RELATIVE_SYMMETRY_THRESHOLD"><CODE>DEFAULT_RELATIVE_SYMMETRY_THRESHOLD</CODE></A> and <A HREF="../../../../../org/apache/commons/math/linear/CholeskyDecompositionImpl.html#DEFAULT_ABSOLUTE_POSITIVITY_THRESHOLD"><CODE>DEFAULT_ABSOLUTE_POSITIVITY_THRESHOLD</CODE></A>
|
|
|
287 </p>
|
|
|
288 <P>
|
|
|
289 <DL>
|
|
|
290 <DT><B>Parameters:</B><DD><CODE>matrix</CODE> - the matrix to decompose
|
|
|
291 <DT><B>Throws:</B>
|
|
|
292 <DD><CODE><A HREF="../../../../../org/apache/commons/math/linear/NonSquareMatrixException.html" title="class in org.apache.commons.math.linear">NonSquareMatrixException</A></CODE> - if matrix is not square
|
|
|
293 <DD><CODE><A HREF="../../../../../org/apache/commons/math/linear/NotSymmetricMatrixException.html" title="class in org.apache.commons.math.linear">NotSymmetricMatrixException</A></CODE> - if matrix is not symmetric
|
|
|
294 <DD><CODE><A HREF="../../../../../org/apache/commons/math/linear/NotPositiveDefiniteMatrixException.html" title="class in org.apache.commons.math.linear">NotPositiveDefiniteMatrixException</A></CODE> - if the matrix is not
|
|
|
295 strictly positive definite<DT><B>See Also:</B><DD><A HREF="../../../../../org/apache/commons/math/linear/CholeskyDecompositionImpl.html#CholeskyDecompositionImpl(org.apache.commons.math.linear.RealMatrix, double, double)"><CODE>CholeskyDecompositionImpl(RealMatrix, double, double)</CODE></A>,
|
|
|
296 <A HREF="../../../../../org/apache/commons/math/linear/CholeskyDecompositionImpl.html#DEFAULT_RELATIVE_SYMMETRY_THRESHOLD"><CODE>DEFAULT_RELATIVE_SYMMETRY_THRESHOLD</CODE></A>,
|
|
|
297 <A HREF="../../../../../org/apache/commons/math/linear/CholeskyDecompositionImpl.html#DEFAULT_ABSOLUTE_POSITIVITY_THRESHOLD"><CODE>DEFAULT_ABSOLUTE_POSITIVITY_THRESHOLD</CODE></A></DL>
|
|
|
298 </DL>
|
|
|
299 <HR>
|
|
|
300
|
|
|
301 <A NAME="CholeskyDecompositionImpl(org.apache.commons.math.linear.RealMatrix, double, double)"><!-- --></A><H3>
|
|
|
302 CholeskyDecompositionImpl</H3>
|
|
|
303 <PRE>
|
|
|
304 public <A HREF="../../../../../src-html/org/apache/commons/math/linear/CholeskyDecompositionImpl.html#line.93"><B>CholeskyDecompositionImpl</B></A>(<A HREF="../../../../../org/apache/commons/math/linear/RealMatrix.html" title="interface in org.apache.commons.math.linear">RealMatrix</A> matrix,
|
|
|
305 double relativeSymmetryThreshold,
|
|
|
306 double absolutePositivityThreshold)
|
|
|
307 throws <A HREF="../../../../../org/apache/commons/math/linear/NonSquareMatrixException.html" title="class in org.apache.commons.math.linear">NonSquareMatrixException</A>,
|
|
|
308 <A HREF="../../../../../org/apache/commons/math/linear/NotSymmetricMatrixException.html" title="class in org.apache.commons.math.linear">NotSymmetricMatrixException</A>,
|
|
|
309 <A HREF="../../../../../org/apache/commons/math/linear/NotPositiveDefiniteMatrixException.html" title="class in org.apache.commons.math.linear">NotPositiveDefiniteMatrixException</A></PRE>
|
|
|
310 <DL>
|
|
|
311 <DD>Calculates the Cholesky decomposition of the given matrix.
|
|
|
312 <P>
|
|
|
313 <DL>
|
|
|
314 <DT><B>Parameters:</B><DD><CODE>matrix</CODE> - the matrix to decompose<DD><CODE>relativeSymmetryThreshold</CODE> - threshold above which off-diagonal
|
|
|
315 elements are considered too different and matrix not symmetric<DD><CODE>absolutePositivityThreshold</CODE> - threshold below which diagonal
|
|
|
316 elements are considered null and matrix not positive definite
|
|
|
317 <DT><B>Throws:</B>
|
|
|
318 <DD><CODE><A HREF="../../../../../org/apache/commons/math/linear/NonSquareMatrixException.html" title="class in org.apache.commons.math.linear">NonSquareMatrixException</A></CODE> - if matrix is not square
|
|
|
319 <DD><CODE><A HREF="../../../../../org/apache/commons/math/linear/NotSymmetricMatrixException.html" title="class in org.apache.commons.math.linear">NotSymmetricMatrixException</A></CODE> - if matrix is not symmetric
|
|
|
320 <DD><CODE><A HREF="../../../../../org/apache/commons/math/linear/NotPositiveDefiniteMatrixException.html" title="class in org.apache.commons.math.linear">NotPositiveDefiniteMatrixException</A></CODE> - if the matrix is not
|
|
|
321 strictly positive definite<DT><B>See Also:</B><DD><A HREF="../../../../../org/apache/commons/math/linear/CholeskyDecompositionImpl.html#CholeskyDecompositionImpl(org.apache.commons.math.linear.RealMatrix)"><CODE>CholeskyDecompositionImpl(RealMatrix)</CODE></A>,
|
|
|
322 <A HREF="../../../../../org/apache/commons/math/linear/CholeskyDecompositionImpl.html#DEFAULT_RELATIVE_SYMMETRY_THRESHOLD"><CODE>DEFAULT_RELATIVE_SYMMETRY_THRESHOLD</CODE></A>,
|
|
|
323 <A HREF="../../../../../org/apache/commons/math/linear/CholeskyDecompositionImpl.html#DEFAULT_ABSOLUTE_POSITIVITY_THRESHOLD"><CODE>DEFAULT_ABSOLUTE_POSITIVITY_THRESHOLD</CODE></A></DL>
|
|
|
324 </DL>
|
|
|
325
|
|
|
326 <!-- ============ METHOD DETAIL ========== -->
|
|
|
327
|
|
|
328 <A NAME="method_detail"><!-- --></A>
|
|
|
329 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
|
|
330 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
|
|
|
331 <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
|
|
|
332 <B>Method Detail</B></FONT></TH>
|
|
|
333 </TR>
|
|
|
334 </TABLE>
|
|
|
335
|
|
|
336 <A NAME="getL()"><!-- --></A><H3>
|
|
|
337 getL</H3>
|
|
|
338 <PRE>
|
|
|
339 public <A HREF="../../../../../org/apache/commons/math/linear/RealMatrix.html" title="interface in org.apache.commons.math.linear">RealMatrix</A> <A HREF="../../../../../src-html/org/apache/commons/math/linear/CholeskyDecompositionImpl.html#line.154"><B>getL</B></A>()</PRE>
|
|
|
340 <DL>
|
|
|
341 <DD>Returns the matrix L of the decomposition.
|
|
|
342 <p>L is an lower-triangular matrix</p>
|
|
|
343 <P>
|
|
|
344 <DD><DL>
|
|
|
345 <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../org/apache/commons/math/linear/CholeskyDecomposition.html#getL()">getL</A></CODE> in interface <CODE><A HREF="../../../../../org/apache/commons/math/linear/CholeskyDecomposition.html" title="interface in org.apache.commons.math.linear">CholeskyDecomposition</A></CODE></DL>
|
|
|
346 </DD>
|
|
|
347 <DD><DL>
|
|
|
348
|
|
|
349 <DT><B>Returns:</B><DD>the L matrix</DL>
|
|
|
350 </DD>
|
|
|
351 </DL>
|
|
|
352 <HR>
|
|
|
353
|
|
|
354 <A NAME="getLT()"><!-- --></A><H3>
|
|
|
355 getLT</H3>
|
|
|
356 <PRE>
|
|
|
357 public <A HREF="../../../../../org/apache/commons/math/linear/RealMatrix.html" title="interface in org.apache.commons.math.linear">RealMatrix</A> <A HREF="../../../../../src-html/org/apache/commons/math/linear/CholeskyDecompositionImpl.html#line.162"><B>getLT</B></A>()</PRE>
|
|
|
358 <DL>
|
|
|
359 <DD>Returns the transpose of the matrix L of the decomposition.
|
|
|
360 <p>L<sup>T</sup> is an upper-triangular matrix</p>
|
|
|
361 <P>
|
|
|
362 <DD><DL>
|
|
|
363 <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../org/apache/commons/math/linear/CholeskyDecomposition.html#getLT()">getLT</A></CODE> in interface <CODE><A HREF="../../../../../org/apache/commons/math/linear/CholeskyDecomposition.html" title="interface in org.apache.commons.math.linear">CholeskyDecomposition</A></CODE></DL>
|
|
|
364 </DD>
|
|
|
365 <DD><DL>
|
|
|
366
|
|
|
367 <DT><B>Returns:</B><DD>the transpose of the matrix L of the decomposition</DL>
|
|
|
368 </DD>
|
|
|
369 </DL>
|
|
|
370 <HR>
|
|
|
371
|
|
|
372 <A NAME="getDeterminant()"><!-- --></A><H3>
|
|
|
373 getDeterminant</H3>
|
|
|
374 <PRE>
|
|
|
375 public double <A HREF="../../../../../src-html/org/apache/commons/math/linear/CholeskyDecompositionImpl.html#line.174"><B>getDeterminant</B></A>()</PRE>
|
|
|
376 <DL>
|
|
|
377 <DD>Return the determinant of the matrix
|
|
|
378 <P>
|
|
|
379 <DD><DL>
|
|
|
380 <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../org/apache/commons/math/linear/CholeskyDecomposition.html#getDeterminant()">getDeterminant</A></CODE> in interface <CODE><A HREF="../../../../../org/apache/commons/math/linear/CholeskyDecomposition.html" title="interface in org.apache.commons.math.linear">CholeskyDecomposition</A></CODE></DL>
|
|
|
381 </DD>
|
|
|
382 <DD><DL>
|
|
|
383
|
|
|
384 <DT><B>Returns:</B><DD>determinant of the matrix</DL>
|
|
|
385 </DD>
|
|
|
386 </DL>
|
|
|
387 <HR>
|
|
|
388
|
|
|
389 <A NAME="getSolver()"><!-- --></A><H3>
|
|
|
390 getSolver</H3>
|
|
|
391 <PRE>
|
|
|
392 public <A HREF="../../../../../org/apache/commons/math/linear/DecompositionSolver.html" title="interface in org.apache.commons.math.linear">DecompositionSolver</A> <A HREF="../../../../../src-html/org/apache/commons/math/linear/CholeskyDecompositionImpl.html#line.184"><B>getSolver</B></A>()</PRE>
|
|
|
393 <DL>
|
|
|
394 <DD>Get a solver for finding the A × X = B solution in least square sense.
|
|
|
395 <P>
|
|
|
396 <DD><DL>
|
|
|
397 <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../org/apache/commons/math/linear/CholeskyDecomposition.html#getSolver()">getSolver</A></CODE> in interface <CODE><A HREF="../../../../../org/apache/commons/math/linear/CholeskyDecomposition.html" title="interface in org.apache.commons.math.linear">CholeskyDecomposition</A></CODE></DL>
|
|
|
398 </DD>
|
|
|
399 <DD><DL>
|
|
|
400
|
|
|
401 <DT><B>Returns:</B><DD>a solver</DL>
|
|
|
402 </DD>
|
|
|
403 </DL>
|
|
|
404 <!-- ========= END OF CLASS DATA ========= -->
|
|
|
405 <HR>
|
|
|
406
|
|
|
407
|
|
|
408 <!-- ======= START OF BOTTOM NAVBAR ====== -->
|
|
|
409 <A NAME="navbar_bottom"><!-- --></A>
|
|
|
410 <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
|
|
|
411 <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
|
|
|
412 <TR>
|
|
|
413 <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
|
|
|
414 <A NAME="navbar_bottom_firstrow"><!-- --></A>
|
|
|
415 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
|
|
|
416 <TR ALIGN="center" VALIGN="top">
|
|
|
417 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
|
|
|
418 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
|
|
|
419 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
|
|
|
420 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/CholeskyDecompositionImpl.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD>
|
|
|
421 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
|
|
|
422 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
|
|
|
423 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
|
|
|
424 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
|
|
|
425 </TR>
|
|
|
426 </TABLE>
|
|
|
427 </TD>
|
|
|
428 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
|
|
|
429 </EM>
|
|
|
430 </TD>
|
|
|
431 </TR>
|
|
|
432
|
|
|
433 <TR>
|
|
|
434 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
|
|
435 <A HREF="../../../../../org/apache/commons/math/linear/CholeskyDecomposition.html" title="interface in org.apache.commons.math.linear"><B>PREV CLASS</B></A>
|
|
|
436 <A HREF="../../../../../org/apache/commons/math/linear/DecompositionSolver.html" title="interface in org.apache.commons.math.linear"><B>NEXT CLASS</B></A></FONT></TD>
|
|
|
437 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
|
|
438 <A HREF="../../../../../index.html?org/apache/commons/math/linear/CholeskyDecompositionImpl.html" target="_top"><B>FRAMES</B></A>
|
|
|
439 <A HREF="CholeskyDecompositionImpl.html" target="_top"><B>NO FRAMES</B></A>
|
|
|
440 <SCRIPT type="text/javascript">
|
|
|
441 <!--
|
|
|
442 if(window==top) {
|
|
|
443 document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
|
|
|
444 }
|
|
|
445 //-->
|
|
|
446 </SCRIPT>
|
|
|
447 <NOSCRIPT>
|
|
|
448 <A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
|
|
|
449 </NOSCRIPT>
|
|
|
450
|
|
|
451
|
|
|
452 </FONT></TD>
|
|
|
453 </TR>
|
|
|
454 <TR>
|
|
|
455 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
|
|
456 SUMMARY: NESTED | <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
|
|
|
457 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
|
|
458 DETAIL: <A HREF="#field_detail">FIELD</A> | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>
|
|
|
459 </TR>
|
|
|
460 </TABLE>
|
|
|
461 <A NAME="skip-navbar_bottom"></A>
|
|
|
462 <!-- ======== END OF BOTTOM NAVBAR ======= -->
|
|
|
463
|
|
|
464 <HR>
|
|
|
465 Copyright © 2003-2010 <a href="http://www.apache.org/">The Apache Software Foundation</a>. All Rights Reserved.
|
|
|
466 </BODY>
|
|
|
467 </HTML>
|
