]> Creatis software - CreaPhase.git/blob - octave_packages/ga-0.10.0/doc-cache
Add a useful package (from Source forge) for octave
[CreaPhase.git] / octave_packages / ga-0.10.0 / doc-cache
1 # Created by Octave 3.6.1, Wed Apr 18 13:13:19 2012 UTC <root@brouzouf>
2 # name: cache
3 # type: cell
4 # rows: 3
5 # columns: 9
6 # name: <cell-element>
7 # type: sq_string
8 # elements: 1
9 # length: 18
10 crossoverscattered
11
12
13 # name: <cell-element>
14 # type: sq_string
15 # elements: 1
16 # length: 135
17  simplified example (nvars == 4)
18  p1 = [varA varB varC varD]
19  p2 = [var1 var2 var3 var4]
20  b = [1 1 0 1]
21  child = [varA varB var3 varD]
22
23
24
25 # name: <cell-element>
26 # type: sq_string
27 # elements: 1
28 # length: 80
29  simplified example (nvars == 4)
30  p1 = [varA varB varC varD]
31  p2 = [var1 var2 va
32
33
34
35 # name: <cell-element>
36 # type: sq_string
37 # elements: 1
38 # length: 14
39 fitscalingrank
40
41
42 # name: <cell-element>
43 # type: sq_string
44 # elements: 1
45 # length: 71
46 TODO
47 ranks ([7,2,2]) == [3.0,1.5,1.5]
48 is [3,1,2] (or [3,2,1]) useful? 
49
50
51
52 # name: <cell-element>
53 # type: sq_string
54 # elements: 1
55 # length: 27
56 TODO
57 ranks ([7,2,2]) == [3.
58
59
60
61 # name: <cell-element>
62 # type: sq_string
63 # elements: 1
64 # length: 2
65 ga
66
67
68 # name: <cell-element>
69 # type: sq_string
70 # elements: 1
71 # length: 1866
72  -- Function File: X = ga (FITNESSFCN, NVARS)
73  -- Function File: X = ga (FITNESSFCN, NVARS, A, B)
74  -- Function File: X = ga (FITNESSFCN, NVARS, A, B, AEQ, BEQ)
75  -- Function File: X = ga (FITNESSFCN, NVARS, A, B, AEQ, BEQ, LB, UB)
76  -- Function File: X = ga (FITNESSFCN, NVARS, A, B, AEQ, BEQ, LB, UB,
77           NONLCON)
78  -- Function File: X = ga (FITNESSFCN, NVARS, A, B, AEQ, BEQ, LB, UB,
79           NONLCON, OPTIONS)
80  -- Function File: X = ga (PROBLEM)
81  -- Function File: [X, FVAL] = ga (...)
82  -- Function File: [X, FVAL, EXITFLAG] = ga (...)
83  -- Function File: [X, FVAL, EXITFLAG, OUTPUT] = ga (...)
84  -- Function File: [X, FVAL, EXITFLAG, OUTPUT, POPULATION] = ga (...)
85  -- Function File: [X, FVAL, EXITFLAG, OUTPUT, POPULATION, SCORES] = ga
86           (...)
87      Find minimum of function using genetic algorithm.
88
89      *Inputs*
90     FITNESSFCN
91           The objective function to minimize. It accepts a vector X of
92           size 1-by-NVARS, and returns a scalar evaluated at X.
93
94     NVARS
95           The dimension (number of design variables) of FITNESSFCN.
96
97     OPTIONS
98           The structure of the optimization parameters; can be created
99           using the `gaoptimset' function. If not specified, `ga'
100           minimizes with the default optimization parameters.
101
102     PROBLEM
103           A structure containing the following fields:
104              * `fitnessfcn'
105
106              * `nvars'
107
108              * `Aineq'
109
110              * `Bineq'
111
112              * `Aeq'
113
114              * `Beq'
115
116              * `lb'
117
118              * `ub'
119
120              * `nonlcon'
121
122              * `randstate'
123
124              * `randnstate'
125
126              * `solver'
127
128              * `options'
129
130      *Outputs*
131     X
132           The local unconstrained found minimum to the objective
133           function, FITNESSFCN.
134
135     FVAL
136           The value of the fitness function at X.
137
138      See also: gaoptimset
139
140
141
142
143
144 # name: <cell-element>
145 # type: sq_string
146 # elements: 1
147 # length: 49
148 Find minimum of function using genetic algorithm.
149
150
151
152 # name: <cell-element>
153 # type: sq_string
154 # elements: 1
155 # length: 17
156 gacreationuniform
157
158
159 # name: <cell-element>
160 # type: sq_string
161 # elements: 1
162 # length: 487
163  -- Function File: POPULATION = gacreationuniform (GENOMELENGTH,
164           FITNESSFCN, OPTIONS)
165      Create a random initial population with a uniform distribution.
166
167      *Inputs*
168     GENOMELENGTH
169           The number of indipendent variables for the fitness function.
170
171     FITNESSFCN
172           The fitness function.
173
174     OPTIONS
175           The options structure.
176
177      *Outputs*
178     POPULATION
179           The initial population for the genetic algorithm.
180
181      See also: ga, gaoptimset
182
183
184
185
186
187 # name: <cell-element>
188 # type: sq_string
189 # elements: 1
190 # length: 63
191 Create a random initial population with a uniform distribution.
192
193
194
195 # name: <cell-element>
196 # type: sq_string
197 # elements: 1
198 # length: 10
199 gaoptimset
200
201
202 # name: <cell-element>
203 # type: sq_string
204 # elements: 1
205 # length: 1242
206  -- Function File: OPTIONS = gaoptimset
207  -- Function File: OPTIONS = gaoptimset ('PARAM1', VALUE1, 'PARAM2',
208           VALUE2, ...)
209      Create genetic algorithm options structure.
210
211      *Inputs*
212     PARAM
213           Parameter to set. Unspecified parameters are set to their
214           default values; specifying no parameters is allowed.
215
216     VALUE
217           Value of PARAM.
218
219      *Outputs*
220     OPTIONS
221           Structure containing the options, or parameters, for the
222           genetic algorithm.
223
224      *Options*
225     `CreationFcn'
226
227     `CrossoverFcn'
228
229     `CrossoverFraction'
230
231     `EliteCount'
232
233     `FitnessLimit'
234
235     `FitnessScalingFcn'
236
237     `Generations'
238
239     `InitialPopulation'
240           Can be partial.
241
242     `InitialScores'
243           column vector | [] (default) . Can be partial.
244
245     `MutationFcn'
246
247     `PopInitRange'
248
249     `PopulationSize'
250
251     `SelectionFcn'
252
253     `TimeLimit'
254
255     `UseParallel'
256           "always" | "never" (default) . Parallel evaluation of
257           objective function. TODO: parallel evaluation of nonlinear
258           constraints
259
260     `Vectorized'
261           "on" | "off" (default) . Vectorized evaluation of objective
262           function. TODO: vectorized evaluation of nonlinear constraints
263
264      See also: ga
265
266
267
268
269
270 # name: <cell-element>
271 # type: sq_string
272 # elements: 1
273 # length: 43
274 Create genetic algorithm options structure.
275
276
277
278 # name: <cell-element>
279 # type: sq_string
280 # elements: 1
281 # length: 16
282 mutationgaussian
283
284
285 # name: <cell-element>
286 # type: sq_string
287 # elements: 1
288 # length: 30
289  start mutationgaussian logic
290
291
292
293 # name: <cell-element>
294 # type: sq_string
295 # elements: 1
296 # length: 30
297  start mutationgaussian logic
298
299
300
301
302 # name: <cell-element>
303 # type: sq_string
304 # elements: 1
305 # length: 13
306 rastriginsfcn
307
308
309 # name: <cell-element>
310 # type: sq_string
311 # elements: 1
312 # length: 69
313  -- Function File: Y = rastriginsfcn (X)
314      Rastrigin's function.
315
316
317
318
319 # name: <cell-element>
320 # type: sq_string
321 # elements: 1
322 # length: 21
323 Rastrigin's function.
324
325
326
327 # name: <cell-element>
328 # type: sq_string
329 # elements: 1
330 # length: 18
331 selectionstochunif
332
333
334 # name: <cell-element>
335 # type: sq_string
336 # elements: 1
337 # length: 104
338  fix an entry of the steps (or parents) vector
339 assert (steps(1, index_steps) < max_step_size); ## DEBUG
340
341
342
343 # name: <cell-element>
344 # type: sq_string
345 # elements: 1
346 # length: 80
347  fix an entry of the steps (or parents) vector
348 assert (steps(1, index_steps) < m
349
350
351
352 # name: <cell-element>
353 # type: sq_string
354 # elements: 1
355 # length: 7
356 test_ga
357
358
359 # name: <cell-element>
360 # type: sq_string
361 # elements: 1
362 # length: 69
363  -- Script File:  test_ga
364      Execute all available tests at once.
365
366
367
368
369 # name: <cell-element>
370 # type: sq_string
371 # elements: 1
372 # length: 36
373 Execute all available tests at once.
374
375
376
377
378