← Back to branch summary

~ubuntu-branches/ubuntu/trusty/scilab/trusty

« back to all changes in this revision

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

  • Committer: Package Import Robot
  • Author(s): Sylvestre Ledru
  • Date: 2012-08-02 11:02:49 UTC
  • mfrom: (1.4.6)
  • Revision ID: package-import@ubuntu.com-20120802110249-0v5953emkp25geuz
Tags: 5.4.0-beta-2-1~exp1
* New upstream release
* Remove libscilab-java (remove upstream). Use libscilab2-java instead.

Show diffs side-by-side

added added

removed removed

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