Skip to content

Commit

Permalink
add missing descriptions to stopping conditions, add @family
Browse files Browse the repository at this point in the history
  • Loading branch information
jakobbossek committed Dec 9, 2015
1 parent 9b42b66 commit 7f43709
Show file tree
Hide file tree
Showing 7 changed files with 56 additions and 3 deletions.
6 changes: 5 additions & 1 deletion R/stoppingCondition.max.evaluations.R
Original file line number Diff line number Diff line change
@@ -1,9 +1,13 @@
#' @title
#' Stopping condition: maximum number of function evaluations.
#' Stopping condition: maximum number of function evaluations.
#'
#' @description
#' Stop the EA after at most \code{max.evals} evaluations of the fitness function.
#'
#' @param max.evals [\code{integer(1)}]\cr
#' Maximal number of function evaluations. Default ist \code{Inf}.
#' @return [\code{function}]
#' @family stopping conditions
#' @export
makeMaximumEvaluationsStoppingCondition = function(max.evals = NULL) {
force(max.evals)
Expand Down
6 changes: 5 additions & 1 deletion R/stoppingCondition.max.iter.R
Original file line number Diff line number Diff line change
@@ -1,9 +1,13 @@
#' @title
#' Stopping condition: maximum number of iterations.
#' Stopping condition: maximum number of iterations.
#'
#' @description
#' Stop the EA after at most \code{max.iter} generations/iterations.
#'
#' @param max.iter [\code{integer(1)}]\cr
#' Maximal number of iterations. Default ist \code{Inf}.
#' @return [\code{function}]
#' @family stopping conditions
#' @export
makeMaximumIterationsStoppingCondition = function(max.iter = NULL) {
if (!is.null(max.iter)) {
Expand Down
6 changes: 5 additions & 1 deletion R/stoppingCondition.max.time.R
Original file line number Diff line number Diff line change
@@ -1,9 +1,13 @@
#' @title
#' Stopping condition: time limit.
#' Stopping condition: time limit.
#'
#' @description
#' Stop the EA after a maximal time budget.
#'
#' @param max.time [\code{integer(1)}]\cr
#' Time budget in seconds. Default ist \code{Inf}.
#' @return [\code{function}]
#' @family stopping conditions
#' @export
makeMaximumTimeStoppingCondition = function(max.time = NULL) {
if (!is.null(max.time)) {
Expand Down
20 changes: 20 additions & 0 deletions man/assertListOfPointSets.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

7 changes: 7 additions & 0 deletions man/makeMaximumEvaluationsStoppingCondition.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

7 changes: 7 additions & 0 deletions man/makeMaximumIterationsStoppingCondition.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

7 changes: 7 additions & 0 deletions man/makeMaximumTimeStoppingCondition.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit 7f43709

Please sign in to comment.