← Back to branch summary

~ubuntu-branches/ubuntu/raring/scilab/raring-proposed

« back to all changes in this revision

Viewing changes to modules/genetic_algorithms/help/en_US/utilities/init_ga_default.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/genetic_algorithms/help/en_US/utilities/init_ga_default.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:ns3="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="init_ga_default" xml:lang="en">
15
 
  <refnamediv>
16
 
    <refname>init_ga_default</refname>
17
 
    <refpurpose>A function a initialize a population</refpurpose>
18
 
  </refnamediv>
19
 
  <refsynopsisdiv>
20
 
    <title>Calling Sequence</title>
21
 
    <synopsis>Pop_init = init_ga_default(popsize,param)</synopsis>
22
 
  </refsynopsisdiv>
23
 
  <refsection>
24
 
    <title>Arguments</title>
25
 
    <variablelist>
26
 
      <varlistentry>
27
 
        <term>popsize</term>
28
 
        <listitem>
29
 
          <para>the number of individuals to generate.</para>
30
 
        </listitem>
31
 
      </varlistentry>
32
 
      <varlistentry>
33
 
        <term>param</term>
34
 
        <listitem>
35
 
          <para>a list of parameters. </para>
36
 
          <itemizedlist>
37
 
            <listitem>
38
 
              <para> "dimension": the size of the vector X. Default dimension=2. </para>
39
 
            </listitem>
40
 
            <listitem>
41
 
              <para> "minbound": a vector of minimum bounds for the variable
42
 
                X. Default minbound = -2*ones(1,dimension). 
43
 
              </para>
44
 
            </listitem>
45
 
            <listitem>
46
 
              <para> "maxbound": a vector of maximum bounds for the variable
47
 
                X. Default maxbound=2*ones(1,dimension).
48
 
              </para>
49
 
            </listitem>
50
 
          </itemizedlist>
51
 
        </listitem>
52
 
      </varlistentry>
53
 
      <varlistentry>
54
 
        <term>Pop_init</term>
55
 
        <listitem>
56
 
          <para>a list which contains the initial population of
 
15
    <refnamediv>
 
16
        <refname>init_ga_default</refname>
 
17
        <refpurpose>A function a initialize a population</refpurpose>
 
18
    </refnamediv>
 
19
    <refsynopsisdiv>
 
20
        <title>Calling Sequence</title>
 
21
        <synopsis>Pop_init = init_ga_default(popsize,param)</synopsis>
 
22
    </refsynopsisdiv>
 
23
    <refsection>
 
24
        <title>Arguments</title>
 
25
        <variablelist>
 
26
            <varlistentry>
 
27
                <term>popsize</term>
 
28
                <listitem>
 
29
                    <para>the number of individuals to generate.</para>
 
30
                </listitem>
 
31
            </varlistentry>
 
32
            <varlistentry>
 
33
                <term>param</term>
 
34
                <listitem>
 
35
                    <para>a list of parameters. </para>
 
36
                    <itemizedlist>
 
37
                        <listitem>
 
38
                            <para> "dimension": the size of the vector X. Default dimension=2. </para>
 
39
                        </listitem>
 
40
                        <listitem>
 
41
                            <para> "minbound": a vector of minimum bounds for the variable
 
42
                                X. Default minbound = -2*ones(1,dimension). 
 
43
                            </para>
 
44
                        </listitem>
 
45
                        <listitem>
 
46
                            <para> "maxbound": a vector of maximum bounds for the variable
 
47
                                X. Default maxbound=2*ones(1,dimension).
 
48
                            </para>
 
49
                        </listitem>
 
50
                    </itemizedlist>
 
51
                </listitem>
 
52
            </varlistentry>
 
53
            <varlistentry>
 
54
                <term>Pop_init</term>
 
55
                <listitem>
 
56
                    <para>a list which contains the initial population of
 
57
                        individuals.
 
58
                    </para>
 
59
                </listitem>
 
60
            </varlistentry>
 
61
        </variablelist>
 
62
    </refsection>
 
63
    <refsection>
 
64
        <title>Description</title>
 
65
        <para>
 
66
            This function generate an initial population containing pop_size
57
67
            individuals.
58
 
          </para>
59
 
        </listitem>
60
 
      </varlistentry>
61
 
    </variablelist>
62
 
  </refsection>
63
 
  <refsection>
64
 
    <title>Description</title>
65
 
    <para>
66
 
      This function generate an initial population containing pop_size
67
 
      individuals.
68
 
      It uses the rand function to generate the points uniformly distributed in the
69
 
      bounds.
70
 
      As a side effect, it modifies the state of the random generator of the rand 
71
 
      function.
72
 
      Other initial populations might be generated from the grand 
73
 
      function, or any other uniform random generator (including low discrepancy sequences).
74
 
      In the case were we want to compute another initial population, we 
75
 
      might define our own init function: in this case, we may use the init_ga_default 
76
 
      function as a template and plug our customized population generator.
77
 
    </para>
78
 
  </refsection>
79
 
  <refsection>
80
 
    <title>Examples</title>
81
 
    <programlisting role="example"><![CDATA[ 
 
68
            It uses the rand function to generate the points uniformly distributed in the
 
69
            bounds.
 
70
            As a side effect, it modifies the state of the random generator of the rand 
 
71
            function.
 
72
            Other initial populations might be generated from the grand 
 
73
            function, or any other uniform random generator (including low discrepancy sequences).
 
74
            In the case were we want to compute another initial population, we 
 
75
            might define our own init function: in this case, we may use the init_ga_default 
 
76
            function as a template and plug our customized population generator.
 
77
        </para>
 
78
    </refsection>
 
79
    <refsection>
 
80
        <title>Examples</title>
 
81
        <programlisting role="example"><![CDATA[ 
82
82
// Generate 10 points in 2 dimensions, in the 
83
83
// interval [-2,2]^2.
84
84
popsize = 10;
93
93
  mprintf("x[%d]=[%s]\n",k,xstr);
94
94
end
95
95
 ]]></programlisting>
96
 
  </refsection>
97
 
  <refsection role="see also">
98
 
    <title>See Also</title>
99
 
    <simplelist type="inline">
100
 
      <member>
101
 
        <link linkend="crossover_ga_default"> crossover_ga_default
102
 
        </link>
103
 
      </member>
104
 
      <member>
105
 
        <link linkend="mutation_ga_default"> mutation_ga_default
106
 
        </link>
107
 
      </member>
108
 
      <member>
109
 
        <link linkend="mutation_ga_binary"> mutation_ga_binary
110
 
        </link>
111
 
      </member>
112
 
      <member>
113
 
        <link linkend="optim_ga"> optim_ga </link>
114
 
      </member>
115
 
    </simplelist>
116
 
  </refsection>
 
96
    </refsection>
 
97
    <refsection role="see also">
 
98
        <title>See Also</title>
 
99
        <simplelist type="inline">
 
100
            <member>
 
101
                <link linkend="crossover_ga_default"> crossover_ga_default
 
102
                </link>
 
103
            </member>
 
104
            <member>
 
105
                <link linkend="mutation_ga_default"> mutation_ga_default
 
106
                </link>
 
107
            </member>
 
108
            <member>
 
109
                <link linkend="mutation_ga_binary"> mutation_ga_binary
 
110
                </link>
 
111
            </member>
 
112
            <member>
 
113
                <link linkend="optim_ga"> optim_ga </link>
 
114
            </member>
 
115
        </simplelist>
 
116
    </refsection>
117
117
</refentry>