382 lines
19 KiB
HTML
382 lines
19 KiB
HTML
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
|
|
<!-- NewPage -->
|
|
<html lang="en">
|
|
<head>
|
|
<!-- Generated by javadoc (version 1.7.0_51) on Wed Apr 06 13:11:04 EDT 2016 -->
|
|
<title>Tridiagonal (Parallel Java 2 Library Documentation)</title>
|
|
<meta name="date" content="2016-04-06">
|
|
<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="Tridiagonal (Parallel Java 2 Library Documentation)";
|
|
}
|
|
//-->
|
|
</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/Tridiagonal.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-files/index-1.html">Index</a></li>
|
|
<li><a href="../../../help-doc.html">Help</a></li>
|
|
</ul>
|
|
</div>
|
|
<div class="subNav">
|
|
<ul class="navList">
|
|
<li><a href="../../../edu/rit/numeric/TransformedXYZSeries.html" title="class in edu.rit.numeric"><span class="strong">Prev Class</span></a></li>
|
|
<li><a href="../../../edu/rit/numeric/UniformPrng.html" title="class in edu.rit.numeric"><span class="strong">Next Class</span></a></li>
|
|
</ul>
|
|
<ul class="navList">
|
|
<li><a href="../../../index.html?edu/rit/numeric/Tridiagonal.html" target="_top">Frames</a></li>
|
|
<li><a href="Tridiagonal.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">edu.rit.numeric</div>
|
|
<h2 title="Class Tridiagonal" class="title">Class Tridiagonal</h2>
|
|
</div>
|
|
<div class="contentContainer">
|
|
<ul class="inheritance">
|
|
<li><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li>
|
|
<li>
|
|
<ul class="inheritance">
|
|
<li>edu.rit.numeric.Tridiagonal</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
<div class="description">
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<hr>
|
|
<br>
|
|
<pre>public class <span class="strong">Tridiagonal</span>
|
|
extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></pre>
|
|
<div class="block">Class Tridiagonal provides static methods for solving tridiagonal systems of
|
|
linear equations.
|
|
<P>
|
|
The Java code was translated from routines
|
|
<TT>gsl_linalg_solve_tridiag()</TT>,
|
|
<TT>gsl_linalg_solve_symm_tridiag()</TT>,
|
|
<TT>gsl_linalg_solve_cyc_tridiag()</TT>, and
|
|
<TT>gsl_linalg_solve_symm_cyc_tridiag()</TT>
|
|
in the GNU Scientific Library Version 1.9.</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>static void</code></td>
|
|
<td class="colLast"><code><strong><a href="../../../edu/rit/numeric/Tridiagonal.html#solve(double[], double[], double[], double[], double[])">solve</a></strong>(double[] d,
|
|
double[] e,
|
|
double[] f,
|
|
double[] b,
|
|
double[] x)</code>
|
|
<div class="block">Solve the given tridiagonal system of linear equations.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="rowColor">
|
|
<td class="colFirst"><code>static void</code></td>
|
|
<td class="colLast"><code><strong><a href="../../../edu/rit/numeric/Tridiagonal.html#solveCyclic(double[], double[], double[], double[], double[])">solveCyclic</a></strong>(double[] d,
|
|
double[] e,
|
|
double[] f,
|
|
double[] b,
|
|
double[] x)</code>
|
|
<div class="block">Solve the given cyclic tridiagonal system of linear equations.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="altColor">
|
|
<td class="colFirst"><code>static void</code></td>
|
|
<td class="colLast"><code><strong><a href="../../../edu/rit/numeric/Tridiagonal.html#solveSymmetric(double[], double[], double[], double[])">solveSymmetric</a></strong>(double[] d,
|
|
double[] e,
|
|
double[] b,
|
|
double[] x)</code>
|
|
<div class="block">Solve the given symmetric tridiagonal system of linear equations.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="rowColor">
|
|
<td class="colFirst"><code>static void</code></td>
|
|
<td class="colLast"><code><strong><a href="../../../edu/rit/numeric/Tridiagonal.html#solveSymmetricCyclic(double[], double[], double[], double[])">solveSymmetricCyclic</a></strong>(double[] d,
|
|
double[] e,
|
|
double[] b,
|
|
double[] x)</code>
|
|
<div class="block">Solve the given symmetric cyclic tridiagonal system of linear equations.</div>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<ul class="blockList">
|
|
<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object">
|
|
<!-- -->
|
|
</a>
|
|
<h3>Methods inherited from class java.lang.<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3>
|
|
<code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang">clone</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang">equals</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang">finalize</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang">toString</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait(long, int)" title="class or interface in java.lang">wait</a></code></li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
<div class="details">
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<!-- ============ METHOD DETAIL ========== -->
|
|
<ul class="blockList">
|
|
<li class="blockList"><a name="method_detail">
|
|
<!-- -->
|
|
</a>
|
|
<h3>Method Detail</h3>
|
|
<a name="solve(double[], double[], double[], double[], double[])">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>solve</h4>
|
|
<pre>public static void solve(double[] d,
|
|
double[] e,
|
|
double[] f,
|
|
double[] b,
|
|
double[] x)</pre>
|
|
<div class="block">Solve the given tridiagonal system of linear equations. This method
|
|
solves the general <I>N</I>-by-<I>N</I> system <I>Ax</I> = <I>b</I> where
|
|
<I>A</I> is tridiagonal (<I>N</I> >= 2). The form of <I>A</I> for the
|
|
4-by-4 case is:
|
|
<PRE>
|
|
[ d0 e0 0 0 ]
|
|
A = [ f0 d1 e1 0 ]
|
|
[ 0 f1 d2 e2 ]
|
|
[ 0 0 f2 d3 ]
|
|
</PRE></div>
|
|
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>d</code> - (input) Vector of diagonal elements. Length <I>N</I> must be
|
|
>= 2.</dd><dd><code>e</code> - (input) Vector of super-diagonal elements. Length must be
|
|
<I>N</I>-1.</dd><dd><code>f</code> - (input) Vector of sub-diagonal elements. Length must be
|
|
<I>N</I>-1.</dd><dd><code>b</code> - (input) Vector of right hand side elements. Length must be
|
|
<I>N</I>.</dd><dd><code>x</code> - (output) Solution vector. Length must be <I>N</I>.</dd>
|
|
<dt><span class="strong">Throws:</span></dt>
|
|
<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/NullPointerException.html?is-external=true" title="class or interface in java.lang">NullPointerException</a></code> - (unchecked exception) Thrown if any argument is null.</dd>
|
|
<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</a></code> - (unchecked exception) Thrown if any argument is the wrong length.</dd>
|
|
<dd><code><a href="../../../edu/rit/numeric/DomainException.html" title="class in edu.rit.numeric">DomainException</a></code> - (unchecked exception) Thrown if the linear system cannot be solved.</dd></dl>
|
|
</li>
|
|
</ul>
|
|
<a name="solveSymmetric(double[], double[], double[], double[])">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>solveSymmetric</h4>
|
|
<pre>public static void solveSymmetric(double[] d,
|
|
double[] e,
|
|
double[] b,
|
|
double[] x)</pre>
|
|
<div class="block">Solve the given symmetric tridiagonal system of linear equations. This
|
|
method solves the general <I>N</I>-by-<I>N</I> system <I>Ax</I> =
|
|
<I>b</I> where <I>A</I> is symmetric tridiagonal (<I>N</I> >= 2). The
|
|
form of <I>A</I> for the 4-by-4 case is:
|
|
<PRE>
|
|
[ d0 e0 0 0 ]
|
|
A = [ e0 d1 e1 0 ]
|
|
[ 0 e1 d2 e2 ]
|
|
[ 0 0 e2 d3 ]
|
|
</PRE></div>
|
|
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>d</code> - (input) Vector of diagonal elements. Length <I>N</I> must be
|
|
>= 2.</dd><dd><code>e</code> - (input) Vector of off-diagonal elements. Length must be
|
|
<I>N</I>-1.</dd><dd><code>b</code> - (input) Vector of right hand side elements. Length must be
|
|
<I>N</I>.</dd><dd><code>x</code> - (output) Solution vector. Length must be <I>N</I>.</dd>
|
|
<dt><span class="strong">Throws:</span></dt>
|
|
<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/NullPointerException.html?is-external=true" title="class or interface in java.lang">NullPointerException</a></code> - (unchecked exception) Thrown if any argument is null.</dd>
|
|
<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</a></code> - (unchecked exception) Thrown if any argument is the wrong length.</dd>
|
|
<dd><code><a href="../../../edu/rit/numeric/DomainException.html" title="class in edu.rit.numeric">DomainException</a></code> - (unchecked exception) Thrown if the linear system cannot be solved.</dd></dl>
|
|
</li>
|
|
</ul>
|
|
<a name="solveCyclic(double[], double[], double[], double[], double[])">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>solveCyclic</h4>
|
|
<pre>public static void solveCyclic(double[] d,
|
|
double[] e,
|
|
double[] f,
|
|
double[] b,
|
|
double[] x)</pre>
|
|
<div class="block">Solve the given cyclic tridiagonal system of linear equations. This
|
|
method solves the general <I>N</I>-by-<I>N</I> system <I>Ax</I> =
|
|
<I>b</I> where <I>A</I> is cyclic tridiagonal (<I>N</I> >= 3). The
|
|
form of <I>A</I> for the 4-by-4 case is:
|
|
<PRE>
|
|
[ d0 e0 0 f3 ]
|
|
A = [ f0 d1 e1 0 ]
|
|
[ 0 f1 d2 e2 ]
|
|
[ e3 0 f2 d3 ]
|
|
</PRE></div>
|
|
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>d</code> - (input) Vector of diagonal elements. Length <I>N</I> must be
|
|
>= 3.</dd><dd><code>e</code> - (input) Vector of super-diagonal elements. Length must be
|
|
<I>N</I>.</dd><dd><code>f</code> - (input) Vector of sub-diagonal elements. Length must be
|
|
<I>N</I>.</dd><dd><code>b</code> - (input) Vector of right hand side elements. Length must be
|
|
<I>N</I>.</dd><dd><code>x</code> - (output) Solution vector. Length must be <I>N</I>.</dd>
|
|
<dt><span class="strong">Throws:</span></dt>
|
|
<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/NullPointerException.html?is-external=true" title="class or interface in java.lang">NullPointerException</a></code> - (unchecked exception) Thrown if any argument is null.</dd>
|
|
<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</a></code> - (unchecked exception) Thrown if any argument is the wrong length.</dd>
|
|
<dd><code><a href="../../../edu/rit/numeric/DomainException.html" title="class in edu.rit.numeric">DomainException</a></code> - (unchecked exception) Thrown if the linear system cannot be solved.</dd></dl>
|
|
</li>
|
|
</ul>
|
|
<a name="solveSymmetricCyclic(double[], double[], double[], double[])">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockListLast">
|
|
<li class="blockList">
|
|
<h4>solveSymmetricCyclic</h4>
|
|
<pre>public static void solveSymmetricCyclic(double[] d,
|
|
double[] e,
|
|
double[] b,
|
|
double[] x)</pre>
|
|
<div class="block">Solve the given symmetric cyclic tridiagonal system of linear equations.
|
|
This method solves the general <I>N</I>-by-<I>N</I> system <I>Ax</I> =
|
|
<I>b</I> where <I>A</I> is symmetric cyclic tridiagonal (<I>N</I> >=
|
|
3). The form of <I>A</I> for the 4-by-4 case is:
|
|
<PRE>
|
|
[ d0 e0 0 e3 ]
|
|
A = [ e0 d1 e1 0 ]
|
|
[ 0 e1 d2 e2 ]
|
|
[ e3 0 e2 d3 ]
|
|
</PRE></div>
|
|
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>d</code> - (input) Vector of diagonal elements. Length <I>N</I> must be
|
|
>= 3.</dd><dd><code>e</code> - (input) Vector of off-diagonal elements. Length must be
|
|
<I>N</I>.</dd><dd><code>b</code> - (input) Vector of right hand side elements. Length must be
|
|
<I>N</I>.</dd><dd><code>x</code> - (output) Solution vector. Length must be <I>N</I>.</dd>
|
|
<dt><span class="strong">Throws:</span></dt>
|
|
<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/NullPointerException.html?is-external=true" title="class or interface in java.lang">NullPointerException</a></code> - (unchecked exception) Thrown if any argument is null.</dd>
|
|
<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</a></code> - (unchecked exception) Thrown if any argument is the wrong length.</dd>
|
|
<dd><code><a href="../../../edu/rit/numeric/DomainException.html" title="class in edu.rit.numeric">DomainException</a></code> - (unchecked exception) Thrown if the linear system cannot be solved.</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/Tridiagonal.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-files/index-1.html">Index</a></li>
|
|
<li><a href="../../../help-doc.html">Help</a></li>
|
|
</ul>
|
|
</div>
|
|
<div class="subNav">
|
|
<ul class="navList">
|
|
<li><a href="../../../edu/rit/numeric/TransformedXYZSeries.html" title="class in edu.rit.numeric"><span class="strong">Prev Class</span></a></li>
|
|
<li><a href="../../../edu/rit/numeric/UniformPrng.html" title="class in edu.rit.numeric"><span class="strong">Next Class</span></a></li>
|
|
</ul>
|
|
<ul class="navList">
|
|
<li><a href="../../../index.html?edu/rit/numeric/Tridiagonal.html" target="_top">Frames</a></li>
|
|
<li><a href="Tridiagonal.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><FONT SIZE="-2">Copyright © 2013–2016 by Alan Kaminsky. All rights reserved. Send comments to ark</FONT><FONT SIZE="1" COLOR="#FFFFFF">­</FONT><FONT SIZE="-2">@</FONT><FONT SIZE="1" COLOR="#FFFFFF">­</FONT><FONT SIZE="-2">cs.rit.edu.</FONT></small></p>
|
|
</body>
|
|
</html>
|