Add a useful package (from Source forge) for octave

[CreaPhase.git] / octave_packages / ga-0.10.0 / __ga_stop__.m

diff --git a/octave_packages/ga-0.10.0/__ga_stop__.m b/octave_packages/ga-0.10.0/__ga_stop__.m
new file mode 100644 (file)
index 0000000..15e1945
--- /dev/null
+++ b/octave_packages/ga-0.10.0/__ga_stop__.m
@@ -0,0 +1,39 @@
+## Copyright (C) 2008 Luca Favatella <slackydeb@gmail.com>
+##
+## This program is free software; you can redistribute it and/or modify
+## it under the terms of the GNU General Public License as published by
+## the Free Software Foundation; either version 2 of the License, or
+## (at your option) any later version.
+##
+## This program is distributed in the hope that it will be useful,
+## but WITHOUT ANY WARRANTY; without even the implied warranty of
+## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+## GNU General Public License for more details.
+##
+## You should have received a copy of the GNU General Public License
+## along with this program; If not, see <http://www.gnu.org/licenses/>.
+
+## -*- texinfo -*-
+## @deftypefn{Function File} {@var{stop} =} __ga_stop__ (@var{problem}, @var{state})
+## Determine whether the genetic algorithm should stop.
+##
+## @seealso{__ga_problem__}
+## @end deftypefn
+
+## Author: Luca Favatella <slackydeb@gmail.com>
+## Version: 5.1
+
+function stop = __ga_stop__ (problem, state)
+  Generations = \
+      (state.Generation >= problem.options.Generations);
+
+  TimeLimit = \
+      ((time () - state.StartTime) >= problem.options.TimeLimit);
+
+  FitnessLimit = \
+      (state.Best(state.Generation + 1, 1) <= problem.options.FitnessLimit);
+
+  stop = (Generations ||
+          TimeLimit ||
+          FitnessLimit);
+endfunction
\ No newline at end of file