c0c1261bc9857535215cd42c2fe27fc6433e71f9
[scilab.git] / scilab / modules / genetic_algorithms / help / en_US / coding_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="coding_ga_binary">
16   <info>
17     <pubdate>4-Feb-2008</pubdate>
18   </info>
19   <refnamediv>
20     <refname>coding_ga_binary</refname>
21     <refpurpose> A function which performs conversion between binary and continuous representation </refpurpose>
22   </refnamediv>
23   <refsynopsisdiv>
24     <title>Calling Sequence</title>
25     <synopsis>pop_out = coding_ga_binary(pop_in,direction,param)</synopsis>
26   </refsynopsisdiv>
27   <refsection>
28     <title>Parameters</title>
29     <variablelist>
30       <varlistentry>
31         <term>pop_in</term>
32         <listitem>
33           <para>a list which contains all the individuals in the current population.
34        </para>
35         </listitem>
36       </varlistentry>
37       <varlistentry>
38         <term>direction</term>
39         <listitem>
40           <para>'code' or 'decode'. If direction == 'code' then we perform a continuous to binary encoding. Else, we convert from binary to continuous.
41        </para>
42         </listitem>
43       </varlistentry>
44       <varlistentry>
45         <term>param</term>
46         <listitem>
47           <para>a parameter list.
48          - 'binary_length': the number of bits by variables. If binary_length = 8 and the variable X is of dimension 2 then the binary code will be 16 bits length.
49          - 'minboun': a vector of minimum bounds for the variable X.
50          - 'maxbound': a vector of maximum bounds for the variable X.
51        </para>
52         </listitem>
53       </varlistentry>
54       <varlistentry>
55         <term>pop_out</term>
56         <listitem>
57           <para>the population coded to binary or decoded to continuous values.
58        </para>
59         </listitem>
60       </varlistentry>
61     </variablelist>
62   </refsection>
63   <refsection>
64     <title>Description</title>
65     <itemizedlist>
66       <listitem>
67         <para>
68       This function allows to code or decode a population of individuals from / to continuous variables to / from binary.
69      </para>
70       </listitem>
71     </itemizedlist>
72   </refsection>
73   <refsection>
74     <title>See Also</title>
75     <simplelist type="inline">
76       <member>
77         <link linkend="optim_ga"> optim_ga </link>
78       </member>
79       <member>
80         <link linkend="mutation_ga_binary"> mutation_func_binary </link>
81       </member>
82       <member>
83         <link linkend="crossover_ga_binary"> crossover_func_binary </link>
84       </member>
85     </simplelist>
86   </refsection>
87   <refsection>
88     <title>Authors</title>
89     <variablelist>
90       <varlistentry>
91         <term>Yann COLLETTE</term>
92         <listitem>
93           <para>
94     ycollet@freesurf.Fr
95     </para>
96         </listitem>
97       </varlistentry>
98     </variablelist>
99   </refsection>
100 </refentry>