Math.NET Numerics
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 

289 lines
12 KiB

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Frameset//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-frameset.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<title>GpBiCg - Math.NET Numerics Documentation</title>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8"/>
<link type="text/css" rel="stylesheet" href="../main.css"/>
<script type="text/javascript" src="../js/jquery-1.3.2.min.js"></script>
<script type="text/javascript" src="../js/jquery.scrollTo-min.js"></script>
<script type="text/javascript" src="../js/navigation.js"></script>
<script type="text/javascript" src="../js/example.js"></script>
</head>
<body><div id="namespaces">
<h2 class="fixed">Namespaces</h2>
<div class="scroll">
<ul>
<li>
<a href="../MathNet.Numerics/index.htm">MathNet.Numerics</a>
</li>
<li>
<a href="../MathNet.Numerics.Differentiation/index.htm">MathNet.Numerics.Differentiation</a>
</li>
<li>
<a href="../MathNet.Numerics.Distributions/index.htm">MathNet.Numerics.Distributions</a>
</li>
<li>
<a href="../MathNet.Numerics.Financial/index.htm">MathNet.Numerics.Financial</a>
</li>
<li>
<a href="../MathNet.Numerics.IntegralTransforms/index.htm">MathNet.Numerics.IntegralTransforms</a>
</li>
<li>
<a href="../MathNet.Numerics.Integration/index.htm">MathNet.Numerics.Integration</a>
</li>
<li>
<a href="../MathNet.Numerics.Interpolation/index.htm">MathNet.Numerics.Interpolation</a>
</li>
<li>
<a href="../MathNet.Numerics.LinearAlgebra/index.htm">MathNet.Numerics.LinearAlgebra</a>
</li>
<li>
<a href="../MathNet.Numerics.LinearAlgebra.Complex/index.htm">MathNet.Numerics.LinearAlgebra.Complex</a>
</li>
<li>
<a href="../MathNet.Numerics.LinearAlgebra.Complex.Solvers/index.htm" class="current">MathNet.Numerics.LinearAlgebra.Complex.Solvers</a>
</li>
<li>
<a href="../MathNet.Numerics.LinearAlgebra.Complex32/index.htm">MathNet.Numerics.LinearAlgebra.Complex32</a>
</li>
<li>
<a href="../MathNet.Numerics.LinearAlgebra.Complex32.Solvers/index.htm">MathNet.Numerics.LinearAlgebra.Complex32.Solvers</a>
</li>
<li>
<a href="../MathNet.Numerics.LinearAlgebra.Double/index.htm">MathNet.Numerics.LinearAlgebra.Double</a>
</li>
<li>
<a href="../MathNet.Numerics.LinearAlgebra.Double.Solvers/index.htm">MathNet.Numerics.LinearAlgebra.Double.Solvers</a>
</li>
<li>
<a href="../MathNet.Numerics.LinearAlgebra.Factorization/index.htm">MathNet.Numerics.LinearAlgebra.Factorization</a>
</li>
<li>
<a href="../MathNet.Numerics.LinearAlgebra.Single/index.htm">MathNet.Numerics.LinearAlgebra.Single</a>
</li>
<li>
<a href="../MathNet.Numerics.LinearAlgebra.Single.Solvers/index.htm">MathNet.Numerics.LinearAlgebra.Single.Solvers</a>
</li>
<li>
<a href="../MathNet.Numerics.LinearAlgebra.Solvers/index.htm">MathNet.Numerics.LinearAlgebra.Solvers</a>
</li>
<li>
<a href="../MathNet.Numerics.LinearAlgebra.Storage/index.htm">MathNet.Numerics.LinearAlgebra.Storage</a>
</li>
<li>
<a href="../MathNet.Numerics.LinearRegression/index.htm">MathNet.Numerics.LinearRegression</a>
</li>
<li>
<a href="../MathNet.Numerics.OdeSolvers/index.htm">MathNet.Numerics.OdeSolvers</a>
</li>
<li>
<a href="../MathNet.Numerics.Optimization/index.htm">MathNet.Numerics.Optimization</a>
</li>
<li>
<a href="../MathNet.Numerics.Optimization.LineSearch/index.htm">MathNet.Numerics.Optimization.LineSearch</a>
</li>
<li>
<a href="../MathNet.Numerics.Optimization.ObjectiveFunctions/index.htm">MathNet.Numerics.Optimization.ObjectiveFunctions</a>
</li>
<li>
<a href="../MathNet.Numerics.Optimization.TrustRegion/index.htm">MathNet.Numerics.Optimization.TrustRegion</a>
</li>
<li>
<a href="../MathNet.Numerics.Providers/index.htm">MathNet.Numerics.Providers</a>
</li>
<li>
<a href="../MathNet.Numerics.Providers.FourierTransform/index.htm">MathNet.Numerics.Providers.FourierTransform</a>
</li>
<li>
<a href="../MathNet.Numerics.Providers.LinearAlgebra/index.htm">MathNet.Numerics.Providers.LinearAlgebra</a>
</li>
<li>
<a href="../MathNet.Numerics.Providers.SparseSolver/index.htm">MathNet.Numerics.Providers.SparseSolver</a>
</li>
<li>
<a href="../MathNet.Numerics.Random/index.htm">MathNet.Numerics.Random</a>
</li>
<li>
<a href="../MathNet.Numerics.RootFinding/index.htm">MathNet.Numerics.RootFinding</a>
</li>
<li>
<a href="../MathNet.Numerics.Statistics/index.htm">MathNet.Numerics.Statistics</a>
</li>
<li>
<a href="../MathNet.Numerics.Statistics.Mcmc/index.htm">MathNet.Numerics.Statistics.Mcmc</a>
</li>
</ul>
</div>
</div><div id="types">
<h2 class="fixed">Types in MathNet.Numerics.LinearAlgebra.Complex.Solvers</h2>
<div class="scroll">
<ul>
<li>
<a href="../MathNet.Numerics.LinearAlgebra.Complex.Solvers/BiCgStab.htm">BiCgStab</a>
</li>
<li>
<a href="../MathNet.Numerics.LinearAlgebra.Complex.Solvers/CompositeSolver.htm">CompositeSolver</a>
</li>
<li>
<a href="../MathNet.Numerics.LinearAlgebra.Complex.Solvers/DiagonalPreconditioner.htm">DiagonalPreconditioner</a>
</li>
<li>
<a href="../MathNet.Numerics.LinearAlgebra.Complex.Solvers/GpBiCg.htm" class="current">GpBiCg</a>
</li>
<li>
<a href="../MathNet.Numerics.LinearAlgebra.Complex.Solvers/ILU0Preconditioner.htm">ILU0Preconditioner</a>
</li>
<li>
<a href="../MathNet.Numerics.LinearAlgebra.Complex.Solvers/ILUTPPreconditioner.htm">ILUTPPreconditioner</a>
</li>
<li>
<a href="../MathNet.Numerics.LinearAlgebra.Complex.Solvers/MILU0Preconditioner.htm">MILU0Preconditioner</a>
</li>
<li>
<a href="../MathNet.Numerics.LinearAlgebra.Complex.Solvers/MlkBiCgStab.htm">MlkBiCgStab</a>
</li>
<li>
<a href="../MathNet.Numerics.LinearAlgebra.Complex.Solvers/TFQMR.htm">TFQMR</a>
</li>
</ul>
</div>
</div>
<div class="header">
<p class="class"><strong>Type</strong> GpBiCg</p>
<p><strong>Namespace</strong> MathNet.Numerics.LinearAlgebra.Complex.Solvers</p>
<p><strong>Interfaces</strong> <a href="../MathNet.Numerics.LinearAlgebra.Solvers/IIterativeSolver`1.htm">IIterativeSolver&lt;T&gt;</a></p>
</div>
<div class="sub-header">
<div id="summary">A Generalized Product Bi-Conjugate Gradient iterative matrix solver. <blockquote class="remarks">
<p>The Generalized Product Bi-Conjugate Gradient (GPBiCG) solver is an
alternative version of the Bi-Conjugate Gradient stabilized (CG) solver.
Unlike the CG solver the GPBiCG solver can be used on
non-symmetric matrices. Note that much of the success of the solver depends on the selection of the
proper preconditioner. </p> <p>The GPBiCG algorithm was taken from: GPBiCG(m,l): A hybrid of BiCGSTAB and GPBiCG methods with
efficiency and robustness S. Fujino Applied Numerical Mathematics, Volume 41, 2002, pp 107 - 117 </p> <p>The example code below provides an indication of the possible use of the
solver. </p>
</blockquote>
</div>
<h3 class="section">Constructors</h3>
<ul>
<li><a href="../MathNet.Numerics.LinearAlgebra.Complex.Solvers/GpBiCg.htm#.ctor">GpBiCg</a></li>
</ul>
<h3 class="section">Methods</h3>
<ul>
<li><a href="../MathNet.Numerics.LinearAlgebra.Complex.Solvers/GpBiCg.htm#Equals">Equals</a></li>
<li><a href="../MathNet.Numerics.LinearAlgebra.Complex.Solvers/GpBiCg.htm#GetHashCode">GetHashCode</a></li>
<li><a href="../MathNet.Numerics.LinearAlgebra.Complex.Solvers/GpBiCg.htm#GetType">GetType</a></li>
<li><a href="../MathNet.Numerics.LinearAlgebra.Complex.Solvers/GpBiCg.htm#Solve">Solve</a></li>
<li><a href="../MathNet.Numerics.LinearAlgebra.Complex.Solvers/GpBiCg.htm#ToString">ToString</a></li>
</ul>
<h3 class="section">Properties</h3>
<ul>
<li><a href="../MathNet.Numerics.LinearAlgebra.Complex.Solvers/GpBiCg.htm#NumberOfBiCgStabSteps">NumberOfBiCgStabSteps</a></li>
<li><a href="../MathNet.Numerics.LinearAlgebra.Complex.Solvers/GpBiCg.htm#NumberOfGpBiCgSteps">NumberOfGpBiCgSteps</a></li>
</ul>
</div>
<h3 class="section">Public Constructors</h3>
<div id=".ctor" class="method">
<h4> <strong>GpBiCg</strong>()</h4>
<div class="content">
</div>
</div>
<h3 class="section">Public Methods</h3>
<div id="Equals" class="method">
<h4><span title="System.bool">bool</span> <strong>Equals</strong>(<span title="System.object">object</span> obj)</h4>
<div class="content">
</div>
</div>
<div id="GetHashCode" class="method">
<h4><span title="System.int">int</span> <strong>GetHashCode</strong>()</h4>
<div class="content">
</div>
</div>
<div id="GetType" class="method">
<h4><span title="System.Type">Type</span> <strong>GetType</strong>()</h4>
<div class="content">
</div>
</div>
<div id="Solve" class="method">
<h4><span title="System.void">void</span> <strong>Solve</strong>(<a href="../MathNet.Numerics.LinearAlgebra/Matrix`1.htm">Matrix&lt;T&gt;</a> matrix, <a href="../MathNet.Numerics.LinearAlgebra/Vector`1.htm">Vector&lt;T&gt;</a> input, <a href="../MathNet.Numerics.LinearAlgebra/Vector`1.htm">Vector&lt;T&gt;</a> result, <a href="../MathNet.Numerics.LinearAlgebra.Solvers/Iterator`1.htm">Iterator&lt;T&gt;</a> iterator, <a href="../MathNet.Numerics.LinearAlgebra.Solvers/IPreconditioner`1.htm">IPreconditioner&lt;T&gt;</a> preconditioner)</h4>
<div class="content">Solves the matrix equation Ax = b, where A is the coefficient matrix, b is the
solution vector and x is the unknown vector.
<div class="parameters">
<h5>Parameters</h5>
<h6><code><a href="../MathNet.Numerics.LinearAlgebra/Matrix`1.htm">Matrix&lt;T&gt;</a></code> matrix</h6>
<p class="comments">The coefficient matrix, <code>A</code>. </p>
<h6><code><a href="../MathNet.Numerics.LinearAlgebra/Vector`1.htm">Vector&lt;T&gt;</a></code> input</h6>
<p class="comments">The solution vector, <code>b</code> </p>
<h6><code><a href="../MathNet.Numerics.LinearAlgebra/Vector`1.htm">Vector&lt;T&gt;</a></code> result</h6>
<p class="comments">The result vector, <code>x</code> </p>
<h6><code><a href="../MathNet.Numerics.LinearAlgebra.Solvers/Iterator`1.htm">Iterator&lt;T&gt;</a></code> iterator</h6>
<p class="comments">The iterator to use to control when to stop iterating. </p>
<h6><code><a href="../MathNet.Numerics.LinearAlgebra.Solvers/IPreconditioner`1.htm">IPreconditioner&lt;T&gt;</a></code> preconditioner</h6>
<p class="comments">The preconditioner to use for approximations. </p>
</div>
</div>
</div>
<div id="ToString" class="method">
<h4><span title="System.string">string</span> <strong>ToString</strong>()</h4>
<div class="content">
</div>
</div>
<h3 class="section">Public Properties</h3>
<div id="NumberOfBiCgStabSteps" class="method">
<h4><span title="System.int">int</span> <strong>NumberOfBiCgStabSteps</strong> get; set;</h4>
<div class="content">Gets or sets the number of steps taken with the <code>BiCgStab</code> algorithm
before switching over to the <code>GPBiCG</code> algorithm.
</div>
</div>
<div id="NumberOfGpBiCgSteps" class="method">
<h4><span title="System.int">int</span> <strong>NumberOfGpBiCgSteps</strong> get; set;</h4>
<div class="content">Gets or sets the number of steps taken with the <code>GPBiCG</code> algorithm
before switching over to the <code>BiCgStab</code> algorithm.
</div>
</div>
<div id="footer">
<p>Based on v5.0.0.0 of MathNet.Numerics (Math.NET Numerics)</p>
<p>Generated by <a href="http://docu.jagregory.com">docu</a></p>
</div>
</body>
</html>