diff --git a/R/recombinator.crossover.R b/R/recombinator.crossover.R index 9ff7f34..5730a0c 100644 --- a/R/recombinator.crossover.R +++ b/R/recombinator.crossover.R @@ -1,5 +1,16 @@ #' @title -#' Generator of the One-point crossover recombination operator. +#' Generator of the one-point crossover recombination operator. +#' +#' @description +#' The one-point crossover recombinator is defined for float and binary +#' representations. Given two real-valued/binary vectors of length n, the +#' selector samples a random position i between 1 and n-1. In the next step +#' it creates two children. The first part of the first child contains of the +#' subvector from position 1 to position i of the first parent, the second part +#' from position i+1 to n is taken from the second parent. The second child +#' is build analogously. +#' If the parents are list of real-valued/binary vectors, the procedure described +#' above is applied to each element of the list. #' #' @param p [\code{numeric(1)}]\cr #' Cross over probability to form an offspring. Default is \code{1}. diff --git a/R/recombinator.intermediate.R b/R/recombinator.intermediate.R index 9de080a..dd3fcaa 100644 --- a/R/recombinator.intermediate.R +++ b/R/recombinator.intermediate.R @@ -1,5 +1,9 @@ #' @title -#' Generator of the indermediate recombination operator. +#' Generator of the indermediate recombination operator. +#' +#' @description +#' Intermediate recombination computes the component-wise mean value of the +#' \code{k} given parents. It is applicable only to float representation. #' #' @param k [integer(1)]\cr #' Number of parents required for mating. Default is \code{2}. diff --git a/R/recombinator.null.R b/R/recombinator.null.R index 16bf56c..71ddecb 100644 --- a/R/recombinator.null.R +++ b/R/recombinator.null.R @@ -1,5 +1,9 @@ #' @title -#' This recombinator does not perform any recombination. +#' Generator of the \dQuote{null} recombination operator. +#' +#' @description +#' This recombinator does not perform any recombination. It simply returns the +#' first of the passed parents. #' #' @return [\code{ecr_recombinator}] #' @family recombinators diff --git a/man/makeCrossoverRecombinator.Rd b/man/makeCrossoverRecombinator.Rd index f3fa500..5a109ca 100644 --- a/man/makeCrossoverRecombinator.Rd +++ b/man/makeCrossoverRecombinator.Rd @@ -2,7 +2,7 @@ % Please edit documentation in R/recombinator.crossover.R \name{makeCrossoverRecombinator} \alias{makeCrossoverRecombinator} -\title{Generator of the One-point crossover recombination operator.} +\title{Generator of the one-point crossover recombination operator.} \usage{ makeCrossoverRecombinator(p = 1) } @@ -13,6 +13,17 @@ Cross over probability to form an offspring. Default is \code{1}.} \value{ [\code{ecr_recombinator}] } +\description{ +The one-point crossover recombinator is defined for float and binary +representations. Given two real-valued/binary vectors of length n, the +selector samples a random position i between 1 and n-1. In the next step +it creates two children. The first part of the first child contains of the +subvector from position 1 to position i of the first parent, the second part +from position i+1 to n is taken from the second parent. The second child +is build analogously. +If the parents are list of real-valued/binary vectors, the procedure described +above is applied to each element of the list. +} \seealso{ Other recombinators: \code{\link{makeIntermediateRecombinator}}, \code{\link{makeNullRecombinator}}, diff --git a/man/makeIntermediateRecombinator.Rd b/man/makeIntermediateRecombinator.Rd index a66e68b..e3abab0 100644 --- a/man/makeIntermediateRecombinator.Rd +++ b/man/makeIntermediateRecombinator.Rd @@ -13,6 +13,10 @@ Number of parents required for mating. Default is \code{2}.} \value{ [\code{ecr_recombinator}] } +\description{ +Intermediate recombination computes the component-wise mean value of the +\code{k} given parents. It is applicable only to float representation. +} \seealso{ Other recombinators: \code{\link{makeCrossoverRecombinator}}, \code{\link{makeNullRecombinator}}, diff --git a/man/makeNullRecombinator.Rd b/man/makeNullRecombinator.Rd index be4f3c5..327b90c 100644 --- a/man/makeNullRecombinator.Rd +++ b/man/makeNullRecombinator.Rd @@ -2,13 +2,17 @@ % Please edit documentation in R/recombinator.null.R \name{makeNullRecombinator} \alias{makeNullRecombinator} -\title{This recombinator does not perform any recombination.} +\title{Generator of the \dQuote{null} recombination operator.} \usage{ makeNullRecombinator() } \value{ [\code{ecr_recombinator}] } +\description{ +This recombinator does not perform any recombination. It simply returns the +first of the passed parents. +} \seealso{ Other recombinators: \code{\link{makeCrossoverRecombinator}}, \code{\link{makeIntermediateRecombinator}},