feat: market

DESCRIPTION

@@ -66,13 +66,16 @@ Collate:
     'Individual.R'
     'Household.R'
     'Log.R'
+    'Market.R'
     'MatchingMarket.R'
     'MatchingMarketOptimal.R'
     'MatchingMarketStochastic.R'
     'Model.R'
     'Network.R'
     'Population.R'
     'Pipeline.R'
+    'SearchStrategy.R'
+    'SelectStrategy.R'
     'Transition.R'
     'TransitionClassification.R'
     'TransitionRegression.R'

NAMESPACE

@@ -21,13 +21,16 @@ export(Generic)
 export(History)
 export(Household)
 export(Individual)
+export(Market)
 export(MatchingMarket)
 export(MatchingMarketOptimal)
 export(MatchingMarketStochastic)
 export(Model)
 export(Network)
 export(Pipeline)
 export(Population)
+export(SearchStrategy)
+export(SelectStrategy)
 export(SupportedTransitionModels)
 export(Transition)
 export(TransitionClassification)

R/Market.R

@@ -0,0 +1,41 @@
+#' Market class
+#'
+#' @description
+#' A market class.
+#'
+#' @include Generic.R
+#' @export
+Market <- R6Class(
+  classname = "Market",
+  inherit = Generic,
+  public = list(
+    #' @description
+    #' Create a new market object.
+    #'
+    #' @param ... dots
+    #'
+    #' @return `NULL`
+    #'
+    #' @examples
+    #'
+    #' Mrkt <- Market$new()
+    initialize = function(...) {
+
+    },
+
+
+    #' @description
+    #' Match agents with choices
+    #'
+    #' @param agents a vector containing agent ids
+    #' @param choices a vector containing choice ids
+    #' @param probabilities a vector containing numerical probability values
+    #'
+    #' @return a [data.table::data.table] with two columns: `agent_id` and `choice_id`.
+    match = function(agents, choices, probabilities) {
+
+    }
+  ),
+
+  private = list()
+)

R/SearchStrategy.R

@@ -0,0 +1,51 @@
+#' R6 Class Containing a search strategy for agents.
+#'
+#' @description
+#' This is the base class for implementing a search strategy.
+#'
+#' @details
+#' A search strategy to be adopted by agents when they are in a market.
+#'
+#' @include Generic.R
+#' @export
+SearchStrategy <- R6Class(
+  classname = "SearchStrategy",
+  inherit = dymiumCore::Generic,
+  public = list(
+
+    #' @description
+    #' Create a search strategy object.
+    #'
+    #' @param ... dots
+    #'
+    #' @return `NULL`
+    #' @export
+    #'
+    #' @examples
+    #'
+    #' SS <- SearchStrategy$new()
+    initialize = function(...){
+      self$set()
+    },
+
+    set = function() {
+      private$abstract()
+    },
+
+    simulate = function() {
+      private$abstract()
+    },
+
+    filter = function() {
+      private$abstract()
+    },
+
+    evaluate = function() {
+      private$abstract()
+    }
+  ),
+
+  private = list(
+
+  )
+)

R/SelectStrategy.R

@@ -0,0 +1,39 @@
+#' R6 Class Containing a select strategy for agents.
+#'
+#' @description
+#' This is the base class for implementing a select strategy.
+#'
+#' @details
+#' A select strategy to be adopted by agents when they are in a market.
+#'
+#' @include Generic.R
+#' @export
+SelectStrategy <- R6Class(
+  classname = "SelectStrategy",
+  inherit = dymiumCore::Generic,
+  public = list(
+
+    #' @description
+    #' Create a select strategy object.
+    #'
+    #' @param ... dots
+    #'
+    #' @return `NULL`
+    #' @export
+    #'
+    #' @examples
+    #'
+    #' SS <- SearchStrategy$new()
+    initialize = function(...){
+
+    },
+
+    set = function() {
+
+    }
+  ),
+
+  private = list(
+
+  )
+)