Update french doc of fftw module
Alan Layec [Wed, 18 Apr 2007 14:43:15 +0000 (14:43 +0000)]
localization/fr_FR/scilab/modules/fftw/help/fr_FR/fftw.xml
localization/fr_FR/scilab/modules/fftw/help/fr_FR/fftw_flags.xml
localization/fr_FR/scilab/modules/fftw/help/fr_FR/fftw_forget_wisdom.xml [new file with mode: 0644]
localization/fr_FR/scilab/modules/fftw/help/fr_FR/fftw_inplace.xml [deleted file]
localization/fr_FR/scilab/modules/fftw/help/fr_FR/fftw_norm.xml [deleted file]
localization/fr_FR/scilab/modules/fftw/help/fr_FR/freefftw_plan.xml [deleted file]
localization/fr_FR/scilab/modules/fftw/help/fr_FR/get_fftw_wisdom.xml [new file with mode: 0644]
localization/fr_FR/scilab/modules/fftw/help/fr_FR/pushfftw_plan.xml [deleted file]
localization/fr_FR/scilab/modules/fftw/help/fr_FR/set_fftw_wisdom.xml [new file with mode: 0644]

index ac3c311..6c33dcd 100644 (file)
   <SEE_ALSO>
     <SEE_ALSO_ITEM>
       <A href='fftw_flags.htm'><VERB>fftw_flags</VERB></A>
-    </SEE_ALSO_ITEM>
-    <SEE_ALSO_ITEM>
-      <A href='fftw_norm.htm'><VERB>fftw_norm</VERB></A>
-    </SEE_ALSO_ITEM>
-    <SEE_ALSO_ITEM>
-      <A href='fftw_inplace.htm'><VERB>fftw_inplace</VERB></A>
-    </SEE_ALSO_ITEM>
-    <SEE_ALSO_ITEM>
-      <A href='pushfftw_plan.htm'><VERB>pushfftw_plan</VERB></A>
-    </SEE_ALSO_ITEM>
-    <SEE_ALSO_ITEM>
-      <A href='freefftw_plan.htm'><VERB>freefftw_plan</VERB></A>
+      <A href='get_fftw_wisdom.htm'><VERB>get_fftw_wisdom</VERB></A>
+      <A href='set_fftw_wisdom.htm'><VERB>set_fftw_wisdom</VERB></A>
+      <A href='fftw_forget_wisdom.htm'><VERB>fftw_forget_wisdom</VERB></A>
     </SEE_ALSO_ITEM>
   </SEE_ALSO>
 
index 8093bef..5a1a3cc 100644 (file)
     <SEE_ALSO_ITEM>
       <A href='fftw.htm'><VERB>fftw</VERB></A>
     </SEE_ALSO_ITEM>
-    <SEE_ALSO_ITEM>
-      <A href='fftw_norm.htm'><VERB>fftw_norm</VERB></A>
-    </SEE_ALSO_ITEM>
-    <SEE_ALSO_ITEM>
-      <A href='fftw_inplace.htm'><VERB>fftw_inplace</VERB></A>
-    </SEE_ALSO_ITEM>
-    <SEE_ALSO_ITEM>
-      <A href='pushfftw_plan.htm'><VERB>pushfftw_plan</VERB></A>
-    </SEE_ALSO_ITEM>
-    <SEE_ALSO_ITEM>
-      <A href='freefftw_plan.htm'><VERB>freefftw_plan</VERB></A>
-    </SEE_ALSO_ITEM>
   </SEE_ALSO>
 
 </MAN>
diff --git a/localization/fr_FR/scilab/modules/fftw/help/fr_FR/fftw_forget_wisdom.xml b/localization/fr_FR/scilab/modules/fftw/help/fr_FR/fftw_forget_wisdom.xml
new file mode 100644 (file)
index 0000000..1fcfaed
--- /dev/null
@@ -0,0 +1,34 @@
+<?xml version="1.0" encoding="ISO-8859-1" standalone="no"?>
+<!DOCTYPE MAN SYSTEM "../../../../modules/helptools/help.dtd">
+<MAN>
+  <LANGUAGE>fr</LANGUAGE>
+  <TITLE>fftw_forget_wisdom</TITLE>
+  <TYPE>Scilab Function</TYPE>
+  <DATE>February 2006</DATE>
+  <SHORT_DESCRIPTION name="fftw_forget_wisdom">Re-initialise le wisdom fftw</SHORT_DESCRIPTION>
+  <CALLING_SEQUENCE>
+    <CALLING_SEQUENCE_ITEM>fftw_forget_wisdom()</CALLING_SEQUENCE_ITEM>
+  </CALLING_SEQUENCE>
+  <DESCRIPTION>
+    <P>
+       Cette fonction re-initialise le wisdom fftw.
+    </P>
+  </DESCRIPTION>
+  <EXAMPLE>
+<![CDATA[
+ //return fftw wisdom
+ txt=get_fftw_wisdom();
+ //set fftw wisdom
+ set_fftw_wisdom(txt);
+ //reset fftw wisdom
+ fftw_forget_wisdom();
+ ]]>
+  </EXAMPLE>
+  <SEE_ALSO>
+    <SEE_ALSO_ITEM>
+      <A href='fftw.htm'><VERB>fftw</VERB></A>
+      <A href='get_fftw_wisdom.htm'><VERB>get_fftw_wisdom</VERB></A>
+      <A href='set_fftw_wisdom.htm'><VERB>set_fftw_wisdom</VERB></A>
+    </SEE_ALSO_ITEM>
+  </SEE_ALSO>
+</MAN>
diff --git a/localization/fr_FR/scilab/modules/fftw/help/fr_FR/fftw_inplace.xml b/localization/fr_FR/scilab/modules/fftw/help/fr_FR/fftw_inplace.xml
deleted file mode 100644 (file)
index ea87c6d..0000000
+++ /dev/null
@@ -1,58 +0,0 @@
-<?xml version="1.0" encoding="ISO-8859-1" standalone="no"?>
-<!DOCTYPE MAN SYSTEM "../../../../modules/helptools/help.dtd">
-<MAN>
-  <LANGUAGE>fr</LANGUAGE>
-  <TITLE>fftw_inplace</TITLE>
-  <TYPE>Scilab Function</TYPE>
-  <DATE>October 2006</DATE>
-  <SHORT_DESCRIPTION name="fftw_inplace">détermine si les transformées sont effectuées sur-place</SHORT_DESCRIPTION>
-  <CALLING_SEQUENCE>
-    <CALLING_SEQUENCE_ITEM>[b]=fftw_inplace()</CALLING_SEQUENCE_ITEM>
-    <CALLING_SEQUENCE_ITEM>[b]=fftw_inplace(b)</CALLING_SEQUENCE_ITEM>
-  </CALLING_SEQUENCE>
-  <PARAM>
-    <PARAM_INDENT>
-      <PARAM_ITEM>
-        <PARAM_NAME>b</PARAM_NAME>
-        <PARAM_DESCRIPTION>
-          <SP>: booléen. <VERB>%t</VERB> ou <VERB>%f</VERB></SP>
-        </PARAM_DESCRIPTION>
-      </PARAM_ITEM>
-    </PARAM_INDENT>
-  </PARAM>
-  <DESCRIPTION>
-    <P>
-    Cette fonction permet de choisir entre une transformée réalisée sur-place dans la pile scilab(b=%t) ou bien si une nouvelle variable complexe est utilisée(b=%f).
-    </P>
-    <P>
-    La valeur par défault est %t.
-    </P>
-  </DESCRIPTION>
-  <EXAMPLE>
-<![CDATA[
- //montre si fftw() travaile sur-place
- fftw_inplace()
-
- //réalise des transformées "outplace"
- fftw_inplace(%f);
- ]]>
-  </EXAMPLE>
-  <SEE_ALSO>
-    <SEE_ALSO_ITEM>
-      <A href='fftw.htm'><VERB>fftw</VERB></A>
-    </SEE_ALSO_ITEM>
-    <SEE_ALSO_ITEM>
-      <A href='fftw_flags.htm'><VERB>fftw_flags</VERB></A>
-    </SEE_ALSO_ITEM>
-    <SEE_ALSO_ITEM>
-      <A href='fftw_norm.htm'><VERB>fftw_norm</VERB></A>
-    </SEE_ALSO_ITEM>
-    <SEE_ALSO_ITEM>
-      <A href='pushfftw_plan.htm'><VERB>pushfftw_plan</VERB></A>
-    </SEE_ALSO_ITEM>
-    <SEE_ALSO_ITEM>
-      <A href='freefftw_plan.htm'><VERB>freefftw_plan</VERB></A>
-    </SEE_ALSO_ITEM>
-  </SEE_ALSO>
-
-</MAN>
diff --git a/localization/fr_FR/scilab/modules/fftw/help/fr_FR/fftw_norm.xml b/localization/fr_FR/scilab/modules/fftw/help/fr_FR/fftw_norm.xml
deleted file mode 100644 (file)
index e006200..0000000
+++ /dev/null
@@ -1,62 +0,0 @@
-<?xml version="1.0" encoding="ISO-8859-1" standalone="no"?>
-<!DOCTYPE MAN SYSTEM "../../../../modules/helptools/help.dtd">
-<MAN>
-  <LANGUAGE>fr</LANGUAGE>
-  <TITLE>fftw_flags</TITLE>
-  <TYPE>Scilab Function</TYPE>
-  <DATE>October 2006</DATE>
-  <SHORT_DESCRIPTION name="fftw_norm">normalisation des données en sortie de la fonction fftw lors des transformées inverses</SHORT_DESCRIPTION>
-  <CALLING_SEQUENCE>
-    <CALLING_SEQUENCE_ITEM>[b]=fftw_norm()</CALLING_SEQUENCE_ITEM>
-    <CALLING_SEQUENCE_ITEM>[b]=fftw_norm(b)</CALLING_SEQUENCE_ITEM>
-  </CALLING_SEQUENCE>
-  <PARAM>
-    <PARAM_INDENT>
-      <PARAM_ITEM>
-        <PARAM_NAME>b</PARAM_NAME>
-        <PARAM_DESCRIPTION>
-          <SP>: booléen. %t ou %f</SP>
-        </PARAM_DESCRIPTION>
-      </PARAM_ITEM>
-    </PARAM_INDENT>
-  </PARAM>
-  <DESCRIPTION>
-    <P>
-    Cette fonction permet de normaliser les données de sortie de la fonction fftw lors des transformées inverses.
-   </P>
-  </DESCRIPTION>
-  <EXAMPLE>
-<![CDATA[
-  //retour du flag normalisation
-  fftw_norm()
-
-  a=1:4;
-
-  //sortie normalisée
-  fftw_norm(%t);
-  fftw(a,1)
-
-  //sortie non-normalisée
-  fftw_norm(%f);
-  fftw(a,1)
- ]]>
-  </EXAMPLE>
-  <SEE_ALSO>
-    <SEE_ALSO_ITEM>
-      <A href='fftw.htm'><VERB>fftw</VERB></A>
-    </SEE_ALSO_ITEM>
-    <SEE_ALSO_ITEM>
-      <A href='fftw_flags.htm'><VERB>fftw_flags</VERB></A>
-    </SEE_ALSO_ITEM>
-    <SEE_ALSO_ITEM>
-      <A href='fftw_inplace.htm'><VERB>fftw_inplace</VERB></A>
-    </SEE_ALSO_ITEM>
-    <SEE_ALSO_ITEM>
-      <A href='pushfftw_plan.htm'><VERB>pushfftw_plan</VERB></A>
-    </SEE_ALSO_ITEM>
-    <SEE_ALSO_ITEM>
-      <A href='freefftw_plan.htm'><VERB>freefftw_plan</VERB></A>
-    </SEE_ALSO_ITEM>
-  </SEE_ALSO>
-
-</MAN>
diff --git a/localization/fr_FR/scilab/modules/fftw/help/fr_FR/freefftw_plan.xml b/localization/fr_FR/scilab/modules/fftw/help/fr_FR/freefftw_plan.xml
deleted file mode 100644 (file)
index 4e09969..0000000
+++ /dev/null
@@ -1,50 +0,0 @@
-<?xml version="1.0" encoding="ISO-8859-1" standalone="no"?>
-<!DOCTYPE MAN SYSTEM "../../../../modules/helptools/help.dtd">
-<MAN>
-  <LANGUAGE>fr</LANGUAGE>
-  <TITLE>freefftw_plan</TITLE>
-  <TYPE>Scilab Function</TYPE>
-  <DATE>October 2006</DATE>
-  <SHORT_DESCRIPTION name="freefftw_plan">efface tous les plans fftw stockés en mémoire</SHORT_DESCRIPTION>
-  <CALLING_SEQUENCE>
-    <CALLING_SEQUENCE_ITEM>[d]=freefftw_plan()</CALLING_SEQUENCE_ITEM>
-  </CALLING_SEQUENCE>
-  <PARAM>
-    <PARAM_INDENT>
-      <PARAM_ITEM>
-        <PARAM_NAME>d</PARAM_NAME>
-        <PARAM_DESCRIPTION>
-          <SP>: entier. L'indice du plan courant. (toujours zéro)</SP>
-        </PARAM_DESCRIPTION>
-      </PARAM_ITEM>
-    </PARAM_INDENT>
-  </PARAM>
-  <DESCRIPTION>
-    <P>
-    Cette fonction ré-initialise les paramètres de la fonction fftw qui ont été enregistrés en mémoire.</P>
-  </DESCRIPTION>
-  <EXAMPLE>
-<![CDATA[
- //efface tous les plans stockés en mémoire
- freefftw_plan()
- ]]>
-  </EXAMPLE>
-  <SEE_ALSO>
-    <SEE_ALSO_ITEM>
-      <A href='fftw.htm'><VERB>fftw</VERB></A>
-    </SEE_ALSO_ITEM>
-    <SEE_ALSO_ITEM>
-      <A href='fftw_flags.htm'><VERB>fftw_flags</VERB></A>
-    </SEE_ALSO_ITEM>
-    <SEE_ALSO_ITEM>
-      <A href='fftw_norm.htm'><VERB>fftw_norm</VERB></A>
-    </SEE_ALSO_ITEM>
-    <SEE_ALSO_ITEM>
-      <A href='fftw_inplace.htm'><VERB>fftw_inplace</VERB></A>
-    </SEE_ALSO_ITEM>
-    <SEE_ALSO_ITEM>
-      <A href='pushfftw_plan.htm'><VERB>pushfftw_plan</VERB></A>
-    </SEE_ALSO_ITEM>
-  </SEE_ALSO>
-
-</MAN>
diff --git a/localization/fr_FR/scilab/modules/fftw/help/fr_FR/get_fftw_wisdom.xml b/localization/fr_FR/scilab/modules/fftw/help/fr_FR/get_fftw_wisdom.xml
new file mode 100644 (file)
index 0000000..9b0175c
--- /dev/null
@@ -0,0 +1,44 @@
+<?xml version="1.0" encoding="ISO-8859-1" standalone="no"?>
+<!DOCTYPE MAN SYSTEM "../../../../modules/helptools/help.dtd">
+<MAN>
+  <LANGUAGE>fr</LANGUAGE>
+  <TITLE>get_fftw_wisdom</TITLE>
+  <TYPE>Scilab Function</TYPE>
+  <DATE>February 2006</DATE>
+  <SHORT_DESCRIPTION name="get_fftw_wisdom">retourne le wisdom fftw</SHORT_DESCRIPTION>
+  <CALLING_SEQUENCE>
+    <CALLING_SEQUENCE_ITEM>[txt]=get_fftw_wisdom()</CALLING_SEQUENCE_ITEM>
+  </CALLING_SEQUENCE>
+  <PARAM>
+    <PARAM_INDENT>
+      <PARAM_ITEM>
+        <PARAM_NAME>txt</PARAM_NAME>
+        <PARAM_DESCRIPTION>
+          <SP>: Matrice de chaîne de caractères contenant le wisdom fftw.</SP>
+        </PARAM_DESCRIPTION>
+      </PARAM_ITEM>
+    </PARAM_INDENT>
+  </PARAM>
+  <DESCRIPTION>
+    <P>
+       Cette fonction retourne le wisdom fftw sous la forme d'une chaîne de caractère.
+    </P>
+  </DESCRIPTION>
+  <EXAMPLE>
+<![CDATA[
+ //return fftw wisdom
+ txt=get_fftw_wisdom();
+ //set fftw wisdom
+ set_fftw_wisdom(txt);
+ //reset fftw wisdom
+ fftw_forget_wisdom();
+ ]]>
+  </EXAMPLE>
+  <SEE_ALSO>
+    <SEE_ALSO_ITEM>
+      <A href='fftw.htm'><VERB>fftw</VERB></A>
+      <A href='set_fftw_wisdom.htm'><VERB>set_fftw_wisdom</VERB></A>
+      <A href='fftw_forget_wisdom.htm'><VERB>fftw_forget_wisdom</VERB></A>
+    </SEE_ALSO_ITEM>
+  </SEE_ALSO>
+</MAN>
diff --git a/localization/fr_FR/scilab/modules/fftw/help/fr_FR/pushfftw_plan.xml b/localization/fr_FR/scilab/modules/fftw/help/fr_FR/pushfftw_plan.xml
deleted file mode 100644 (file)
index 7e92ab2..0000000
+++ /dev/null
@@ -1,69 +0,0 @@
-<?xml version="1.0" encoding="ISO-8859-1" standalone="no"?>
-<!DOCTYPE MAN SYSTEM "../../../../modules/helptools/help.dtd">
-<MAN>
-  <LANGUAGE>fr</LANGUAGE>
-  <TITLE>pushfftw_plan</TITLE>
-  <TYPE>Scilab Function</TYPE>
-  <DATE>October 2006</DATE>
-  <SHORT_DESCRIPTION name="pushfftw_plan">met en mémoire le dernier plan fftw utilisé</SHORT_DESCRIPTION>
-  <CALLING_SEQUENCE>
-    <CALLING_SEQUENCE_ITEM>[d]=pushfftw_plan()</CALLING_SEQUENCE_ITEM>
-  </CALLING_SEQUENCE>
-  <PARAM>
-    <PARAM_INDENT>
-      <PARAM_ITEM>
-        <PARAM_NAME>d</PARAM_NAME>
-        <PARAM_DESCRIPTION>
-          <SP>: entier. L'indice du plan courant.</SP>
-        </PARAM_DESCRIPTION>
-      </PARAM_ITEM>
-    </PARAM_INDENT>
-  </PARAM>
-  <DESCRIPTION>
-    <P>
-    Cette fonction met en mémoire les derniers paramètres de la fonction fftw qui ont été utilisés.
-    </P>
-    <P>
-    Cela peut-être utile pour améliorer le temps de calcul de la fonction fftw lors d'appels multiples à la fonction avec des jeux de paramètres différents.
-    </P>
-  </DESCRIPTION>
-  <EXAMPLE>
-<![CDATA[freefftw_plan()
-
-//appels consécufifs avec mêmes paramètres
-tic;fftw(rand(1e6 + 3,1));toc() // time 1
-tic;fftw(rand(1e6 + 3,1));toc() // time 2 (< time 1)
-tic;fftw(rand(1e6 + 3,1));toc() // approx. same time as 2
-
-//appels consécufifs avec des paramètres différents
-tic;fftw(rand(1e6 + 37,1));toc()  // time 3
-tic;fftw(rand(1e6 + 3,1));toc()   // approx. same time as 1
-
-//mémorisation du dernier plan
-pushfftw_plan()
-tic;fftw(rand(1e6 + 37,1));toc()  // approx. same time as 3
-tic;fftw(rand(1e6 + 37,1));toc()  // time 4 (< time 3)
-tic;fftw(rand(1e6 + 3,1));toc()   // approx. same time as 2
-tic;fftw(rand(1e6 + 37,1));toc()  // approx. same time as time 4
-
-freefftw_plan() ]]>
-  </EXAMPLE>
-  <SEE_ALSO>
-    <SEE_ALSO_ITEM>
-      <A href='fftw.htm'><VERB>fftw</VERB></A>
-    </SEE_ALSO_ITEM>
-    <SEE_ALSO_ITEM>
-      <A href='fftw_flags.htm'><VERB>fftw_flags</VERB></A>
-    </SEE_ALSO_ITEM>
-    <SEE_ALSO_ITEM>
-      <A href='fftw_norm.htm'><VERB>fftw_norm</VERB></A>
-    </SEE_ALSO_ITEM>
-    <SEE_ALSO_ITEM>
-      <A href='fftw_inplace.htm'><VERB>fftw_inplace</VERB></A>
-    </SEE_ALSO_ITEM>
-    <SEE_ALSO_ITEM>
-      <A href='freefftw_plan.htm'><VERB>freefftw_plan</VERB></A>
-    </SEE_ALSO_ITEM>
-  </SEE_ALSO>
-
-</MAN>
diff --git a/localization/fr_FR/scilab/modules/fftw/help/fr_FR/set_fftw_wisdom.xml b/localization/fr_FR/scilab/modules/fftw/help/fr_FR/set_fftw_wisdom.xml
new file mode 100644 (file)
index 0000000..c9e9f9a
--- /dev/null
@@ -0,0 +1,44 @@
+<?xml version="1.0" encoding="ISO-8859-1" standalone="no"?>
+<!DOCTYPE MAN SYSTEM "../../../../modules/helptools/help.dtd">
+<MAN>
+  <LANGUAGE>fr</LANGUAGE>
+  <TITLE>set_fftw_wisdom</TITLE>
+  <TYPE>Scilab Function</TYPE>
+  <DATE>February 2006</DATE>
+  <SHORT_DESCRIPTION name="set_fftw_wisdom">charge un wisdom fftw</SHORT_DESCRIPTION>
+  <CALLING_SEQUENCE>
+    <CALLING_SEQUENCE_ITEM>set_fftw_wisdom(txt)</CALLING_SEQUENCE_ITEM>
+  </CALLING_SEQUENCE>
+  <PARAM>
+    <PARAM_INDENT>
+      <PARAM_ITEM>
+        <PARAM_NAME>txt</PARAM_NAME>
+        <PARAM_DESCRIPTION>
+          <SP>: Matrice de chaîne de caractères contenant le wisdom fftw.</SP>
+        </PARAM_DESCRIPTION>
+      </PARAM_ITEM>
+    </PARAM_INDENT>
+  </PARAM>
+  <DESCRIPTION>
+    <P>
+     Cette fonction charge un wisdom fftw contenue dans une chaîne de caractères.
+    </P>
+  </DESCRIPTION>
+  <EXAMPLE>
+<![CDATA[
+ //return fftw wisdom
+ txt=get_fftw_wisdom();
+ //set fftw wisdom
+ set_fftw_wisdom(txt);
+ //reset fftw wisdom
+ fftw_forget_wisdom();
+ ]]>
+  </EXAMPLE>
+  <SEE_ALSO>
+    <SEE_ALSO_ITEM>
+      <A href='fftw.htm'><VERB>fftw</VERB></A>
+      <A href='get_fftw_wisdom.htm'><VERB>get_fftw_wisdom</VERB></A>
+      <A href='fftw_forget_wisdom.htm'><VERB>fftw_forget_wisdom</VERB></A>
+    </SEE_ALSO_ITEM>
+  </SEE_ALSO>
+</MAN>