aab134b9a0f6141d647b361e119cecda2d12b3d4
[scilab.git] / scilab / modules / sparse / help / ja_JP / iterativesolvers / qmr.xml
1 <?xml version="1.0" encoding="UTF-8"?>
2 <!--
3  * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
4  * Copyright (C) XXXX-2008 - INRIA
5  * 
6  * This file must be used under the terms of the CeCILL.
7  * This source file is licensed as described in the file COPYING, which
8  * you should have received as part of this distribution.  The terms
9  * are also available at    
10  * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt
11  *
12  -->
13 <refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:lang="ja" xml:id="qmr">
14     <refnamediv>
15         <refname>qmr</refname>
16         <refpurpose>プリコンディショナ付きのQuasi Minimal Residual法</refpurpose>
17     </refnamediv>
18     <refsynopsisdiv>
19         <title>呼び出し手順</title>
20         <synopsis>[x,flag,err,iter,res] = qmr(A,b,x0,M1,M1p,M2,M2p,maxi,tol)</synopsis>
21     </refsynopsisdiv>
22     <refsection>
23         <title>Parameters</title>
24         <variablelist>
25             <varlistentry>
26                 <term>A</term>
27                 <listitem>
28                     <para>
29                         大きさn行n列の行列または<literal>A*x</literal>を返す関数
30                     </para>
31                 </listitem>
32             </varlistentry>
33             <varlistentry>
34                 <term>b</term>
35                 <listitem>
36                     <para>右辺ベクトル</para>
37                 </listitem>
38             </varlistentry>
39             <varlistentry>
40                 <term>x0</term>
41                 <listitem>
42                     <para>初期推定ベクトル (デフォルト: zeros(n,1))</para>
43                 </listitem>
44             </varlistentry>
45             <varlistentry>
46                 <term>M1</term>
47                 <listitem>
48                     <para>
49                         左プリコンディショナ: 行列または<literal>M1*x</literal>を返す関数
50                         (前者のデフォルト値: eye(n,n))
51                     </para>
52                 </listitem>
53             </varlistentry>
54             <varlistentry>
55                 <term>M1p</term>
56                 <listitem>
57                     <para>
58                         <literal>M1</literal>が関数の場合のみ指定する
59                         必要があります. この場合, <literal>M1p</literal> は
60                         <literal>M1'*x</literal>を返す関数です.
61                     </para>
62                 </listitem>
63             </varlistentry>
64             <varlistentry>
65                 <term>M2</term>
66                 <listitem>
67                     <para>
68                         右プリコンディショナ: 行列または<literal>M2*x</literal>を
69                         返す関数 (前者のデフォルト値: eye(n,n))
70                     </para>
71                 </listitem>
72             </varlistentry>
73             <varlistentry>
74                 <term>M2p</term>
75                 <listitem>
76                     <para>
77                         <literal>M2</literal>が関数の場合のみ指定する
78                         必要があります. この場合, 
79                         <literal>M2p</literal>は<literal>M2'*x</literal>を返す関数です.
80                     </para>
81                 </listitem>
82             </varlistentry>
83             <varlistentry>
84                 <term>maxi</term>
85                 <listitem>
86                     <para>最大反復回数 (デフォルト: n)
87                     </para>
88                 </listitem>
89             </varlistentry>
90             <varlistentry>
91                 <term>tol</term>
92                 <listitem>
93                     <para>許容誤差 (デフォルト: 1000*%eps)</para>
94                 </listitem>
95             </varlistentry>
96             <varlistentry>
97                 <term>x</term>
98                 <listitem>
99                     <para>解ベクトル</para>
100                 </listitem>
101             </varlistentry>
102             <varlistentry>
103                 <term>flag</term>
104                 <listitem>
105                     <variablelist>
106                         <varlistentry>
107                             <term>0 =</term>
108                             <listitem>
109                                 <para>
110                                     <literal>gmres</literal> は
111                                     <literal>maxi</literal>回の反復の間に
112                                     許容誤差内に収束しました
113                                 </para>
114                             </listitem>
115                         </varlistentry>
116                         <varlistentry>
117                             <term>1 =</term>
118                             <listitem>
119                                 <para>
120                                     指定した<literal>maxi</literal>回の反復の間に
121                                     収束しませんでした
122                                 </para>
123                             </listitem>
124                         </varlistentry>
125                     </variablelist>
126                 </listitem>
127             </varlistentry>
128             <varlistentry>
129                 <term>res</term>
130                 <listitem>
131                     <para>残差ベクトル</para>
132                 </listitem>
133             </varlistentry>
134             <varlistentry>
135                 <term>err</term>
136                 <listitem>
137                     <para>最終残差ノルム</para>
138                 </listitem>
139             </varlistentry>
140             <varlistentry>
141                 <term>iter</term>
142                 <listitem>
143                     <para>実行した反復回数</para>
144                 </listitem>
145             </varlistentry>
146         </variablelist>
147     </refsection>
148     <refsection>
149         <title>説明</title>
150         <para>
151             プリコンディショナ付きのQuasi Minimal Residual法により,
152             線形システム<literal>Ax=b</literal>を解きます. 
153         </para>
154     </refsection>
155     <refsection role="see also">
156         <title>参照</title>
157         <simplelist type="inline">
158             <member>
159                 <link linkend="gmres">gmres</link>
160             </member>
161         </simplelist>
162     </refsection>
163 </refentry>