ea30c979d3d824981172784ed7e5c6ff515b6105
[scilab.git] / scilab / modules / core / help / en_US / testmatrix.xml
1 <?xml version="1.0" encoding="UTF-8"?>
2 <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="en" xml:id="testmatrix">
3     <refnamediv>
4         <refname>testmatrix</refname>
5         <refpurpose>generate special matrices, such as Hilbert, Franck</refpurpose>
6     </refnamediv>
7     <refsynopsisdiv>
8         <title>Calling Sequence</title>
9         <synopsis>[y] = testmatrix(name, n)</synopsis>
10     </refsynopsisdiv>
11     <refsection>
12         <title>Arguments</title>
13         <variablelist>
14             <varlistentry>
15                 <term>name</term>
16                 <listitem>
17                     <para>a character string</para>
18                 </listitem>
19             </varlistentry>
20             <varlistentry>
21                 <term>n</term>
22                 <listitem>
23                     <para>integers, matrix size</para>
24                 </listitem>
25             </varlistentry>
26             <varlistentry>
27                 <term>y</term>
28                 <listitem>
29                     <para>
30                         <varname>n</varname> x <varname>n</varname> matrix
31                     </para>
32                 </listitem>
33             </varlistentry>
34         </variablelist>
35     </refsection>
36     <refsection>
37         <title>Description</title>
38         <para>
39             Creates some particular matrices.
40         </para>
41         <variablelist>
42             <varlistentry>
43                 <term>testmatrix('magi',n)</term>
44                 <listitem>
45                     <para>
46                         returns a magic square of size <varname>n</varname> x <varname>n</varname>.
47                     </para>
48                 </listitem>
49             </varlistentry>
50             <varlistentry>
51                 <term>testmatrix('frk',n)</term>
52                 <listitem>
53                     <para>returns the Franck matrix.</para>
54                 </listitem>
55             </varlistentry>
56             <varlistentry>
57                 <term>testmatrix('hilb',n)</term>
58                 <listitem>
59                     <para>
60                         is the inverse of the <varname>n</varname> x <varname>n</varname> Hilbert matrix  <literal>(Hij= 1/(i+j-1))</literal>.
61                     </para>
62                 </listitem>
63             </varlistentry>
64         </variablelist>
65     </refsection>
66     <refsection>
67         <title>Examples</title>
68         <programlisting role="example"><![CDATA[ 
69 testmatrix('magi',3)
70 testmatrix('frk',10)
71 testmatrix('hilb',4)
72  ]]></programlisting>
73     </refsection>
74     
75 </refentry>