Container: Container Class

In gamstransfer: A Data Interface Between 'GAMS' and R

Container Class

Description

The main object class within GAMS Transfer is called Container. The Container is the vessel that allows symbols to be linked together (through their domain definitions), it enables implicit set definitions, it enables structural manipulations of the data (matrix generation), and it allows the user to perform different read/write operations. Please visit https://www.gams.com/latest/docs/API_R_GAMSTRANSFER.html for detailed documentation of this package.

Create a new container simply by initializing an object.

Arguments

loadFrom

optional argument to point to the GDX file being read into the Container

Fields

data

is a named list containing all symbol data

Examples

m = Container$new()
i = m$addSet("i")
j = m$addSet("j")
all_symbols = m$listSymbols()
set_description = m$describeSets()
# create a container and read the file trnsport.gdx
m = Container$new(system.file("extdata", "trnsport.gdx", package = "gamstransfer"))
# access symbol named "x" from the container
x = m["x"]
# list all symbols
all_symbols = m$listSymbols()
# list all sets
all_sets = m$listSets()
# check if the container contains symbol named "i"
has_i = m$hasSymbols("i")
# get a summary of the description of all sets in the Container
set_description = m$describeSets()

gamstransfer documentation built on June 22, 2024, 10:26 a.m.