← 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/temp_law_vfsa.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/temp_law_vfsa.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="temp_law_vfsa" xml:lang="en">
15
 
  <refnamediv>
16
 
    <refname>temp_law_vfsa</refname>
17
 
    <refpurpose>This function implements the Very Fast Simulated Annealing
18
 
      from L. Ingber
19
 
    </refpurpose>
20
 
  </refnamediv>
21
 
  <refsynopsisdiv>
22
 
    <title>Calling Sequence</title>
23
 
    <synopsis>T_out = temp_law_vfsa(T_in,step_mean,step_var,temp_stage,n, param)</synopsis>
24
 
  </refsynopsisdiv>
25
 
  <refsection>
26
 
    <title>Arguments</title>
27
 
    <variablelist>
28
 
      <varlistentry>
29
 
        <term>T_in</term>
30
 
        <listitem>
31
 
          <para>the temperature at the current stage</para>
32
 
        </listitem>
33
 
      </varlistentry>
34
 
      <varlistentry>
35
 
        <term>step_mean</term>
36
 
        <listitem>
37
 
          <para>the mean value of the objective function computed during the
38
 
            current stage
39
 
          </para>
40
 
        </listitem>
41
 
      </varlistentry>
42
 
      <varlistentry>
43
 
        <term>step_var</term>
44
 
        <listitem>
45
 
          <para>the variance value of the objective function computed during
46
 
            the current stage
47
 
          </para>
48
 
        </listitem>
49
 
      </varlistentry>
50
 
      <varlistentry>
51
 
        <term>temp_stage</term>
52
 
        <listitem>
53
 
          <para>the index of the current temperature stage</para>
54
 
        </listitem>
55
 
      </varlistentry>
56
 
      <varlistentry>
57
 
        <term>n</term>
58
 
        <listitem>
59
 
          <para>the dimension of the decision variable (the x in f(x))</para>
60
 
        </listitem>
61
 
      </varlistentry>
62
 
      <varlistentry>
63
 
        <term>param</term>
64
 
        <listitem>
65
 
          <para>a float: the 'c' parameter of the VFSA method (0.01 by
66
 
            default)
67
 
          </para>
68
 
        </listitem>
69
 
      </varlistentry>
70
 
      <varlistentry>
71
 
        <term>T_out</term>
72
 
        <listitem>
73
 
          <para>the temperature for the temperature stage to come</para>
74
 
        </listitem>
75
 
      </varlistentry>
76
 
    </variablelist>
77
 
  </refsection>
78
 
  <refsection>
79
 
    <title>Description</title>
80
 
    <para>This function implements the Very Fast Simulated Annealing from
81
 
      L. Ingber.
82
 
    </para>
83
 
  </refsection>
84
 
  <refsection>
85
 
    <title>Examples</title>
86
 
    <programlisting role="example"><![CDATA[ 
 
15
    <refnamediv>
 
16
        <refname>temp_law_vfsa</refname>
 
17
        <refpurpose>This function implements the Very Fast Simulated Annealing
 
18
            from L. Ingber
 
19
        </refpurpose>
 
20
    </refnamediv>
 
21
    <refsynopsisdiv>
 
22
        <title>Calling Sequence</title>
 
23
        <synopsis>T_out = temp_law_vfsa(T_in,step_mean,step_var,temp_stage,n, param)</synopsis>
 
24
    </refsynopsisdiv>
 
25
    <refsection>
 
26
        <title>Arguments</title>
 
27
        <variablelist>
 
28
            <varlistentry>
 
29
                <term>T_in</term>
 
30
                <listitem>
 
31
                    <para>the temperature at the current stage</para>
 
32
                </listitem>
 
33
            </varlistentry>
 
34
            <varlistentry>
 
35
                <term>step_mean</term>
 
36
                <listitem>
 
37
                    <para>the mean value of the objective function computed during the
 
38
                        current stage
 
39
                    </para>
 
40
                </listitem>
 
41
            </varlistentry>
 
42
            <varlistentry>
 
43
                <term>step_var</term>
 
44
                <listitem>
 
45
                    <para>the variance value of the objective function computed during
 
46
                        the current stage
 
47
                    </para>
 
48
                </listitem>
 
49
            </varlistentry>
 
50
            <varlistentry>
 
51
                <term>temp_stage</term>
 
52
                <listitem>
 
53
                    <para>the index of the current temperature stage</para>
 
54
                </listitem>
 
55
            </varlistentry>
 
56
            <varlistentry>
 
57
                <term>n</term>
 
58
                <listitem>
 
59
                    <para>the dimension of the decision variable (the x in f(x))</para>
 
60
                </listitem>
 
61
            </varlistentry>
 
62
            <varlistentry>
 
63
                <term>param</term>
 
64
                <listitem>
 
65
                    <para>a float: the 'c' parameter of the VFSA method (0.01 by
 
66
                        default)
 
67
                    </para>
 
68
                </listitem>
 
69
            </varlistentry>
 
70
            <varlistentry>
 
71
                <term>T_out</term>
 
72
                <listitem>
 
73
                    <para>the temperature for the temperature stage to come</para>
 
74
                </listitem>
 
75
            </varlistentry>
 
76
        </variablelist>
 
77
    </refsection>
 
78
    <refsection>
 
79
        <title>Description</title>
 
80
        <para>This function implements the Very Fast Simulated Annealing from
 
81
            L. Ingber.
 
82
        </para>
 
83
    </refsection>
 
84
    <refsection>
 
85
        <title>Examples</title>
 
86
        <programlisting role="example"><![CDATA[ 
87
87
function y = rastrigin(x)
88
88
  y = x(1)^2+x(2)^2-cos(12*x(1))-cos(18*x(2));
89
89
endfunction
115
115
xtitle('Temperature evolution','Iteration','Temperature');
116
116
plot(t,temp_list,'k-');
117
117
 ]]></programlisting>
118
 
  </refsection>
119
 
  <refsection role="see also">
120
 
    <title>See Also</title>
121
 
    <simplelist type="inline">
122
 
      <member>
123
 
        <link linkend="optim_sa"> optim_sa </link>
124
 
      </member>
125
 
      <member>
126
 
        <link linkend="neigh_func_vfsa"> neigh_func_vfsa
127
 
        </link>
128
 
      </member>
129
 
      <member>
130
 
        <link linkend="temp_law_huang"> temp_law_huang </link>
131
 
      </member>
132
 
    </simplelist>
133
 
  </refsection>
 
118
    </refsection>
 
119
    <refsection role="see also">
 
120
        <title>See Also</title>
 
121
        <simplelist type="inline">
 
122
            <member>
 
123
                <link linkend="optim_sa"> optim_sa </link>
 
124
            </member>
 
125
            <member>
 
126
                <link linkend="neigh_func_vfsa"> neigh_func_vfsa
 
127
                </link>
 
128
            </member>
 
129
            <member>
 
130
                <link linkend="temp_law_huang"> temp_law_huang </link>
 
131
            </member>
 
132
        </simplelist>
 
133
    </refsection>
134
134
</refentry>