Fix some misc errors in the help
[scilab.git] / scilab / modules / genetic_algorithms / help / en_US / crossover_ga_binary.xml
1 <?xml version="1.0" encoding="ISO-8859-1"?>
2
3 <!--
4  * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
5  * Copyright (C) 2008 - Yann COLLETTE <yann.collette@renault.com>
6  *
7  * This file must be used under the terms of the CeCILL.
8  * This source file is licensed as described in the file COPYING, which
9  * you should have received as part of this distribution.  The terms
10  * are also available at
11  * http://www.cecill.info/licences/Licence_CeCILL_V2-en.txt
12  *
13  -->
14
15 <refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" version="5.0-subset Scilab" xml:lang="en" xml:id="crossover_ga_binary">
16   <info>
17     <pubdate>4-Feb-2008</pubdate>
18   </info>
19   <refnamediv>
20     <refname>crossover_ga_binary</refname>
21     <refpurpose> A crossover function for binary code </refpurpose>
22   </refnamediv>
23   <refsynopsisdiv>
24     <title>Calling Sequence</title>
25     <synopsis>[Crossed_Indiv1,Crossed_Indiv2] = crossover_ga_binary(Indiv1,Indiv2,param)</synopsis>
26   </refsynopsisdiv>
27   <refsection>
28     <title>Parameters</title>
29     <variablelist>
30       <varlistentry>
31         <term>Indiv1</term>
32         <listitem>
33           <para>the first individual (here a binary code) to be crossed-over.
34        </para>
35         </listitem>
36       </varlistentry>
37       <varlistentry>
38         <term>Indiv2</term>
39         <listitem>
40           <para>the second individual to be crossed-over.
41        </para>
42         </listitem>
43       </varlistentry>
44       <varlistentry>
45         <term>param</term>
46         <listitem>
47           <para>a list of parameters.
48          - 'binary_length': the length of the binary code.
49          - 'multi_cross': a boolean. If %T then we allow several cuts in the binary code.
50          - 'multi_cross_nb': the number of cuts in the binary code. Only used when multi_cross is set to %T.
51        </para>
52         </listitem>
53       </varlistentry>
54       <varlistentry>
55         <term>Crossed_Indiv1</term>
56         <listitem>
57           <para>The first individual obtained by the cross-over function.
58        </para>
59         </listitem>
60       </varlistentry>
61       <varlistentry>
62         <term>Crossed_Indiv2</term>
63         <listitem>
64           <para>The second individual obtained by the cross-over function.
65        </para>
66         </listitem>
67       </varlistentry>
68     </variablelist>
69   </refsection>
70   <refsection>
71     <title>Description</title>
72     <itemizedlist>
73       <listitem>
74         <para>
75       This function implements a classical binary cross-over.
76      </para>
77       </listitem>
78     </itemizedlist>
79   </refsection>
80   <refsection>
81     <title>See Also</title>
82     <simplelist type="inline">
83       <member>
84         <link linkend="crossover_ga_binary"> crossover_ga_binary </link>
85       </member>
86       <member>
87         <link linkend="crossover_ga_default"> crossover_ga_default </link>
88       </member>
89       <member>
90         <link linkend="mutation_ga_binary"> mutation_ga_binary </link>
91       </member>
92       <member>
93         <link linkend="optim_ga"> optim_ga </link>
94       </member>
95     </simplelist>
96   </refsection>
97   <refsection>
98     <title>Authors</title>
99     <variablelist>
100       <varlistentry>
101         <term>Yann COLLETTE</term>
102         <listitem>
103           <para>
104     ycollet@freesurf.fr
105     </para>
106         </listitem>
107       </varlistentry>
108     </variablelist>
109   </refsection>
110 </refentry>