R/RcppExports.R

In rminizinc: R Interface to 'MiniZinc'

# Generated by using Rcpp::compileAttributes() -> do not edit by hand
# Generator token: 10BE3573-1514-4C36-9D1C-5A225CD40393

#' @title MiniZinc model evaluation
#' 
#' @description evaluates the MiniZinc model
#'
#' @importFrom Rcpp sourceCpp
#' @export mzn_eval
#' @useDynLib rminizinc, .registration=TRUE
#' @param lib_path the path of the library where the standard library files are present 
#' (the parent directory of the std directory).
#' @param r_model R6 Model object
#' @param mzn_path path of the mzn file to be solved
#' @param model_string model string to be solved.
#' @param solver the name of the solver to use.(default: Gecode)
#' @param dzn_path path of the datafile to be used.
#' @param all_solutions bool to specify if all solutions are specified.(default: true)
#' @param time_limit stop after <time_limit> milliseconds. (default: 300000ms -- 5 mins)
#' @param other_cl_options other command line options/flags that you want to provide
#' 1. Please provide as a character/string vector with each element as a flag
#' 2. Incorrect flags or incorrect commands will throw errors.
#' 3. Changing the default solution output options will result in parsing errors and 
#' the solutions will not be parsed correctly to R but the solution string will be 
#' returned.
mzn_eval <- function(lib_path = "", r_model = NULL, mzn_path = "", model_string = "", solver = "org.gecode.gecode", dzn_path = "", all_solutions = TRUE, time_limit = 300000L, other_cl_options = NULL) {
    .Call(`_rminizinc_mzn_eval`, lib_path, r_model, mzn_path, model_string, solver, dzn_path, all_solutions, time_limit, other_cl_options)
}

#' @title MiniZinc syntax parser
#' 
#' @description parses the MiniZinc syntax into R objects
#'
#' @importFrom Rcpp sourceCpp
#' @export mzn_parse
#' @useDynLib rminizinc, .registration=TRUE
#' @param model_string string representation of the MiniZinc model.
#' @param mzn_path the path of model mzn.
#' @param include_path path of the included mzn in the model if it exists.
mzn_parse <- function(model_string = "", mzn_path = "", include_path = NULL) {
    .Call(`_rminizinc_mzn_parse`, model_string, mzn_path, include_path)
}

#' @title parse the solution
#' 
#' @description can parse the JSON solution of a model to 
#' return a list output
#' @importFrom Rcpp sourceCpp
#' @import rjson
#' @export sol_parse
#' @useDynLib rminizinc, .registration=TRUE
#' @param solutionString solution of the model as a string representation
sol_parse <- function(solutionString) {
    .Call(`_rminizinc_sol_parse`, solutionString)
}