Skip to content

Commit

Permalink
add missing descriptions to some recombinators
Browse files Browse the repository at this point in the history
  • Loading branch information
jakobbossek committed Dec 9, 2015
1 parent 3578a59 commit 9b42b66
Show file tree
Hide file tree
Showing 6 changed files with 43 additions and 5 deletions.
13 changes: 12 additions & 1 deletion R/recombinator.crossover.R
Original file line number Diff line number Diff line change
@@ -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}.
Expand Down
6 changes: 5 additions & 1 deletion R/recombinator.intermediate.R
Original file line number Diff line number Diff line change
@@ -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}.
Expand Down
6 changes: 5 additions & 1 deletion R/recombinator.null.R
Original file line number Diff line number Diff line change
@@ -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
Expand Down
13 changes: 12 additions & 1 deletion man/makeCrossoverRecombinator.Rd

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

4 changes: 4 additions & 0 deletions man/makeIntermediateRecombinator.Rd

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

6 changes: 5 additions & 1 deletion man/makeNullRecombinator.Rd

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

0 comments on commit 9b42b66

Please sign in to comment.