Fix bad syntax
[scilab.git] / scilab / modules / fftw / help / en_US / fftw_flags.xml
1 <?xml version="1.0" encoding="ISO-8859-1" standalone="no"?>
2 <!DOCTYPE MAN SYSTEM "../../../../modules/helptools/help.dtd">
3 <MAN>
4   <LANGUAGE>eng</LANGUAGE>
5   <TITLE>fftw_flags</TITLE>
6   <TYPE>Scilab Function</TYPE>
7   <DATE>October 2006</DATE>
8   <SHORT_DESCRIPTION name="fftw_flags"> set computation method of fast fourier transform of the fftw function</SHORT_DESCRIPTION>
9   <CALLING_SEQUENCE>
10     <CALLING_SEQUENCE_ITEM>[a,[S]]=fftw_flags([x1;x2;...])</CALLING_SEQUENCE_ITEM>
11   </CALLING_SEQUENCE>
12   <PARAM>
13     <PARAM_INDENT>
14       <PARAM_ITEM>
15         <PARAM_NAME>[x1;x2;...]</PARAM_NAME>
16         <PARAM_DESCRIPTION>
17           <SP>: Matrix of string or integers. Entry to switch the method of fft computation for fftw.</SP>
18         </PARAM_DESCRIPTION>
19       </PARAM_ITEM>
20       <PARAM_ITEM>
21         <PARAM_NAME>a</PARAM_NAME>
22         <PARAM_DESCRIPTION>
23           <SP>: Integer. Give the current value of the flag of the fftw function.</SP>
24         </PARAM_DESCRIPTION>
25       </PARAM_ITEM>
26       <PARAM_ITEM>
27         <PARAM_NAME>S</PARAM_NAME>
28         <PARAM_DESCRIPTION>
29           <SP>: String matrix. Give the string value of the fftw flag.</SP>
30         </PARAM_DESCRIPTION>
31       </PARAM_ITEM>
32     </PARAM_INDENT>
33   </PARAM>
34   <DESCRIPTION>
35     <P>
36     This function enables the change of the <VERB>unsigned flags</VERB> parameter of the
37     <VERB>fftw_plan_guru_split_dft</VERB> function that is used in <A href='fftw.htm'><VERB>fftw</VERB></A> function. Default value is FFTW_ESTIMATE</P>
38     <P>Accepted entries are :</P>
39     <ITEMIZE>
40       <ITEM><SP>FFTW_MEASURE or 0</SP></ITEM>
41       <ITEM><SP>FFTW_DESTROY_INPUT or 1</SP></ITEM>
42       <ITEM><SP>FFTW_UNALIGNED or 2</SP></ITEM>
43       <ITEM><SP>FFTW_CONSERVE_MEMORY or 4</SP></ITEM>
44       <ITEM><SP>FFTW_EXHAUSTIVE or 8</SP></ITEM>
45       <ITEM><SP>FFTW_PRESERVE_INPUT or 16</SP></ITEM>
46       <ITEM><SP>FFTW_PATIENT or 32</SP></ITEM>
47       <ITEM><SP>FFTW_ESTIMATE or 64</SP></ITEM>
48       <ITEM><SP>FFTW_ESTIMATE_PATIENT or 128</SP></ITEM>
49       <ITEM><SP>FFTW_BELIEVE_PCOST or 256</SP></ITEM>
50       <ITEM><SP>FFTW_NO_DFT_R2HC or 512</SP></ITEM>
51       <ITEM><SP>FFTW_NO_NONTHREADED or 1024</SP></ITEM>
52       <ITEM><SP>FFTW_NO_BUFFERING or 2048</SP></ITEM>
53       <ITEM><SP>FFTW_NO_INDIRECT_OP or 4096</SP></ITEM>
54       <ITEM><SP>FFTW_ALLOW_LARGE_GENERIC or 8192</SP></ITEM>
55       <ITEM><SP>FFTW_NO_RANK_SPLITS or 16384</SP></ITEM>
56       <ITEM><SP>FFTW_NO_VRANK_SPLITS or 32768</SP></ITEM>
57       <ITEM><SP>FFTW_NO_VRECURSE or 65536</SP></ITEM>
58       <ITEM><SP>FFTW_NO_SIMD or 131072</SP></ITEM>
59       <ITEM><SP>FFTW_NO_SLOW or 262144</SP></ITEM>
60       <ITEM><SP>FFTW_NO_FIXED_RADIX_LARGE_N or 524288</SP></ITEM>
61       <ITEM><SP>FFTW_ALLOW_PRUNING or 1048576</SP></ITEM>
62     </ITEMIZE>
63     <P>
64      Rmk : when using FFTW_MEASURE/FFTW_PATIENT/FFTW_EXHAUSTIVE you must call two times fftw.
65      (first call for initialisation, second and others calls for computation)
66    </P>
67   </DESCRIPTION>
68   <EXAMPLE>
69 <![CDATA[
70  //return the integer value of the flag
71  fftw_flags()
72
73  //change flags
74  fftw_flags(["FFTW_MEASURE";"FFTW_CONSERVE_MEMORY"]);
75
76  //change flags and display current value of fftw flags (both integer and strings)
77  [a,S]=fftw_flags("FFTW_PATIENT")
78  ]]>
79   </EXAMPLE>
80   <SEE_ALSO>
81     <SEE_ALSO_ITEM><LINK>fftw</LINK></SEE_ALSO_ITEM>
82   </SEE_ALSO>
83 </MAN>