scilab/modules/sparse/help/ja_JP/matrixmanip/speye.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) 2008 - INRIA
   5  *
   6  * Copyright (C) 2012 - 2016 - Scilab Enterprises
   7  *
   8  * This file is hereby licensed under the terms of the GNU GPL v2.0,
   9  * pursuant to article 5.3.4 of the CeCILL v.2.1.
  10  * This file was originally licensed under the terms of the CeCILL v2.1,
  11  * and continues to be available under such terms.
  12  * For more information, see the COPYING file which you should have received
  13  * along with this program.
  14  *
  15  -->
  16 <refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"
  17         xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns5="http://www.w3.org/1999/xhtml"
  18         xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook"
  19         xmlns:scilab="http://www.scilab.org" xml:id="speye" xml:lang="ja">
  20     <refnamediv>
  21         <refname>speye</refname>
  22         <refpurpose>疎単位行列</refpurpose>
  23     </refnamediv>
  24     <refsynopsisdiv>
  25         <title>呼び出し手順</title>
  26         <synopsis>
  27             Isp = speye(A)
  28             Isp = speye(nrows, ncols)
  29         </synopsis>
  30     </refsynopsisdiv>
  31     <refsection>
  32         <title>引数</title>
  33         <variablelist>
  34             <varlistentry>
  35                 <term>nrows</term>
  36                 <listitem>
  37                     <para>整数 (行数)</para>
  38                 </listitem>
  39             </varlistentry>
  40             <varlistentry>
  41                 <term>ncols</term>
  42                 <listitem>
  43                     <para>整数 (列数)</para>
  44                 </listitem>
  45             </varlistentry>
  46             <varlistentry>
  47                 <term>A</term>
  48                 <listitem>
  49                     <para>疎行列</para>
  50                 </listitem>
  51             </varlistentry>
  52             <varlistentry>
  53                 <term>sp</term>
  54                 <listitem>
  55                     <para>疎単位行列</para>
  56                 </listitem>
  57             </varlistentry>
  58         </variablelist>
  59     </refsection>
  60     <refsection>
  61         <title>説明</title>
  62         <para>
  63             <literal>Isp=speye(nrows,ncols)</literal> は,
  64             <literal>nrows</literal> 行,
  65             <literal>ncols</literal> 列の
  66             疎単位行列<literal>Isp</literal>を返します.
  67             (非正方行列は主対角項に1を有します).
  68         </para>
  69         <para>
  70             <literal>Isp=speye(A)</literal>は<literal>A</literal>と
  71             同じ次元の疎単位行列を返します.
  72             <literal>[m,n]=size(A)</literal>の場合, <literal>speye(m,n)</literal> および
  73             <literal>speye(A)</literal>は等価です.
  74             <warning>
  75                 なお, <literal>speye(3)</literal> は <literal>speye(3,3)</literal>と等価ではありません.
  76             </warning>
  77         </para>
  78     </refsection>
  79     <refsection>
  80         <title>例</title>
  81         <programlisting role="example"><![CDATA[
  82 eye(3,3) - full(speye(3,3))
  83  ]]></programlisting>
  84     </refsection>
  85     <refsection role="see also">
  86         <title>参照</title>
  87         <simplelist type="inline">
  88             <member>
  89                 <link linkend="sparse">sparse</link>
  90             </member>
  91             <member>
  92                 <link linkend="full">full</link>
  93             </member>
  94             <member>
  95                 <link linkend="eye">eye</link>
  96             </member>
  97             <member>
  98                 <link linkend="diag">diag</link>
  99             </member>
 100             <member>
 101                 <link linkend="toeplitz">toeplitz</link>
 102             </member>
 103             <member>
 104                 <link linkend="spzeros">spzeros</link>
 105             </member>
 106             <member>
 107                 <link linkend="spones">spones</link>
 108             </member>
 109         </simplelist>
 110     </refsection>
 111 </refentry>