Examples for simulated annealing functions added and/or improved
[scilab.git] / scilab / modules / simulated_annealing / help / en_US / utilities / neigh_func_csa.xml
1 <?xml version="1.0" encoding="UTF-8"?>
2 <!--
3  * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
4  * Copyright (C) 2008 - Yann COLLETTE <yann.collette@renault.com>
5  *
6  * This file must be used under the terms of the CeCILL.
7  * This source file is licensed as described in the file COPYING, which
8  * you should have received as part of this distribution.  The terms
9  * are also available at
10  * http://www.cecill.info/licences/Licence_CeCILL_V2-en.txt
11  *
12  -->
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" xmlns:scilab="http://www.scilab.org" xml:id="neigh_func_csa" xml:lang="en">
14     <refnamediv>
15         <refname>neigh_func_csa</refname>
16         <refpurpose>The classical neighborhood relationship for the simulated
17             annealing
18         </refpurpose>
19     </refnamediv>
20     <refsynopsisdiv>
21         <title>Calling Sequence</title>
22         <synopsis>x_neigh = neigh_func_csa(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 implements the classical neighborhood relationship
63                     for the simulated annealing. The neighbors distribution is a gaussian
64                     distribution which is more and more peaked as the temperature
65                     decrease.
66                 </para>
67             </listitem>
68         </itemizedlist>
69     </refsection>
70
71     <refsection>
72         <title>Examples</title>
73         <programlisting role="example"><![CDATA[
74 x_current = 1;
75
76 x_neigh = neigh_func_csa(x_current,10,[])
77  ]]></programlisting>
78     </refsection>
79
80     <refsection role="see also">
81         <title>See Also</title>
82         <simplelist type="inline">
83             <member>
84                 <link linkend="neigh_func_default"> neigh_func_default
85                 </link>
86             </member>
87             <member>
88                 <link linkend="temp_law_huang"> temp_law_huang </link>
89             </member>
90             <member>
91                 <link linkend="optim_sa"> optim_sa </link>
92             </member>
93         </simplelist>
94     </refsection>
95 </refentry>