1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
|
<?xml version="1.0" encoding="UTF-8"?>
<!--
* Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
* Copyright (C) 2002-2004 - INRIA - Vincent COUVERT
*
* This file must be used under the terms of the CeCILL.
* This source file is licensed as described in the file COPYING, which
* you should have received as part of this distribution. The terms
* are also available at
* http://www.cecill.info/licences/Licence_CeCILL_V2-en.txt
*
-->
<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="sci_files">
<info>
<pubdate>$LastChangedDate$</pubdate>
</info>
<refnamediv>
<refname>sci_files</refname>
<refpurpose>Comment écrire des fonctions de conversion</refpurpose>
</refnamediv>
<refsection>
<title>Description</title>
<para>
Pour convertir les appels à des fonctions Matlab, <literal>mfile2sci</literal> utilise une fonctions appelée
<literal>sci_<nom_de_la_fonction_Matlab></literal>. Toutes ces fonctions sont définies dans des <literal>sci_files</literal>
dans le répertoire SCI/modules/m2sci/macros/sci_files/. La palette de <literal>sci_files</literal> fournie dans Scilab
ne permet pas encore de convertir les appels à toutes les fonctions Matlab.
Cependant, un utilisateur Scilab peut ajouter des <literal>sci_files</literal> (pour des fonctions Matlab
ou pour ses propres fonctions) en utilisant les conseils suivants.
</para>
<para>
Dans M2SCI, un appel à une fonction est considéré comme un "arbre" (c'est aussi le cas des instructions
du fichier à convertir), représenté dans Scilab par une <literal>tlist</literal> avec les champs suivants :
</para>
<itemizedlist>
<listitem>
<variablelist>
<varlistentry>
<term>name</term>
<listitem>
<para>nom de la fonction Matlab</para>
</listitem>
</varlistentry>
<varlistentry>
<term>lhsnb</term>
<listitem>
<para>nombre de paramètres de sortie de la fonction Matlab</para>
</listitem>
</varlistentry>
<varlistentry>
<term>lhs</term>
<listitem>
<para>liste des paramètres de sortie de la fonction Matlab</para>
</listitem>
</varlistentry>
<varlistentry>
<term>rhs</term>
<listitem>
<para>liste des paramètres d'entrée de la fonction Matlab</para>
</listitem>
</varlistentry>
</variablelist>
</listitem>
</itemizedlist>
<para>
Une <literal>sci_function</literal> a un paramètre d'entrée <literal>tree</literal> qui est aussi la sortie de cette fonction.
Une <literal>sci_function</literal> doit convertir cet arbre pour qu'il soit compatible avec Scilab
en changeant name, lhsnb, lhs et/ou rhs. L'autre rôle de cette fonction est de gérer
l'inférence. L'arbre d'entrée contient des données d'inférence dans ses rhs qui devront être mises à jour avec
ce que l'on peut inférer pour les lhs de cette fonction.
</para>
<para>
Plusieurs fonctions ont été écrites pour aider à la rédaction de fonctions de conversion :
</para>
<itemizedlist>
<listitem>
<variablelist>
<varlistentry>
<term>Funcall</term>
<listitem>
<para>créé un arbre qui représente l'appel à une fonction</para>
</listitem>
</varlistentry>
<varlistentry>
<term>Operation</term>
<listitem>
<para>créé un arbre qui représente une opération</para>
</listitem>
</varlistentry>
<varlistentry>
<term>Variable</term>
<listitem>
<para>créé un arbre qui représente une variable</para>
</listitem>
</varlistentry>
<varlistentry>
<term>Cste</term>
<listitem>
<para>créé un arbre qui représente une constante</para>
</listitem>
</varlistentry>
<varlistentry>
<term>Infer</term>
<listitem>
<para>créé un arbre qui représente les données d'inférence</para>
</listitem>
</varlistentry>
<varlistentry>
<term>Type</term>
<listitem>
<para>créé un arbre qui représente le type pour l'inférence</para>
</listitem>
</varlistentry>
<varlistentry>
<term>Equal</term>
<listitem>
<para>créé un arbre qui représente une instruction</para>
</listitem>
</varlistentry>
</variablelist>
</listitem>
</itemizedlist>
<para>
Quelques fonctions ont été écrites pour récupèrer les propriétés des opérandes/entrées. En considérant A comme une tlist utilisée dans l'arbre, vous pouvez utiliser les fonctions suivantes :
</para>
<informaltable border="1">
<tr>
<td>La fonction</td>
<td>renvoie %T si...</td>
</tr>
<tr>
<td>is_empty(A)</td>
<td>toutes les dimensions de A sont égales à 0</td>
</tr>
<tr>
<td>not_empty(A)</td>
<td>toutes les dimensions de A sont connues et au moins une dimension de A est différente de 0</td>
</tr>
<tr>
<td>is_a_scalar(A)</td>
<td>toutes les dimensions de A sont égales 1</td>
</tr>
<tr>
<td>not_a_scalar(A)</td>
<td>toutes les dimensions de A sont connues et au moins une dimension de A est différente de 1</td>
</tr>
<tr>
<td>is_a_vector(A)</td>
<td>toutes les dimensions de A sotn connues et toutes les dimensions de A sauf une sont égales à 1</td>
</tr>
<tr>
<td>not_a_vector(A)</td>
<td>toutes les dimensions de A sotn connues et au moins deux dimensions de A sont supérieures à 1</td>
</tr>
<tr>
<td>is_real(A)</td>
<td>A est réel</td>
</tr>
<tr>
<td>is_complex(A)</td>
<td>A est complexe</td>
</tr>
<tr>
<td>isdefinedvar(A)</td>
<td>A est une variable déjà définie dans le M-file en cours de conversion</td>
</tr>
<tr>
<td>allunknown(A)</td>
<td>Toutes les dimensions de A sont inconnues</td>
</tr>
</informaltable>
<para>
D'autres fonctions ont été écrites pour des besoins spécifiques lors de l'écriture de fonctions de conversion :
</para>
<itemizedlist>
<listitem>
<variablelist>
<varlistentry>
<term>first_non_singleton</term>
<listitem>
<para>est équivalente à <link linkend="firstnonsingleton">firstnonsingleton</link> pour une tlist M2SCI. Séquence d'appel : dim = first_non_singleton(A)</para>
</listitem>
</varlistentry>
<varlistentry>
<term>gettempvar</term>
<listitem>
<para>génére une variable temporaire portant une nom qui n'existe pas. Séquence d'appel : v = gettempvar()</para>
</listitem>
</varlistentry>
<varlistentry>
<term>insert</term>
<listitem>
<para>permet d'insérer des instruction. Séquence d'appel : insert(Equal(...),opt) avec opt~=1 pour insérer avan tl'instruction courante et opt=1 pour insérer après celle-ci.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>getoperands</term>
<listitem>
<para>peut être utilisée pour extraire chaque opérande comme une variable. Séquence d'appel : [A,B] = getoperands(operation_tlist)</para>
</listitem>
</varlistentry>
<varlistentry>
<term>getrhs</term>
<listitem>
<para>peut être utilisée pour extraire chaque paramètre comme une variable. Séquence d'appel : [A,...] = getrhs(funcall_tlist)</para>
</listitem>
</varlistentry>
<varlistentry>
<term>convert2double</term>
<listitem>
<para>change le type de l'entrée quand ce type n'est pas implémenté pour une fonction particulière de Scilab. Séquence d'appel : A = convert2double(A)</para>
</listitem>
</varlistentry>
</variablelist>
</listitem>
</itemizedlist>
<para>
Pour plus d'informations sur la façon d'écrire ces fichiers, consulter le répertoire
SCI/modules/m2sci/macros/sci_files/ qui donne de nombreux exemples, des plus simples (e.g. sci_abs.sci)
aux plus compliqués (e.g. sci_zeros.sci).
</para>
</refsection>
<refsection>
<title>Voir Aussi</title>
<simplelist type="inline">
<member>
<link linkend="m2scideclare">m2scideclare</link>
</member>
<member>
<link linkend="Funcall">Funcall</link>
</member>
<member>
<link linkend="Operation">Operation</link>
</member>
<member>
<link linkend="Variable">Variable</link>
</member>
<member>
<link linkend="Cste">Cste</link>
</member>
<member>
<link linkend="Infer">Infer</link>
</member>
<member>
<link linkend="Type">Type</link>
</member>
<member>
<link linkend="Equal">Equal</link>
</member>
</simplelist>
</refsection>
<refsection>
<title>Auteurs</title>
<simplelist type="vert">
<member>V.C.</member>
</simplelist>
</refsection>
</refentry>
|
