source: general/genlib/fftw.xml@ 7b20b74

<?xml version="1.0" encoding="ISO-8859-1"?>
<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
   "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
  <!ENTITY % general-entities SYSTEM "../../general.ent">
  %general-entities;

  <!ENTITY fftw-download-http "http://www.fftw.org/fftw-&fftw-version;.tar.gz">
  <!ENTITY fftw-download-ftp  "ftp://ftp.fftw.org/pub/fftw/fftw-&fftw-version;.tar.gz ">
  <!ENTITY fftw-md5sum        "8aac833c943d8e90d51b697b27d4384d">
  <!ENTITY fftw-size          "3.9 MB">
  <!ENTITY fftw-buildsize     "57 MB (add 1 MB for tests)">
  <!ENTITY fftw-time          "0.3 SBU (using parallelism=4; add 1.9 SBU for tests)">
]>

<sect1 id="fftw" xreflabel="fftw-&fftw-version;">
  <?dbhtml filename="fftw.html"?>

  <sect1info>
    <othername>$LastChangedBy$</othername>
    <date>$Date$</date>
  </sect1info>

  <title>fftw-&fftw-version;</title>

  <indexterm zone="fftw">
    <primary sortas="a-fftw">fftw</primary>
  </indexterm>

  <sect2 role="package">
    <title>Introduction to fftw</title>

    <para>
      FFTW is a C subroutine library for computing the discrete Fourier
      transform (DFT) in one or more dimensions, of arbitrary input size, and
      of both real and complex data (as well as of even/odd data, i.e. the
      discrete cosine/sine transforms or DCT/DST).
    </para>

    &lfs84_checked;

    <bridgehead renderas="sect3">Package Information</bridgehead>
    <itemizedlist spacing="compact">
      <listitem>
        <para>
          Download (HTTP): <ulink url="&fftw-download-http;"/>
        </para>
      </listitem>
      <listitem>
        <para>
          Download (FTP): <ulink url="&fftw-download-ftp;"/>
        </para>
      </listitem>
      <listitem>
        <para>
          Download MD5 sum: &fftw-md5sum;
        </para>
      </listitem>
      <listitem>
        <para>
          Download size: &fftw-size;
        </para>
      </listitem>
      <listitem>
        <para>
          Estimated disk space required: &fftw-buildsize;
        </para>
      </listitem>
      <listitem>
        <para>
          Estimated build time: &fftw-time;
        </para>
      </listitem>
    </itemizedlist>

    <para condition="html" role="usernotes">
      User Notes: <ulink url="&blfs-wiki;/fftw"/>
    </para>

  </sect2>

  <sect2 role="installation">
    <title>Installation of fftw</title>

    <para>
      Install <application>fftw</application> by running the following commands:
    </para>

<screen><userinput>./configure --prefix=/usr  --enable-shared --enable-threads &amp;&amp;
make</userinput></screen>

    <para>To test the results, issue: <command>make check</command>.
    On 32-bit systems, the tests can take substantially longer than
    they would on 64-bit machines.</para>

    <para>
      Now, as the <systemitem class="username">root</systemitem> user:
    </para>

<screen role="root"><userinput>make install</userinput></screen>
  </sect2>

  <sect2 role="commands">
    <title>Command Explanations</title>

      <para>
        <command>--enable-shared --disable-static</command>: Use shared libs
        instead of static libs.
      </para>

      <para>
        <command>--enable-threads</command>: This enables <filename
        class="libraryfile"> libfftw3_threads.so</filename> to be compiled.
        It is used by e.g. the <application>gimp</application> plugin from
        <ulink url="http://gmic.eu/">G'MIC</ulink>.
      </para>

      <para>
        <option>--enable-float</option>: This enables floating point, and
        will cause the library to be called <filename
        class="libraryfile">libfftw3f.so</filename> (needed by <ulink
        url="http://www.rawtherapee.com/">RawTherapee</ulink> (and similarly
        for the threaded library if that is built (not needed by RawTherapee).
        These versions are not usable by packages in this book which use <filename
        class="libraryfile">libfftw3</filename> so if you need both you will
        need to build <application>fftw</application> twice.
      </para>

  </sect2>

  <sect2 role="content">
    <title>Contents</title>

    <segmentedlist>
      <segtitle>Installed Programs</segtitle>
      <segtitle>Installed Library</segtitle>
      <segtitle>Installed Directories</segtitle>

      <seglistitem>
        <seg>
          fftw-wisdom and fftw-wisdom-to-conf
        </seg>
        <seg>
          libfftw3.so and libfftw3_threads.so, or libfftw3f.so and
          libfftw3f_threads.so
        </seg>
        <seg>
          None
        </seg>
      </seglistitem>
    </segmentedlist>

    <variablelist>
      <bridgehead renderas="sect3">Short Descriptions</bridgehead>
      <?dbfo list-presentation="list"?>
      <?dbhtml list-presentation="table"?>

      <varlistentry id="fftw-wisdom">
        <term><command>fftw-wisdom</command></term>
        <listitem>
          <para>
            is a utility to generate FFTW wisdom files, which contain saved
            information about how to optimally compute (Fourier) transforms  of
            various sizes.
          </para>
          <indexterm zone="fftw fftw-wisdom">
            <primary sortas="b-fftw-wisdom">fftw-wisdom</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="fftw-wisdom-to-conf">
        <term><command>fftw-wisdom-to-conf</command></term>
        <listitem>
          <para>
            is a utility to generate C configuration routines from FFTW wisdom
            files, where the latter contain saved information about  how  to
            optimally  compute  (Fourier)  transforms of various sizes.
          </para>
          <indexterm zone="fftw fftw-wisdom-to-conf">
            <primary sortas="b-fftw-wisdom-to-conf">fftw-wisdom-to-conf</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="libfftw3">
        <term><filename class="libraryfile">libfftw3.so</filename></term>
        <listitem>
          <para>
            is the Fast Fourier Transform library
          </para>
          <indexterm zone="fftw libfftw3">
            <primary sortas="c-libfftw3">libfftw3.so</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="libfftw3_threads">
        <term><filename class="libraryfile">libfftw3_threads.so</filename></term>
        <listitem>
          <para>
            is the threaded Fast Fourier Transform library
          </para>
          <indexterm zone="fftw libfftw3_threads">
            <primary sortas="c-libfftw3_threads">libfftw3_threads.so</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="libfftw3f">
        <term><filename class="libraryfile">libfftw3f.so</filename></term>
        <listitem>
          <para>
            is the floating-point Fast Fourier Transform library
          </para>
          <indexterm zone="fftw libfftw3f">
            <primary sortas="c-libfftw3f">libfftw3f.so</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="libfftw3f_threads">
        <term><filename class="libraryfile">libfftw3f_threads.so</filename></term>
        <listitem>
          <para>
            is the threaded floating-point Fast Fourier Transform library
          </para>
          <indexterm zone="fftw libfftw3f_threads">
            <primary sortas="c-libfftw3f_threads">libfftw3f_threads.so</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>