<?xml version="1.0" encoding="UTF-8"?>
<!--
 * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
 * Copyright (C) 2007 - INRIA
 *
 * Copyright (C) 2012 - 2016 - Scilab Enterprises
 *
 * This file is hereby licensed under the terms of the GNU GPL v2.0,
 * pursuant to article 5.3.4 of the CeCILL v.2.1.
 * This file was originally licensed under the terms of the CeCILL v2.1,
 * and continues to be available under such terms.
 * For more information, see the COPYING file which you should have received
 * along with this program.
 *
 -->
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns4="http://www.w3.org/1999/xhtml" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:id="fftw_flags" xml:lang="ru">
    <refnamediv>
        <refname>fftw_flags</refname>
        <refpurpose>устанавливают метод вычисления быстрого преобразования Фурье функции fftw
        </refpurpose>
    </refnamediv>
    <refsynopsisdiv>
        <title>Синтаксис</title>
        <synopsis>[a,[S]]=fftw_flags([x1;x2;...])</synopsis>
    </refsynopsisdiv>
    <refsection>
        <title>Аргументы</title>
        <variablelist>
            <varlistentry>
                <term>[x1;x2;...]</term>
                <listitem>
                    <para>Матрица строк или целых чисел. Запись для переключения метода вычисления БПФ для fftw.</para>
                </listitem>
            </varlistentry>
            <varlistentry>
                <term>a</term>
                <listitem>
                    <para>Целое число. Даёт текущее значение флага функции fftw
                    </para>
                </listitem>
            </varlistentry>
            <varlistentry>
                <term>S</term>
                <listitem>
                    <para>Матрица строковых значений. Даёт строковое значение флага fftw.</para>
                </listitem>
            </varlistentry>
        </variablelist>
    </refsection>
    <refsection>
        <title>Описание</title>
        <para>
            Эта функция позволяет изменять параметры <literal>беззнаковых
                флагов
            </literal>
            функции
            <literal>fftw_plan_guru_split_dft</literal>, которая используется в функции <link linkend="fftw">fftw</link>.
        </para>
        <para>Значение по умолчанию FFTW_ESTIMATE</para>
        <para>Принимаемые элементы:</para>
        <itemizedlist>
            <listitem>
                <para>FFTW_MEASURE или 0</para>
            </listitem>
            <listitem>
                <para>FFTW_DESTROY_INPUT или 1</para>
            </listitem>
            <listitem>
                <para>FFTW_UNALIGNED или 2</para>
            </listitem>
            <listitem>
                <para>FFTW_CONSERVE_MEMORY или 4</para>
            </listitem>
            <listitem>
                <para>FFTW_EXHAUSTIVE или 8</para>
            </listitem>
            <listitem>
                <para>FFTW_PRESERVE_INPUT или 16</para>
            </listitem>
            <listitem>
                <para>FFTW_PATIENT или 32</para>
            </listitem>
            <listitem>
                <para>FFTW_ESTIMATE или 64</para>
            </listitem>
            <listitem>
                <para>FFTW_ESTIMATE_PATIENT или 128</para>
            </listitem>
            <listitem>
                <para>FFTW_BELIEVE_PCOST иил 256</para>
            </listitem>
            <listitem>
                <para>FFTW_NO_DFT_R2HC или 512</para>
            </listitem>
            <listitem>
                <para>FFTW_NO_NONTHREADED или 1024</para>
            </listitem>
            <listitem>
                <para>FFTW_NO_BUFFERING или 2048</para>
            </listitem>
            <listitem>
                <para>FFTW_NO_INDIRECT_OP или 4096</para>
            </listitem>
            <listitem>
                <para>FFTW_ALLOW_LARGE_GENERIC или 8192</para>
            </listitem>
            <listitem>
                <para>FFTW_NO_RANK_SPLITS или 16384</para>
            </listitem>
            <listitem>
                <para>FFTW_NO_VRANK_SPLITS или 32768</para>
            </listitem>
            <listitem>
                <para>FFTW_NO_VRECURSE или 65536</para>
            </listitem>
            <listitem>
                <para>FFTW_NO_SIMD или 131072</para>
            </listitem>
            <listitem>
                <para>FFTW_NO_SLOW или 262144</para>
            </listitem>
            <listitem>
                <para>FFTW_NO_FIXED_RADIX_LARGE_N или 524288</para>
            </listitem>
            <listitem>
                <para>FFTW_ALLOW_PRUNING или 1048576</para>
            </listitem>
        </itemizedlist>
        <para>Rmk : при использовании FFTW_MEASURE/FFTW_PATIENT/FFTW_EXHAUSTIVE вы должны
            дважды вызвать fftw. (Первый вызов для инициализации, второй и последующие вызовы для вычисления)
        </para>
    </refsection>
    <refsection>
        <title>Примеры</title>
        <programlisting role="example"><![CDATA[
//возврат целого значения флага
fftw_flags()

//смена флагов
fftw_flags(["FFTW_MEASURE";"FFTW_CONSERVE_MEMORY"]);

//смена флагов и распечатка текущего значения флагов fftw (как целочисленные значения, так и строки)
[a,S]=fftw_flags("FFTW_PATIENT")
 ]]></programlisting>
    </refsection>
    <refsection role="see also">
        <title>Смотрите также</title>
        <simplelist type="inline">
            <member>
                <link linkend="fftw">fftw</link>
            </member>
        </simplelist>
    </refsection>
</refentry>
