Corrected error when calling fftw_forget_wisdom + documentation 61/14361/2
Pierre-Aime Agnel [Mon, 7 Apr 2014 14:41:26 +0000 (16:41 +0200)]
Invalid argument error received after any calls. Default value was not the proper one in documentation

Change-Id: I2b23941447a663c4d7ae1de72e6cdebf906ba4ea

scilab/modules/fftw/help/en_US/fftw_flags.xml
scilab/modules/fftw/help/fr_FR/fftw_flags.xml
scilab/modules/fftw/sci_gateway/c/sci_fftw_forget_wisdom.c

index ef3ec13..24bd93b 100644 (file)
         </para>
         <para>
             <warning>
-                Warning: the default value "FFTW_MEASURE" gives
+                Warning: the default value "FFTW_ESTIMATE" gives generally 
                 quite efficient plans. Try to change it only if the fft efficiency is
-                really important and you have a lot of simmilar calls to do.
+                really important and you have a lot of similar calls to do.
             </warning>
         </para>
         
         <para>Accepted entries are :</para>
         <itemizedlist>
             <listitem>
-                <para>FFTW_ESTIMATE or 64. Specifies that, instead of actual
+                <para>{FFTW_ESTIMATE} or 64. Specifies that, instead of actual
                     measurements of different algorithms, a simple heuristic is
                     used to pick a (probably sub-optimal) plan quickly. With this
                     flag, the input/output arrays are not overwritten during
-                    planning. It is the defailt value
+                    planning. It is the default value
                 </para>
             </listitem>
             <listitem>
-                <para>"FFTW_MEASURE" or 0. tells FFTW to find an optimized
+                <para>FFTW_MEASURE or 0. tells FFTW to find an optimized
                     plan by actually computing several FFTs and measuring their
                     execution time. Depending on your machine, this can take some
                     time (often a few seconds). 
-                    planning option.
                 </para>
             </listitem>
             <listitem>
         
         
         <para>Remark : when using FFTW_MEASURE/FFTW_PATIENT/FFTW_EXHAUSTIVE you must
-            call two times fftw. (first call for initialisation, second and others
+            call fftw twice. (first call for initialization, second and others
             calls for computation)
         </para>
     </refsection>
index e3c0bea..68ee15e 100644 (file)
@@ -40,7 +40,7 @@
             <varlistentry>
                 <term>a</term>
                 <listitem>
-                    <para>un entier. Code de l'algorithme de planification.Voir
+                    <para>un entier. Code de l'algorithme de planification. Voir
                         ci-dessous.
                     </para>
                 </listitem>
         </para>
         <para>
             <warning>
-                Attention: la valeur par défaut "FFTW_MEASURE" donne le plus
+                Attention: la valeur par défaut "FFTW_ESTIMATE" donne le plus
                 souvent de bonnes performances. N'essayez d'autres choix que si
                 la performance est cruciale et que vous avez beaucoup d'appels
-                du même type que faire.
+                du même type à effectuer.
             </warning>
         </para>
         <para>
         </para>
         <itemizedlist>
             <listitem>
-                <para>FFTW_ESTIMATE ou 64. Selectionne une heuristique simple et
+                <para>{FFTW_ESTIMATE} ou 64. Selectionne une heuristique simple et
                     peu couteuse pour choisir un plan (probablement
                     sous-optimal). C'est la valeur par défaut.
                 </para>
             </listitem>
             <listitem>
                 <para>FFTW_MEASURE ou 0.  Selectionne une méthode consistant a
-                    éffectuer plusieurs calcul de fft avec des planifications
+                    effectuer plusieurs calcul de fft avec des planifications
                     différentes, à mesurer leur temps d'exécution et de choisir la
-                    meilleur planification. En fonction de votre machine, cela
-                    peut prendre un certain le temps (souvent quelques
+                    meilleure planification. En fonction de votre machine, cela
+                    peut prendre un certain temps (souvent quelques
                     secondes).
                 </para>
             </listitem>
                 <para>FFTW_PATIENT ou 32. Similaire à "FFTW_MEASURE", mais
                     considère un plus large éventail d'algorithmes et produit
                     souvent un plan plus efficace (en particulier pour les
-                    transformations importantes), par contre le cout de la
+                    transformations importantes). En revanche, le coût de la
                     détermination du plan peut être largement supérieur (en
                     particulier pour les transformations importantes).
                 </para>
             </listitem>
             
             <listitem>
-                <para>FFTW_EXHAUSTIVE or 8. C'est comme "FFTW_PATIENT", mais
+                <para>FFTW_EXHAUSTIVE ou 8. Comme "FFTW_PATIENT", mais
                     considère une gamme encore plus large d'algorithmes, visant a
                     trouver le plan optimal , mais avec un temps de planification
                     sensiblement augmenté. 
index 3b3adfb..f514bfb 100644 (file)
@@ -36,6 +36,9 @@ int sci_fftw_forget_wisdom(char *fname, unsigned long fname_len)
     FreeFFTWPlan(getSci_Forward_Plan());
 
     call_fftw_forget_wisdom();
+    
+    AssignOutputVariable(pvApiCtx, 1) = 0;
+    ReturnArguments(pvApiCtx);
 
     return 0;
 }