c30ecb4c40cc03674f29c4c20f0ed88b708aaf4f
[scilab.git] / scilab / modules / simulated_annealing / help / en_US / utilities / neigh_func_vfsa.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_vfsa" xml:lang="en">
14     <refnamediv>
15         <refname>neigh_func_vfsa</refname>
16         <refpurpose>The Very Fast Simulated Annealing neighborhood
17             relationship
18         </refpurpose>
19     </refnamediv>
20     <refsynopsisdiv>
21         <title>Calling Sequence</title>
22         <synopsis>x_neigh = neigh_func_vfsa(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 ones column vector. The column correspond to the amplitude
43                         of variation of the neighborhood. By default, the column is a column
44                         of 0.1.
45                     </para>
46                 </listitem>
47             </varlistentry>
48             <varlistentry>
49                 <term>x_neigh</term>
50                 <listitem>
51                     <para>the computed neighbor</para>
52                 </listitem>
53             </varlistentry>
54         </variablelist>
55     </refsection>
56     <refsection>
57         <title>Description</title>
58         <itemizedlist>
59             <listitem>
60                 <para>This function implements the Very Fast Simulated Annealing
61                     relationship. This distribution is more and more peaked as the
62                     temperature decrease.
63                 </para>
64             </listitem>
65         </itemizedlist>
66     </refsection>
67     <refsection role="see also">
68         <title>See Also</title>
69         <simplelist type="inline">
70             <member>
71                 <link linkend="optim_sa"> optim_sa </link>
72             </member>
73             <member>
74                 <link linkend="neigh_func_vfsa"> neigh_func_vfsa
75                 </link>
76             </member>
77             <member>
78                 <link linkend="temp_law_huang"> temp_law_huang </link>
79             </member>
80         </simplelist>
81     </refsection>
82 </refentry>