16a9e194beb1bd054a5fe8c5c29cf8480d4c7f8f
[scilab.git] / scilab / modules / genetic_algorithms / help / en_US / utilities / crossover_ga_binary.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.1-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:ns3="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="crossover_ga_binary" xml:lang="en">
14     <refnamediv>
15         <refname>crossover_ga_binary</refname>
16         <refpurpose>A crossover function for binary code</refpurpose>
17     </refnamediv>
18     <refsynopsisdiv>
19         <title>Calling Sequence</title>
20         <synopsis>[Crossed_Indiv1,Crossed_Indiv2] = crossover_ga_binary(Indiv1,Indiv2,param)</synopsis>
21     </refsynopsisdiv>
22     <refsection>
23         <title>Arguments</title>
24         <variablelist>
25             <varlistentry>
26                 <term>Indiv1</term>
27                 <listitem>
28                     <para>the first individual (here a binary code) to be
29                         crossed-over.
30                     </para>
31                 </listitem>
32             </varlistentry>
33             <varlistentry>
34                 <term>Indiv2</term>
35                 <listitem>
36                     <para>the second individual to be crossed-over.</para>
37                 </listitem>
38             </varlistentry>
39             <varlistentry>
40                 <term>param</term>
41                 <listitem>
42                     <para>a list of parameters. </para>
43                     <itemizedlist>
44                         <listitem>
45                             <para> 'binary_length': the length of the binary code. </para>
46                         </listitem>
47                         <listitem>
48                             <para> 'multi_cross': a boolean. If %T then we allow several
49                                 cuts in the binary code. 
50                             </para>
51                         </listitem>
52                         <listitem>
53                             <para> 'multi_cross_nb': the number of cuts in the binary code.
54                                 Only used when multi_cross is set to %T.
55                             </para>
56                         </listitem>
57                     </itemizedlist>
58                 </listitem>
59             </varlistentry>
60             <varlistentry>
61                 <term>Crossed_Indiv1</term>
62                 <listitem>
63                     <para>The first individual obtained by the cross-over
64                         function.
65                     </para>
66                 </listitem>
67             </varlistentry>
68             <varlistentry>
69                 <term>Crossed_Indiv2</term>
70                 <listitem>
71                     <para>The second individual obtained by the cross-over
72                         function.
73                     </para>
74                 </listitem>
75             </varlistentry>
76         </variablelist>
77     </refsection>
78     <refsection>
79         <title>Description</title>
80         <itemizedlist>
81             <listitem>
82                 <para>This function implements a classical binary cross-over.</para>
83             </listitem>
84         </itemizedlist>
85     </refsection>
86     <refsection role="see also">
87         <title>See Also</title>
88         <simplelist type="inline">
89             <member>
90                 <link linkend="crossover_ga_binary"> crossover_ga_binary
91                 </link>
92             </member>
93             <member>
94                 <link linkend="crossover_ga_default"> crossover_ga_default
95                 </link>
96             </member>
97             <member>
98                 <link linkend="mutation_ga_binary"> mutation_ga_binary
99                 </link>
100             </member>
101             <member>
102                 <link linkend="optim_ga"> optim_ga </link>
103             </member>
104         </simplelist>
105     </refsection>
106 </refentry>