diff --git a/R/stoppingCondition.max.evaluations.R b/R/stoppingCondition.max.evaluations.R index 7f56552..aa66856 100644 --- a/R/stoppingCondition.max.evaluations.R +++ b/R/stoppingCondition.max.evaluations.R @@ -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) diff --git a/R/stoppingCondition.max.iter.R b/R/stoppingCondition.max.iter.R index 6a92104..2b0fa5f 100644 --- a/R/stoppingCondition.max.iter.R +++ b/R/stoppingCondition.max.iter.R @@ -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)) { diff --git a/R/stoppingCondition.max.time.R b/R/stoppingCondition.max.time.R index e47edd9..b084ce7 100644 --- a/R/stoppingCondition.max.time.R +++ b/R/stoppingCondition.max.time.R @@ -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)) { diff --git a/man/assertListOfPointSets.Rd b/man/assertListOfPointSets.Rd new file mode 100644 index 0000000..e17d12f --- /dev/null +++ b/man/assertListOfPointSets.Rd @@ -0,0 +1,20 @@ +% Generated by roxygen2: do not edit by hand +% Please edit documentation in R/approximatePoints.R +\name{assertListOfPointSets} +\alias{assertListOfPointSets} +\title{Checks for point set.} +\usage{ +assertListOfPointSets(x) +} +\arguments{ +\item{x}{[list] +List of sets, i.e., matrizes.} +} +\value{ +Nothing +} +\description{ +Helper function to check if all given sets have the same dimension, i.e., + number of objectives. +} + diff --git a/man/makeMaximumEvaluationsStoppingCondition.Rd b/man/makeMaximumEvaluationsStoppingCondition.Rd index a5dfc6d..fd09e41 100644 --- a/man/makeMaximumEvaluationsStoppingCondition.Rd +++ b/man/makeMaximumEvaluationsStoppingCondition.Rd @@ -13,4 +13,11 @@ Maximal number of function evaluations. Default ist \code{Inf}.} \value{ [\code{function}] } +\description{ +Stop the EA after at most \code{max.evals} evaluations of the fitness function. +} +\seealso{ +Other stopping conditions: \code{\link{makeMaximumIterationsStoppingCondition}}, + \code{\link{makeMaximumTimeStoppingCondition}} +} diff --git a/man/makeMaximumIterationsStoppingCondition.Rd b/man/makeMaximumIterationsStoppingCondition.Rd index 13cdee3..95b080a 100644 --- a/man/makeMaximumIterationsStoppingCondition.Rd +++ b/man/makeMaximumIterationsStoppingCondition.Rd @@ -13,4 +13,11 @@ Maximal number of iterations. Default ist \code{Inf}.} \value{ [\code{function}] } +\description{ +Stop the EA after at most \code{max.iter} generations/iterations. +} +\seealso{ +Other stopping conditions: \code{\link{makeMaximumEvaluationsStoppingCondition}}, + \code{\link{makeMaximumTimeStoppingCondition}} +} diff --git a/man/makeMaximumTimeStoppingCondition.Rd b/man/makeMaximumTimeStoppingCondition.Rd index edf2e0d..45d9f83 100644 --- a/man/makeMaximumTimeStoppingCondition.Rd +++ b/man/makeMaximumTimeStoppingCondition.Rd @@ -13,4 +13,11 @@ Time budget in seconds. Default ist \code{Inf}.} \value{ [\code{function}] } +\description{ +Stop the EA after a maximal time budget. +} +\seealso{ +Other stopping conditions: \code{\link{makeMaximumEvaluationsStoppingCondition}}, + \code{\link{makeMaximumIterationsStoppingCondition}} +}