← 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/compute_initial_temp.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/compute_initial_temp.xml
12
12
 *
13
13
 -->
14
14
<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="compute_initial_temp" xml:lang="en">
15
 
  <refnamediv>
16
 
    <refname>compute_initial_temp</refname>
17
 
    <refpurpose>
18
 
      A SA function which allows to compute the initial temperature
19
 
      of the simulated annealing
20
 
    </refpurpose>
21
 
  </refnamediv>
22
 
  <refsynopsisdiv>
23
 
    <title>Calling Sequence</title>
24
 
    <synopsis>T_init = compute_initial_temp(x0,f,proba_init, ItMX [, param] )</synopsis>
25
 
  </refsynopsisdiv>
26
 
  <refsection>
27
 
    <title>Arguments</title>
28
 
    <variablelist>
29
 
      <varlistentry>
30
 
        <term>x0</term>
31
 
        <listitem>
32
 
          <para>the starting point</para>
33
 
        </listitem>
34
 
      </varlistentry>
35
 
      <varlistentry>
36
 
        <term>f</term>
37
 
        <listitem>
38
 
          <para>
39
 
            the objective function which will be send to the simulated
40
 
            annealing for optimization
41
 
          </para>
42
 
        </listitem>
43
 
      </varlistentry>
44
 
      <varlistentry>
45
 
        <term>proba_init</term>
46
 
        <listitem>
47
 
          <para>
48
 
            the initial probability of accepting a bad solution (usually
49
 
            around 0.7)
50
 
          </para>
51
 
        </listitem>
52
 
      </varlistentry>
53
 
      <varlistentry>
54
 
        <term>ItMX</term>
55
 
        <listitem>
56
 
          <para>
57
 
            the number of iterations of random walk (usually around
58
 
            100)
59
 
          </para>
60
 
        </listitem>
61
 
      </varlistentry>
62
 
      <varlistentry>
63
 
        <term>param</term>
64
 
        <listitem>
65
 
          <para>optional, a data structure managed with the parameters module.</para>
66
 
          <para>
67
 
            The <literal>optim_sa</literal> function is sensitive to the following fields.
68
 
          </para>
69
 
          <variablelist>
70
 
            <varlistentry>
71
 
              <term>"neigh_func"</term>
72
 
              <listitem>
73
 
                <para>
74
 
                  a function which computes a neighbor of a given point.
75
 
                  The default neighbourhood function is <literal>neigh_func_default</literal>.
76
 
                </para>
77
 
              </listitem>
78
 
            </varlistentry>
79
 
            <varlistentry>
80
 
              <term>"type_accept"</term>
81
 
              <listitem>
82
 
                <para>
83
 
                  the type of acceptation function.
84
 
                  If the type is equal to "sa", then the initial temperature
85
 
                  is computed from <literal>T_init = - f_sum ./ log(proba_init)</literal>.
86
 
                  If the type is equal to "vfsa", it is computed
87
 
                  from <literal>T_init = abs(f_sum / log(1/proba_init - 1))</literal>.
88
 
                </para>
89
 
              </listitem>
90
 
            </varlistentry>
91
 
          </variablelist>
92
 
        </listitem>
93
 
      </varlistentry>
94
 
      <varlistentry>
95
 
        <term>T_init</term>
96
 
        <listitem>
97
 
          <para>
98
 
            The initial temperature corresponding to the given probability
99
 
            of accepting a bad solution
100
 
          </para>
101
 
        </listitem>
102
 
      </varlistentry>
103
 
    </variablelist>
104
 
  </refsection>
105
 
  <refsection>
106
 
    <title>Description</title>
107
 
    <para>
108
 
      This function computes an initial temperature given an initial
109
 
      probability of accepting a bad solution. This computation is based on
110
 
      some iterations of random walk.
111
 
    </para>
112
 
  </refsection>
113
 
  <refsection>
114
 
    <title>Examples</title>
115
 
    <programlisting role="example"><![CDATA[ 
 
15
    <refnamediv>
 
16
        <refname>compute_initial_temp</refname>
 
17
        <refpurpose>
 
18
            A SA function which allows to compute the initial temperature
 
19
            of the simulated annealing
 
20
        </refpurpose>
 
21
    </refnamediv>
 
22
    <refsynopsisdiv>
 
23
        <title>Calling Sequence</title>
 
24
        <synopsis>T_init = compute_initial_temp(x0,f,proba_init, ItMX [, param] )</synopsis>
 
25
    </refsynopsisdiv>
 
26
    <refsection>
 
27
        <title>Arguments</title>
 
28
        <variablelist>
 
29
            <varlistentry>
 
30
                <term>x0</term>
 
31
                <listitem>
 
32
                    <para>the starting point</para>
 
33
                </listitem>
 
34
            </varlistentry>
 
35
            <varlistentry>
 
36
                <term>f</term>
 
37
                <listitem>
 
38
                    <para>
 
39
                        the objective function which will be send to the simulated
 
40
                        annealing for optimization
 
41
                    </para>
 
42
                </listitem>
 
43
            </varlistentry>
 
44
            <varlistentry>
 
45
                <term>proba_init</term>
 
46
                <listitem>
 
47
                    <para>
 
48
                        the initial probability of accepting a bad solution (usually
 
49
                        around 0.7)
 
50
                    </para>
 
51
                </listitem>
 
52
            </varlistentry>
 
53
            <varlistentry>
 
54
                <term>ItMX</term>
 
55
                <listitem>
 
56
                    <para>
 
57
                        the number of iterations of random walk (usually around
 
58
                        100)
 
59
                    </para>
 
60
                </listitem>
 
61
            </varlistentry>
 
62
            <varlistentry>
 
63
                <term>param</term>
 
64
                <listitem>
 
65
                    <para>optional, a data structure managed with the parameters module.</para>
 
66
                    <para>
 
67
                        The <literal>optim_sa</literal> function is sensitive to the following fields.
 
68
                    </para>
 
69
                    <variablelist>
 
70
                        <varlistentry>
 
71
                            <term>"neigh_func"</term>
 
72
                            <listitem>
 
73
                                <para>
 
74
                                    a function which computes a neighbor of a given point.
 
75
                                    The default neighbourhood function is <literal>neigh_func_default</literal>.
 
76
                                </para>
 
77
                            </listitem>
 
78
                        </varlistentry>
 
79
                        <varlistentry>
 
80
                            <term>"type_accept"</term>
 
81
                            <listitem>
 
82
                                <para>
 
83
                                    the type of acceptation function.
 
84
                                    If the type is equal to "sa", then the initial temperature
 
85
                                    is computed from <literal>T_init = - f_sum ./ log(proba_init)</literal>.
 
86
                                    If the type is equal to "vfsa", it is computed
 
87
                                    from <literal>T_init = abs(f_sum / log(1/proba_init - 1))</literal>.
 
88
                                </para>
 
89
                            </listitem>
 
90
                        </varlistentry>
 
91
                    </variablelist>
 
92
                </listitem>
 
93
            </varlistentry>
 
94
            <varlistentry>
 
95
                <term>T_init</term>
 
96
                <listitem>
 
97
                    <para>
 
98
                        The initial temperature corresponding to the given probability
 
99
                        of accepting a bad solution
 
100
                    </para>
 
101
                </listitem>
 
102
            </varlistentry>
 
103
        </variablelist>
 
104
    </refsection>
 
105
    <refsection>
 
106
        <title>Description</title>
 
107
        <para>
 
108
            This function computes an initial temperature given an initial
 
109
            probability of accepting a bad solution. This computation is based on
 
110
            some iterations of random walk.
 
111
        </para>
 
112
    </refsection>
 
113
    <refsection>
 
114
        <title>Examples</title>
 
115
        <programlisting role="example"><![CDATA[ 
116
116
deff('y=f(x)','y=sum(x.^2)');
117
117
    
118
118
x0 = [2 2];
125
125
 
126
126
T0 = compute_initial_temp(x0, rastrigin, Proba_start, It_Pre, saparams);
127
127
 ]]></programlisting>
128
 
  </refsection>
129
 
  <refsection role="see also">
130
 
    <title>See Also</title>
131
 
    <simplelist type="inline">
132
 
      <member>
133
 
        <link linkend="optim_sa"> optim_sa </link>
134
 
      </member>
135
 
      <member>
136
 
        <link linkend="neigh_func_default">
137
 
          neigh_func_default
138
 
        </link>
139
 
      </member>
140
 
      <member>
141
 
        <link linkend="temp_law_default">
142
 
          temp_law_default
143
 
        </link>
144
 
      </member>
145
 
    </simplelist>
146
 
  </refsection>
 
128
    </refsection>
 
129
    <refsection role="see also">
 
130
        <title>See Also</title>
 
131
        <simplelist type="inline">
 
132
            <member>
 
133
                <link linkend="optim_sa"> optim_sa </link>
 
134
            </member>
 
135
            <member>
 
136
                <link linkend="neigh_func_default">
 
137
                    neigh_func_default
 
138
                </link>
 
139
            </member>
 
140
            <member>
 
141
                <link linkend="temp_law_default">
 
142
                    temp_law_default
 
143
                </link>
 
144
            </member>
 
145
        </simplelist>
 
146
    </refsection>
147
147
</refentry>