export applyRandomMutation; applyRandomMutation now also 'forces to b…

…ounds'

NAMESPACE

@@ -2,6 +2,7 @@
 
 S3method(print,tspgen_collection)
 export(addMutator)
+export(applyRandomMutation)
 export(build)
 export(doAxisProjectionMutation)
 export(doClusterMutation)

R/build.R

@@ -28,13 +28,7 @@
 #'   Instance generation takes place in \eqn{[0,1]^2}. Use \code{upper} to
 #'   upscale the boundaries, i.e., place nodes in \eqn{[0, upper]^2}.
 #'   Default is 1.
-#' @param bound.handling [\code{character(1)}]\cr
-#'   Occasionally during instance generation points are moved outside the boundaries
-#'   of the point space. The parameter \code{bound.handling} determines how to deal
-#'   with these points. Option \dQuote{uniform} places outliers uniform at random within
-#'.  the boundaries while option \dQuote{boundary} places them on the corresponding
-#'   violates boundary/boundaries.
-#'   Default is \dQuote{uniform}.
+#' @template arg_bound_handling
 #' @return Either a netgen \code{Network} if \code{return.all = FALSE}, otherwise a
 #' list of netgen networks of length \code{iters + 1}.
 #' @examples

R/collection.R

@@ -141,7 +141,15 @@ listToString = function(x, wrap = NULL) {
   return(s)
 }
 
-applyRandomMutation = function(collection, coords) {
+#' Apply a random mutation from a collection.
+#'
+#' @template arg_collection
+#' @param coords [\code{matrix(n, 2)}]\cr
+#'   Coordinate matrix.
+#' @template arg_bound_handling
+#' @return [\code{matrix(n, 2)}] Mutated coordinate matrix.
+#' @export
+applyRandomMutation = function(collection, coords, bound.handling = "boundary") {
   checkmate::assertClass(collection, "tspgen_collection")
   checkmate::assertMatrix(coords, mode = "numeric", min.rows = 2L, ncols = 2L, any.missing = FALSE, all.missing = FALSE)
 
@@ -157,5 +165,11 @@ applyRandomMutation = function(collection, coords) {
 
   # apply mutation
   coords = do.call(mutator.fun, mutator.pars)
+  attr(coords, "df") = NULL
+
+  # repair points outside the bounding box
+  coords = forceToBounds(coords, bound.handling = bound.handling)
+  # avoid duplicate nodes
+  coords = relocateDuplicates(coords)
   return(coords)
 }

man-roxygen/arg_bound_handling.R

@@ -0,0 +1,7 @@
+#' @param bound.handling [\code{character(1)}]\cr
+#'   Occasionally during instance generation points are moved outside the boundaries
+#'   of the point space. The parameter \code{bound.handling} determines how to deal
+#'   with these points. Option \dQuote{uniform} places outliers uniform at random within
+#'.  the boundaries while option \dQuote{boundary} places them on the corresponding
+#'   violates boundary/boundaries.
+#'   Default is \dQuote{uniform}.