← Back to branch summary

~ubuntu-branches/ubuntu/raring/scilab/raring-proposed

« back to all changes in this revision

Viewing changes to modules/m2sci/help/fr_FR/mfile2sci.xml

  • Committer: Package Import Robot
  • Author(s): Sylvestre Ledru
  • Date: 2012-08-30 14:42:38 UTC
  • mfrom: (1.4.7)
  • Revision ID: package-import@ubuntu.com-20120830144238-c1y2og7dbm7m9nig
Tags: 5.4.0-beta-3-1~exp1
* New upstream release
* Update the scirenderer dep
* Get ride of libjhdf5-java dependency

Show diffs side-by-side

added added

removed removed

Lines of Context:
modules/m2sci/help/fr_FR/mfile2sci.xml
12
12
    *
13
13
    -->
14
14
<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" version="5.0-subset Scilab" xml:lang="fr" xml:id="mfile2sci">
15
 
  <refnamediv>
16
 
    <refname>mfile2sci</refname>
17
 
    <refpurpose> Fonction de conversion de M-file Matlab vers Scilab</refpurpose>
18
 
  </refnamediv>
19
 
  <refsynopsisdiv>
20
 
    <title>Séquence d'appel</title>
21
 
    <synopsis>mfile2sci(M-file-path [,result-path [,Recmode [,only-double [,verbose-mode [,prettyprintoutput]]]]])</synopsis>
22
 
  </refsynopsisdiv>
23
 
  <refsection>
24
 
    <title>Paramètres</title>
25
 
    <variablelist>
26
 
      <varlistentry>
27
 
        <term>M-file-path</term>
28
 
        <listitem>
29
 
          <para>une chaîne de caractères qui donne le chemin du M-file à traduire</para>
30
 
        </listitem>
31
 
      </varlistentry>
32
 
      <varlistentry>
33
 
        <term>result-path</term>
34
 
        <listitem>
35
 
          <para>une chaîne de caractères qui donne le répertoire où le résultat sera écrit. La valeur par défault est le répertoire courant.</para>
36
 
        </listitem>
37
 
      </varlistentry>
38
 
      <varlistentry>
39
 
        <term>Recmode</term>
40
 
        <listitem>
41
 
          <para>Flag booléen, utilisé par translatepaths pour une conversion récursive. Doit être %F pour convertir un seul M-file. Valeur par défaut : %F</para>
42
 
        </listitem>
43
 
      </varlistentry>
44
 
      <varlistentry>
45
 
        <term>only-double</term>
46
 
        <listitem>
47
 
          <para>Flag booléen, si il vaut %T mfile2sci considère que les fonctions de calcul numériques ont été utilisées uniquement avec des données numériques (Aucune fonction de surcharge Scilab est requise). Valeur par défaut : %T</para>
48
 
        </listitem>
49
 
      </varlistentry>
50
 
      <varlistentry>
51
 
        <term>verbose-mode</term>
52
 
        <listitem>
53
 
          <para>mode d'affichage des information de conversion</para>
54
 
          <variablelist>
55
 
            <varlistentry>
56
 
              <term>0</term>
57
 
              <listitem>
58
 
                <para>aucune information donnée</para>
59
 
              </listitem>
60
 
            </varlistentry>
61
 
            <varlistentry>
62
 
              <term>1</term>
63
 
              <listitem>
64
 
                <para>les ionformations sont écrites comme commentaires du fichier Scilab</para>
65
 
              </listitem>
66
 
            </varlistentry>
67
 
            <varlistentry>
68
 
              <term>2</term>
69
 
              <listitem>
70
 
                <para>les ionformations sont écrites comme commentaires du fichier Scilab et dans le fichier log</para>
71
 
              </listitem>
72
 
            </varlistentry>
73
 
            <varlistentry>
74
 
              <term>3</term>
75
 
              <listitem>
76
 
                <para>les ionformations sont écrites comme commentaires du fichier Scilab, dans le fichier log et affichées dans la fenêtre Scilab (Valeur par défaut).</para>
77
 
              </listitem>
78
 
            </varlistentry>
79
 
          </variablelist>
80
 
        </listitem>
81
 
      </varlistentry>
82
 
      <varlistentry>
83
 
        <term>prettyprintoutput</term>
84
 
        <listitem>
85
 
          <para>Flag booléen, si il vaut %T le code généré est réarrangé. Valeur par défaut : %F</para>
86
 
        </listitem>
87
 
      </varlistentry>
88
 
    </variablelist>
89
 
  </refsection>
90
 
  <refsection>
91
 
    <title>Description</title>
92
 
    <para>
93
 
      M2SCI (et en particulier mfile2sci) est un ensemble d'outils de conversion de M-file vers Scilab. Il essaie
94
 
      à chaque fois que c'est possible de remplacer l'appel à une fonction Matlab par la
95
 
      primitive ou la fonction Scilab équivalente.
96
 
    </para>
97
 
    <para>
98
 
      Pour convertir un M-file, entrer l'instruction Scilab :
99
 
      mfile2sci(fichier)
100
 
    </para>
101
 
    <para>
102
 
      où fichier est une chaîne de caractère qui donne le chemin du M-file.
103
 
      mfile2sci va générer trois fichiers dans le même répertoire :
104
 
    </para>
105
 
    <variablelist>
106
 
      <varlistentry>
107
 
        <term>&lt;function-name&gt;.sci</term>
108
 
        <listitem>
109
 
          <para>l'équivalent Scilab pour le M-file</para>
110
 
        </listitem>
111
 
      </varlistentry>
112
 
      <varlistentry>
113
 
        <term>&lt;function-name&gt;.cat</term>
114
 
        <listitem>
115
 
          <para>le fichier d'aide Scilab associé à la fonction</para>
116
 
        </listitem>
117
 
      </varlistentry>
118
 
      <varlistentry>
119
 
        <term>sci_&lt;function-name&gt;.sci</term>
120
 
        <listitem>
121
 
          <para>la fonction Scilab requise pour convertir les appels à ce M-file dans d'autres M-files. Cette fonction peut être améliorée "à la main". Cette fonction est utile uniquement pour la conversion, pas pour utiliser la fonction convertie.</para>
122
 
        </listitem>
123
 
      </varlistentry>
124
 
    </variablelist>
125
 
    <para>
126
 
      Des fonctions comme eye, ones, size, sum,... se comportent différemment
127
 
      selon la dimension de leurs arguments. Quand mfile2sci ne peut pas 
128
 
      inférer les dimensions, il remplace ces fonctions par un appel à une
129
 
      fonction d'émulation nommée mtlb_&lt;function_name&gt;. Pour une meilleure éfficacité,
130
 
      ces fonctions peuvent être remplacées par les instructions Scilab équivalentes.
131
 
      Pour avoir des informations sur le remplacement, entrer :
132
 
      help mtlb_&lt;function_name&gt; dans la fenêtre de commande Scilab.
133
 
    </para>
134
 
    <para>
135
 
      D'autres fonctions comme plot, n'ont pas d'équivalent direct en
136
 
      Scilab. Elles sont aussi remplacées par des fonctions d'émulation nommées :
137
 
      mtlb_&lt;function_name&gt;.
138
 
    </para>
139
 
    <para>
140
 
      Quand la conversion peut être incorrecte ou améliorée, mfile2sci ajoute
141
 
      des commentaires qui commencent par "//!" (suivant verbose-mode).
142
 
    </para>
143
 
    <para>
144
 
      Un appel à <literal>mfile2sci()</literal> sans rhs lance une interface graphique pour aider à la sélection d'un fichier/répertoire et des options.
145
 
    </para>
146
 
  </refsection>
147
 
  <refsection>
148
 
    <title>Exemples</title>
149
 
    <programlisting role="example"><![CDATA[ 
 
15
    <refnamediv>
 
16
        <refname>mfile2sci</refname>
 
17
        <refpurpose> Fonction de conversion de M-file Matlab vers Scilab</refpurpose>
 
18
    </refnamediv>
 
19
    <refsynopsisdiv>
 
20
        <title>Séquence d'appel</title>
 
21
        <synopsis>mfile2sci(M-file-path [,result-path [,Recmode [,only-double [,verbose-mode [,prettyprintoutput]]]]])</synopsis>
 
22
    </refsynopsisdiv>
 
23
    <refsection>
 
24
        <title>Paramètres</title>
 
25
        <variablelist>
 
26
            <varlistentry>
 
27
                <term>M-file-path</term>
 
28
                <listitem>
 
29
                    <para>une chaîne de caractères qui donne le chemin du M-file à traduire</para>
 
30
                </listitem>
 
31
            </varlistentry>
 
32
            <varlistentry>
 
33
                <term>result-path</term>
 
34
                <listitem>
 
35
                    <para>une chaîne de caractères qui donne le répertoire où le résultat sera écrit. La valeur par défault est le répertoire courant.</para>
 
36
                </listitem>
 
37
            </varlistentry>
 
38
            <varlistentry>
 
39
                <term>Recmode</term>
 
40
                <listitem>
 
41
                    <para>Flag booléen, utilisé par translatepaths pour une conversion récursive. Doit être %F pour convertir un seul M-file. Valeur par défaut : %F</para>
 
42
                </listitem>
 
43
            </varlistentry>
 
44
            <varlistentry>
 
45
                <term>only-double</term>
 
46
                <listitem>
 
47
                    <para>Flag booléen, si il vaut %T mfile2sci considère que les fonctions de calcul numériques ont été utilisées uniquement avec des données numériques (Aucune fonction de surcharge Scilab est requise). Valeur par défaut : %T</para>
 
48
                </listitem>
 
49
            </varlistentry>
 
50
            <varlistentry>
 
51
                <term>verbose-mode</term>
 
52
                <listitem>
 
53
                    <para>mode d'affichage des information de conversion</para>
 
54
                    <variablelist>
 
55
                        <varlistentry>
 
56
                            <term>0</term>
 
57
                            <listitem>
 
58
                                <para>aucune information donnée</para>
 
59
                            </listitem>
 
60
                        </varlistentry>
 
61
                        <varlistentry>
 
62
                            <term>1</term>
 
63
                            <listitem>
 
64
                                <para>les ionformations sont écrites comme commentaires du fichier Scilab</para>
 
65
                            </listitem>
 
66
                        </varlistentry>
 
67
                        <varlistentry>
 
68
                            <term>2</term>
 
69
                            <listitem>
 
70
                                <para>les ionformations sont écrites comme commentaires du fichier Scilab et dans le fichier log</para>
 
71
                            </listitem>
 
72
                        </varlistentry>
 
73
                        <varlistentry>
 
74
                            <term>3</term>
 
75
                            <listitem>
 
76
                                <para>les ionformations sont écrites comme commentaires du fichier Scilab, dans le fichier log et affichées dans la fenêtre Scilab (Valeur par défaut).</para>
 
77
                            </listitem>
 
78
                        </varlistentry>
 
79
                    </variablelist>
 
80
                </listitem>
 
81
            </varlistentry>
 
82
            <varlistentry>
 
83
                <term>prettyprintoutput</term>
 
84
                <listitem>
 
85
                    <para>Flag booléen, si il vaut %T le code généré est réarrangé. Valeur par défaut : %F</para>
 
86
                </listitem>
 
87
            </varlistentry>
 
88
        </variablelist>
 
89
    </refsection>
 
90
    <refsection>
 
91
        <title>Description</title>
 
92
        <para>
 
93
            M2SCI (et en particulier mfile2sci) est un ensemble d'outils de conversion de M-file vers Scilab. Il essaie
 
94
            à chaque fois que c'est possible de remplacer l'appel à une fonction Matlab par la
 
95
            primitive ou la fonction Scilab équivalente.
 
96
        </para>
 
97
        <para>
 
98
            Pour convertir un M-file, entrer l'instruction Scilab :
 
99
            mfile2sci(fichier)
 
100
        </para>
 
101
        <para>
 
102
            où fichier est une chaîne de caractère qui donne le chemin du M-file.
 
103
            mfile2sci va générer trois fichiers dans le même répertoire :
 
104
        </para>
 
105
        <variablelist>
 
106
            <varlistentry>
 
107
                <term>&lt;function-name&gt;.sci</term>
 
108
                <listitem>
 
109
                    <para>l'équivalent Scilab pour le M-file</para>
 
110
                </listitem>
 
111
            </varlistentry>
 
112
            <varlistentry>
 
113
                <term>&lt;function-name&gt;.cat</term>
 
114
                <listitem>
 
115
                    <para>le fichier d'aide Scilab associé à la fonction</para>
 
116
                </listitem>
 
117
            </varlistentry>
 
118
            <varlistentry>
 
119
                <term>sci_&lt;function-name&gt;.sci</term>
 
120
                <listitem>
 
121
                    <para>la fonction Scilab requise pour convertir les appels à ce M-file dans d'autres M-files. Cette fonction peut être améliorée "à la main". Cette fonction est utile uniquement pour la conversion, pas pour utiliser la fonction convertie.</para>
 
122
                </listitem>
 
123
            </varlistentry>
 
124
        </variablelist>
 
125
        <para>
 
126
            Des fonctions comme eye, ones, size, sum,... se comportent différemment
 
127
            selon la dimension de leurs arguments. Quand mfile2sci ne peut pas 
 
128
            inférer les dimensions, il remplace ces fonctions par un appel à une
 
129
            fonction d'émulation nommée mtlb_&lt;function_name&gt;. Pour une meilleure éfficacité,
 
130
            ces fonctions peuvent être remplacées par les instructions Scilab équivalentes.
 
131
            Pour avoir des informations sur le remplacement, entrer :
 
132
            help mtlb_&lt;function_name&gt; dans la fenêtre de commande Scilab.
 
133
        </para>
 
134
        <para>
 
135
            D'autres fonctions comme plot, n'ont pas d'équivalent direct en
 
136
            Scilab. Elles sont aussi remplacées par des fonctions d'émulation nommées :
 
137
            mtlb_&lt;function_name&gt;.
 
138
        </para>
 
139
        <para>
 
140
            Quand la conversion peut être incorrecte ou améliorée, mfile2sci ajoute
 
141
            des commentaires qui commencent par "//!" (suivant verbose-mode).
 
142
        </para>
 
143
        <para>
 
144
            Un appel à <literal>mfile2sci()</literal> sans rhs lance une interface graphique pour aider à la sélection d'un fichier/répertoire et des options.
 
145
        </para>
 
146
    </refsection>
 
147
    <refsection>
 
148
        <title>Exemples</title>
 
149
        <programlisting role="example"><![CDATA[ 
150
150
// Création d'un fichier .m simple
151
151
rot90m = ["function B = rot90(A,k)"
152
152
        "if ~isa(A, ''double'')"
192
192
m=rand(4,2);
193
193
rot90(m,1)
194
194
 ]]></programlisting>
195
 
  </refsection>
196
 
  <refsection role="see also">
197
 
    <title>Voir aussi</title>
198
 
    <simplelist type="inline">
199
 
      <member>
200
 
        <link linkend="translatepaths">translatepaths</link>
201
 
      </member>
202
 
    </simplelist>
203
 
  </refsection>
 
195
    </refsection>
 
196
    <refsection role="see also">
 
197
        <title>Voir aussi</title>
 
198
        <simplelist type="inline">
 
199
            <member>
 
200
                <link linkend="translatepaths">translatepaths</link>
 
201
            </member>
 
202
        </simplelist>
 
203
    </refsection>
204
204
</refentry>