R/AAA_parameter.R

In TSP: Infrastructure for the Traveling Salesperson Problem

#######################################################################
# Code to check parameter/control objects
# Copyrigth (C) 2011-2016 Michael Hahsler
#
# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation; either version 2 of the License, or
# any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License along
# with this program; if not, write to the Free Software Foundation, Inc.,
# 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.


## helper to parse parameter lists with defaults
.nodots <- function(...) {
  l <- list(...)
  if(length(l) > 0L) warning("Unknown arguments: ",
    paste(names(l), "=",l, collapse=", "))
}


.get_parameters <- function(parameter, defaults, method = NA) {
  defaults <- c(as.list(defaults), "two_opt" = FALSE, rep = FALSE)
  parameter <- as.list(parameter)

  ## add verbose
  if(is.null(defaults$verbose)) defaults$verbose <- FALSE

  if(length(parameter) != 0) {
    o <- pmatch(names(parameter), names(defaults))

    ## unknown parameter
    if(any(is.na(o))){
      warning(sprintf(ngettext(length(is.na(o)),
         "Unknown parameter: %s",
         "Unknown parameters: %s"),
         paste(names(parameter)[is.na(o)],
           collapse = ", ")), call. = FALSE, immediate. = FALSE)
      
      #cat("Available parameter (with default values):\n")
       #print(defaults)
      # cat(rbind(names(defaults)," = ", gsub("\n"," ",as.character(defaults))),
      #   sep=c("\t"," ","\n"))
    }

    defaults[o[!is.na(o)]] <- parameter[!is.na(o)]
  }

  if(defaults$verbose) {
    cat("Used control parameters by", sQuote(method), "\n")

    #print(defaults)
    cat(rbind(names(defaults)," = ",
      strtrim(gsub("\n"," ",as.character(defaults)), 50)),
      sep=c("\t"," ","\n"))

    cat("\n")
  }

  defaults
}