Skip to content

Commit

Permalink
add man-roxygen directory and some parameter templates
Browse files Browse the repository at this point in the history
  • Loading branch information
jakobbossek committed Aug 25, 2015
1 parent 59648b4 commit 0e568dd
Show file tree
Hide file tree
Showing 5 changed files with 14 additions and 10 deletions.
14 changes: 4 additions & 10 deletions R/setupEvolutionaryOperators.R
Original file line number Diff line number Diff line change
Expand Up @@ -14,16 +14,10 @@
#' @param generator [\code{ecr_generator}]\cr
#' Generator operator of type \code{ecr_generator} for the generation of the initial
#' population.
#' @param parent.selector [\code{ecr_selector}]\cr
#' Selection operator which implements a procedure to copy individuals from a
#' given population to the mating pool, i. e., allow them to become parents.
#' @param survival.selector [\code{ecr_selector}]\cr
#' Selection operator which implements a procedurce to extract individuals from
#' a given set, which should survive and set up the next generation.
#' @param mutator [\code{ecr_mutator}]\cr
#' Mutation operator of type \code{ecr_mutator}.
#' @param recombinator [\code{ecr_recombinator}]\cr
#' Recombination operator of type \code{ecr_recombinator}.
#' @template arg_parent_selector
#' @template arg_survival_selector
#' @template arg_mutator
#' @template arg_recombinator
#' @param mutator.control [\code{list}]\cr
#' List of evolutionary parameters for the corresponding mutation operator. See the
#' help pages for the mutation operators for the needed values.
Expand Down
2 changes: 2 additions & 0 deletions man-roxygen/arg_mutator.R
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
#' @param mutator [\code{ecr_mutator}]\cr
#' Mutation operator of type \code{ecr_mutator}.
3 changes: 3 additions & 0 deletions man-roxygen/arg_parent_selector.R
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
#' @param parent.selector [\code{ecr_selector}]\cr
#' Selection operator which implements a procedure to copy individuals from a
#' given population to the mating pool, i. e., allow them to become parents.
2 changes: 2 additions & 0 deletions man-roxygen/arg_recombinator.R
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
#' @param recombinator [\code{ecr_recombinator}]\cr
#' Recombination operator of type \code{ecr_recombinator}.
3 changes: 3 additions & 0 deletions man-roxygen/arg_survival_selector.R
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
#' @param survival.selector [\code{ecr_selector}]\cr
#' Selection operator which implements a procedurce to extract individuals from
#' a given set, which should survive and set up the next generation.

0 comments on commit 0e568dd

Please sign in to comment.