← Back to branch summary

~ubuntu-branches/ubuntu/raring/scilab/raring-proposed

« back to all changes in this revision

Viewing changes to modules/simulated_annealing/help/en_US/utilities/neigh_func_fsa.xml

  • Committer: Package Import Robot
  • Author(s): Sylvestre Ledru
  • Date: 2012-08-30 14:42:38 UTC
  • mfrom: (1.4.7)
  • Revision ID: package-import@ubuntu.com-20120830144238-c1y2og7dbm7m9nig
Tags: 5.4.0-beta-3-1~exp1
* New upstream release
* Update the scirenderer dep
* Get ride of libjhdf5-java dependency

Show diffs side-by-side

added added

removed removed

Lines of Context:
modules/simulated_annealing/help/en_US/utilities/neigh_func_fsa.xml
11
11
 *
12
12
 -->
13
13
<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" version="5.0-subset Scilab" xml:id="neigh_func_fsa" xml:lang="en">
14
 
  <refnamediv>
15
 
    <refname>neigh_func_fsa</refname>
16
 
    <refpurpose>The Fast Simulated Annealing neghborhood
17
 
      relationship
18
 
    </refpurpose>
19
 
  </refnamediv>
20
 
  <refsynopsisdiv>
21
 
    <title>Calling Sequence</title>
22
 
    <synopsis>x_neigh = neigh_func_fsa(x_current,T,param)</synopsis>
23
 
  </refsynopsisdiv>
24
 
  <refsection>
25
 
    <title>Arguments</title>
26
 
    <variablelist>
27
 
      <varlistentry>
28
 
        <term>x_current</term>
29
 
        <listitem>
30
 
          <para>the point for which we want to compute a neighbor</para>
31
 
        </listitem>
32
 
      </varlistentry>
33
 
      <varlistentry>
34
 
        <term>T</term>
35
 
        <listitem>
36
 
          <para>the current temperature</para>
37
 
        </listitem>
38
 
      </varlistentry>
39
 
      <varlistentry>
40
 
        <term>param</term>
41
 
        <listitem>
42
 
          <para>a vector with the same size than x_current. A normalisation
43
 
            vector which allows to distort the shape of the neighborhood. This
44
 
            parameter allows to take into account the differences of interval of
45
 
            variation between variables. By default, this parameter is set to a
46
 
            vector of ones.
47
 
          </para>
48
 
        </listitem>
49
 
      </varlistentry>
50
 
      <varlistentry>
51
 
        <term>x_neigh</term>
52
 
        <listitem>
53
 
          <para>the computed neighbor</para>
54
 
        </listitem>
55
 
      </varlistentry>
56
 
    </variablelist>
57
 
  </refsection>
58
 
  <refsection>
59
 
    <title>Description</title>
60
 
    <itemizedlist>
61
 
      <listitem>
62
 
        <para>This function computes the FSA neighborhood of a given point.
63
 
          The corresponding distribution is a Cauchy distribution which is more
64
 
          and more peaked as the temperature decrease.
65
 
        </para>
66
 
      </listitem>
67
 
    </itemizedlist>
68
 
  </refsection>
69
 
  <refsection role="see also">
70
 
    <title>See Also</title>
71
 
    <simplelist type="inline">
72
 
      <member>
73
 
        <link linkend="optim_sa"> optim_sa </link>
74
 
      </member>
75
 
      <member>
76
 
        <link linkend="temp_law_fsa"> temp_law_fsa </link>
77
 
      </member>
78
 
      <member>
79
 
        <link linkend="neigh_func_default"> neigh_func_default
80
 
        </link>
81
 
      </member>
82
 
    </simplelist>
83
 
  </refsection>
 
14
    <refnamediv>
 
15
        <refname>neigh_func_fsa</refname>
 
16
        <refpurpose>The Fast Simulated Annealing neghborhood
 
17
            relationship
 
18
        </refpurpose>
 
19
    </refnamediv>
 
20
    <refsynopsisdiv>
 
21
        <title>Calling Sequence</title>
 
22
        <synopsis>x_neigh = neigh_func_fsa(x_current,T,param)</synopsis>
 
23
    </refsynopsisdiv>
 
24
    <refsection>
 
25
        <title>Arguments</title>
 
26
        <variablelist>
 
27
            <varlistentry>
 
28
                <term>x_current</term>
 
29
                <listitem>
 
30
                    <para>the point for which we want to compute a neighbor</para>
 
31
                </listitem>
 
32
            </varlistentry>
 
33
            <varlistentry>
 
34
                <term>T</term>
 
35
                <listitem>
 
36
                    <para>the current temperature</para>
 
37
                </listitem>
 
38
            </varlistentry>
 
39
            <varlistentry>
 
40
                <term>param</term>
 
41
                <listitem>
 
42
                    <para>a vector with the same size than x_current. A normalisation
 
43
                        vector which allows to distort the shape of the neighborhood. This
 
44
                        parameter allows to take into account the differences of interval of
 
45
                        variation between variables. By default, this parameter is set to a
 
46
                        vector of ones.
 
47
                    </para>
 
48
                </listitem>
 
49
            </varlistentry>
 
50
            <varlistentry>
 
51
                <term>x_neigh</term>
 
52
                <listitem>
 
53
                    <para>the computed neighbor</para>
 
54
                </listitem>
 
55
            </varlistentry>
 
56
        </variablelist>
 
57
    </refsection>
 
58
    <refsection>
 
59
        <title>Description</title>
 
60
        <itemizedlist>
 
61
            <listitem>
 
62
                <para>This function computes the FSA neighborhood of a given point.
 
63
                    The corresponding distribution is a Cauchy distribution which is more
 
64
                    and more peaked as the temperature decrease.
 
65
                </para>
 
66
            </listitem>
 
67
        </itemizedlist>
 
68
    </refsection>
 
69
    <refsection role="see also">
 
70
        <title>See Also</title>
 
71
        <simplelist type="inline">
 
72
            <member>
 
73
                <link linkend="optim_sa"> optim_sa </link>
 
74
            </member>
 
75
            <member>
 
76
                <link linkend="temp_law_fsa"> temp_law_fsa </link>
 
77
            </member>
 
78
            <member>
 
79
                <link linkend="neigh_func_default"> neigh_func_default
 
80
                </link>
 
81
            </member>
 
82
        </simplelist>
 
83
    </refsection>
84
84
</refentry>