d82069a20de91d0318a187ba84ffa5b6408c202e
[scilab.git] / scilab / modules / sparse / help / ja_JP / sparseconvert / sparse.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="sparse">
14     <refnamediv>
15         <refname>sparse</refname>
16         <refpurpose>疎行列を定義</refpurpose>
17     </refnamediv>
18     <refsynopsisdiv>
19         <title>呼び出し手順</title>
20         <synopsis>sp=sparse(X)
21             sp=sparse(ij,v [,mn])
22         </synopsis>
23     </refsynopsisdiv>
24     <refsection>
25         <title>パラメータ</title>
26         <variablelist>
27             <varlistentry>
28                 <term>X</term>
29                 <listitem>
30                     <para>実数または複素数の通常の(または疎)行列</para>
31                 </listitem>
32             </varlistentry>
33             <varlistentry>
34                 <term>ij</term>
35                 <listitem>
36                     <para>2列の整数行列 (非ゼロエントリのインデックス)</para>
37                 </listitem>
38             </varlistentry>
39             <varlistentry>
40                 <term>v</term>
41                 <listitem>
42                     <para>ベクトル</para>
43                 </listitem>
44             </varlistentry>
45             <varlistentry>
46                 <term>mn</term>
47                 <listitem>
48                     <para>2つのエントリ(行の次元, 列の次元c)を有する整数ベクトル</para>
49                 </listitem>
50             </varlistentry>
51             <varlistentry>
52                 <term>sp</term>
53                 <listitem>
54                     <para>疎行列</para>
55                 </listitem>
56             </varlistentry>
57         </variablelist>
58     </refsection>
59     <refsection>
60         <title>説明</title>
61         <para>
62             <literal>sparse</literal>は疎行列を作成するために使用されます.
63             ゼロでないエントリのみが保存されます.
64         </para>
65         <para>
66             <literal>sp = sparse(X)</literal>  は,
67             0要素を除外することにより,通常の行列を疎行列に変換します.
68             (<literal>X</literal>が既に疎行列の場合,
69             <literal>sp</literal>は<literal>X</literal>となります).
70         </para>
71         <para>
72             <literal>sp=sparse(ij,v [,mn])</literal>は,
73             <literal>sp(ij(k,1),ij(k,2))=v(k)</literal>となる
74             <literal>mn(1)</literal>行<literal>mn(2)</literal>列の疎行列
75             を作成します.
76             <literal>ij</literal> および <literal>v</literal>は列の次元が
77             同じである必要があります.
78             オプションの<literal>mn</literal>パラメータが指定されない場合,
79             行列<literal>sp</literal>の次元は,それぞれ
80             <literal>ij(:,1)</literal> および <literal>ij(:,2)</literal>の
81             最大値となります.
82         </para>
83         <para>
84             疎行列に関する操作(結合,加算,等,)は通常の行列と同じ構文により
85             行ないます.
86         </para>
87         <para>
88             基本的な関数(<literal>abs,maxi,sum,diag,...</literal>)は疎行列でも
89             利用可能です.
90         </para>
91         <para>
92             (通常の行列と疎行列の)混用も可能です.
93             結果は処理に応じて通常または疎行列となります.
94         </para>
95     </refsection>
96     <refsection>
97         <title>例</title>
98         <programlisting role="example"><![CDATA[ 
99 sp=sparse([1,2;4,5;3,10],[1,2,3])
100 size(sp)
101 x=rand(2,2);abs(x)-full(abs(sparse(x)))
102  ]]></programlisting>
103     </refsection>
104     <refsection role="see also">
105         <title>参照</title>
106         <simplelist type="inline">
107             <member>
108                 <link linkend="full">full</link>
109             </member>
110             <member>
111                 <link linkend="spget">spget</link>
112             </member>
113             <member>
114                 <link linkend="sprand">sprand</link>
115             </member>
116             <member>
117                 <link linkend="speye">speye</link>
118             </member>
119             <member>
120                 <link linkend="lufact">lufact</link>
121             </member>
122         </simplelist>
123     </refsection>
124 </refentry>