R/MultiObjApproach-class.R

In prioritizr: Systematic Conservation Prioritization in R

#' @include internal.R ConservationModifier-class.R
NULL

#' @export
if (!methods::isClass("MultiObjApproach")) methods::setOldClass("MultiObjApproach")
NULL

#' Multi-objective approach class
#'
#' @description
#' This class is used to represent approaches for multi-objective optimization.
#' **Only experts should use the fields and methods for this class directly.**
#'
#' @name MultiObjApproach-class
#'
#' @family classes
#'
#' @export
MultiObjApproach <- R6::R6Class(
  "MultiObjApproach",
  inherit = ConservationModifier,
  public = list(
    #' @description
    #' Solve a multi-objective optimization problem to generate a solution.
    #' @param x `list` containing a compiled multi-objective optimization
    #' problem (e.g., generated with [multi_compile()]).
    #' @return A `list` of solutions.
    run = function(x) {
      # nocov start
      cli::cli_abort("No defined $apply method.", .internal = TRUE)
      # nocov end
    }
  )
)