R/variable-attributes.R

In r-opt/MOI: An Abstract Mathematical Optimization Interface

# variables
#' Abstract variable attribute
#' @export
setClass("MOI_abstract_variable_attribute")

#' Variable name attribute
#' @export
setClass("MOI_variable_name_attribute", contains = "MOI_abstract_variable_attribute")

#' Variable primal start attribute
#' @export
setClass("MOI_variable_primal_start_attribute", contains = "MOI_abstract_variable_attribute")

#' Variable primal attribute
#' @export
setClass("MOI_variable_primal_attribute", contains = "MOI_abstract_variable_attribute")

#' Variable primal attribute
#' @export
setClass("MOI_variable_dual_attribute", contains = "MOI_abstract_variable_attribute")

#' Variable index attribute
#' @export
setClass("MOI_variable_index_attribute", contains = "MOI_abstract_variable_attribute")

#' A variable name attribute
#' @export
moi_variable_name <- new("MOI_variable_name_attribute")

#' A variable primal start attribute
#' @export
moi_variable_primal_start <- new("MOI_variable_primal_start_attribute")

#' A variable primal attribute
#' @export
moi_variable_primal <- new("MOI_variable_primal_attribute")

#' A variable dual attribute
#' @export
moi_variable_dual <- new("MOI_variable_dual_attribute")

#' The variable index
#' @param index optional index
#' @export
moi_variable_index <- function(index) {
  if (missing(index)) { #TODO: not sure if good idea
    new("MOI_variable_index_attribute")
  } else {
    new("MOI_variable_index", value = index)
  }
}