fftw_flags demo takes too long to compute
[scilab.git] / scilab / modules / fftw / help / fr_FR / fftw_flags.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) 2007 - 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" 
14           xmlns:xlink="http://www.w3.org/1999/xlink" 
15           xmlns:svg="http://www.w3.org/2000/svg" 
16           xmlns:mml="http://www.w3.org/1998/Math/MathML" 
17           xmlns:db="http://docbook.org/ns/docbook" 
18           xmlns:scilab="http://www.scilab.org" xml:lang="fr" xml:id="fftw_flags">
19     <refnamediv>
20         <refname>fftw_flags</refname>
21         <refpurpose>choix de la méthode pour la sélection de l'algorithme
22             de planification pour la fft
23         </refpurpose>
24     </refnamediv>
25     <refsynopsisdiv>
26         <title>Séquence d'appel</title>
27         <synopsis>[a,[S]]=fftw_flags(flag)</synopsis>
28     </refsynopsisdiv>
29     <refsection>
30         <title>Paramètres</title>
31         <variablelist>
32             <varlistentry>
33                 <term>flag</term>
34                 <listitem>
35                     <para>une chaîne de caractères ou bien un entier. Sert à
36                         spécifier l'algorithme de planification. Voir ci-dessous.
37                     </para>
38                 </listitem>
39             </varlistentry>
40             <varlistentry>
41                 <term>a</term>
42                 <listitem>
43                     <para>un entier. Code de l'algorithme de planification. Voir
44                         ci-dessous.
45                     </para>
46                 </listitem>
47             </varlistentry>
48             <varlistentry>
49                 <term>S</term>
50                 <listitem>
51                     <para>une chaîne de caractères. Le nom de l'algorithme de
52                         planification.
53                     </para>
54                 </listitem>
55             </varlistentry>
56         </variablelist>
57     </refsection>
58     <refsection>
59         <title>Description</title>
60         <para>
61             Cette fonction permet la sélection de l'algorithme utilisé pour
62             déterminer l'algorithme de planification de fftw. Le
63             planificateur est utilisé pour déterminer un moyen efficace pour
64             calculer la fft.
65         </para>
66         <para>
67             <warning>
68                 Attention: la valeur par défaut "FFTW_ESTIMATE" donne le plus
69                 souvent de bonnes performances. N'essayez d'autres choix que si
70                 la performance est cruciale et que vous avez beaucoup d'appels
71                 du même type à effectuer.
72             </warning>
73         </para>
74         <para>
75             Les entrées possibles sont :
76         </para>
77         <itemizedlist>
78             <listitem>
79                 <para>{FFTW_ESTIMATE} ou 64. Selectionne une heuristique simple et
80                     peu couteuse pour choisir un plan (probablement
81                     sous-optimal). C'est la valeur par défaut.
82                 </para>
83             </listitem>
84             <listitem>
85                 <para>FFTW_MEASURE ou 0.  Selectionne une méthode consistant a
86                     effectuer plusieurs calcul de fft avec des planifications
87                     différentes, à mesurer leur temps d'exécution et de choisir la
88                     meilleure planification. En fonction de votre machine, cela
89                     peut prendre un certain temps (souvent quelques
90                     secondes).
91                 </para>
92             </listitem>
93             <listitem>
94                 <para>FFTW_PATIENT ou 32. Similaire à "FFTW_MEASURE", mais
95                     considère un plus large éventail d'algorithmes et produit
96                     souvent un plan plus efficace (en particulier pour les
97                     transformations importantes). En revanche, le coût de la
98                     détermination du plan peut être largement supérieur (en
99                     particulier pour les transformations importantes).
100                 </para>
101             </listitem>
102             
103             <listitem>
104                 <para>FFTW_EXHAUSTIVE ou 8. Comme "FFTW_PATIENT", mais
105                     considère une gamme encore plus large d'algorithmes, visant a
106                     trouver le plan optimal , mais avec un temps de planification
107                     sensiblement augmenté. 
108                 </para>
109             </listitem>
110             
111         </itemizedlist>
112         <para>
113             Remarque : Lors de l'utilisation des méthodes
114             FFTW_MEASURE/FFTW_PATIENT/FFTW_EXHAUSTIVE la fonction fftw doit
115             être appélée au moins deux fois.  (le premier appel est pour
116             l'initalisation, le second et les autres pour le calcul)
117         </para>
118     </refsection>
119     <refsection>
120         <title>Exemples</title>
121         <programlisting role="example"><![CDATA[ 
122 A=rand(1, 2^9 + 2^15);
123 fftw_forget_wisdom();
124 fftw_flags("FFTW_ESTIMATE");
125 timer(); y=fft(A); timer()//premier appel, détermine le plan
126 timer(); y=fft(A); timer() //appels similaires suivants
127 fftw_flags("FFTW_MEASURE");
128 fftw_forget_wisdom();
129 timer(); y=fft(A); timer()//premier appel, détermine le plan, prend environ 5min
130 timer(); y=fft(A); timer() //appels similaires suivants
131
132  ]]></programlisting>
133     </refsection>
134     <refsection role="see also">
135         <title>Voir aussi</title>
136         <simplelist type="inline">
137             <member>
138                 <link linkend="fft">fft</link>
139             </member>
140             <member>
141                 <link linkend="set_fftw_wisdom">set_fftw_wisdom</link>
142             </member>
143             <member>
144                 <link linkend="get_fftw_wisdom">get_fftw_wisdom</link>
145             </member>
146             <member>
147                 <link linkend="fftw_forget_wisdom">fftw_forget_wisdom</link>
148             </member>
149         </simplelist>
150     </refsection>
151 </refentry>