Namespaces | |
namespace | alias |
| |
namespace | symbol |
| |
Classes | |
class | Constants |
Constants. More... | |
class | Container |
GAMS Transfer Container stores (multiple) symbols. More... | |
class | EquationType |
GAMS Equation Type. More... | |
class | SpecialValues |
GAMS Special Values. More... | |
class | VariableType |
GAMS Variable Type. More... | |
Functions | |
function | Alias (in container, in varargin) |
GAMS Alias Creator. | |
function | Equation (in container, in varargin) |
GAMS Equation Creator. | |
function | Parameter (in container, in varargin) |
GAMS Parameter Creator. | |
function | Set (in container, in varargin) |
GAMS Set Creator. | |
function | UniverseAlias (in container, in varargin) |
GAMS Universe Alias Creator. | |
function | Variable (in container, in varargin) |
GAMS Variable Creator. | |
Detailed Description
Function Documentation
◆ Alias()
function Alias | ( | in | container, |
in | varargin | ||
) |
GAMS Alias Creator.
Creates a GAMS Alias and adds it to a container.
Required Arguments:
- container (
Container
): Container object this symbol should be stored in - name (
string
): name of alias - alias_with (
Set
orAlias
): symbol.Set to be linked to.
Example:
- See also
- alias.Set, Container.addAlias, Set
◆ Equation()
function Equation | ( | in | container, |
in | varargin | ||
) |
GAMS Equation Creator.
Creates a GAMS Equation and adds it to a container.
Required Arguments:
- container (
Container
): Container object this symbol should be stored in - name (
string
): Name of equation - type (
string
,int
or EquationType): Specifies the variable type, either asstring
, asinteger
given by any of the constants in EquationType or EquationType.
Optional Arguments:
- domain (
cellstr
orSet
): List of domains given either asstring
or as reference to a symbol.Set object. Default is{}
(for scalar).
Parameter Arguments:
- records: Equation records. Default is
[]
. - description (
string
): Description of symbol. Default is""
. - domain_forwarding (
logical
): Iftrue
, domain entries in records will recursively be added to the domains in case they are not present in the domains already. With a logical vector domain forwarding can be enabled/disabled independently for each domain. Default:false
.
Note, this method may overwrite an equation if its definition (type, domain, domain_forwarding) doesn't differ.
Example:
- See also
- symbol.Equation, Container.addEquation, EquationType
◆ Parameter()
function Parameter | ( | in | container, |
in | varargin | ||
) |
GAMS Parameter Creator.
Required Arguments:
- container (
Container
): Container object this symbol should be stored in - name (
string
): Name of parameter
Optional Arguments:
- domain (
cellstr
orSet
): List of domains given either asstring
or as reference to a symbol.Set object. Default is{}
(for scalar).
Parameter Arguments:
- records: Parameter records. Default is
[]
. - description (
string
): Description of symbol. Default is""
. - domain_forwarding (
logical
): Iftrue
, domain entries in records will recursively be added to the domains in case they are not present in the domains already. With a logical vector domain forwarding can be enabled/disabled independently for each domain. Default:false
.
Note, this method may overwrite a parameter if its definition (domain, domain_forwarding) doesn't differ.
Example:
- See also
- symbol.Parameter, Container.addParameter
◆ Set()
function Set | ( | in | container, |
in | varargin | ||
) |
GAMS Set Creator.
Required Arguments:
- container (
Container
): Container object this symbol should be stored in - name (
string
): Name of set
Optional Arguments:
- domain (
cellstr
orSet
): List of domains given either asstring
or as reference to a symbol.Set object. Default is{"*"}
(for 1-dim with universe domain).
Parameter Arguments:
- records: Set records, e.g. a list of strings. Default is
[]
. - description (
string
): Description of symbol. Default is""
. - is_singleton (
logical
): Indicates if set is a is_singleton set (true
) or not (false
). Default isfalse
. - domain_forwarding (
logical
): Iftrue
, domain entries in records will recursively be added to the domains in case they are not present in the domains already. With a logical vector domain forwarding can be enabled/disabled independently for each domain. Default:false
.
Note, this method may overwrite a set if its definition (is_singleton, domain, domain_forwarding) doesn't differ.
Example:
- See also
- symbol.Set, Container.addSet
◆ UniverseAlias()
function UniverseAlias | ( | in | container, |
in | varargin | ||
) |
GAMS Universe Alias Creator.
Required Arguments:
- container (
Container
): Container object this symbol should be stored in - name (
string
): name of alias
Example:
- See also
- alias.Universe, Container.addUniverseAlias
◆ Variable()
function Variable | ( | in | container, |
in | varargin | ||
) |
GAMS Variable Creator.
Required Arguments:
- container (
Container
): Container object this symbol should be stored in - name (
string
): Name of variable
Optional Arguments:
- type (
string
,int
or VariableType): Specifies the variable type, either asstring
, asinteger
given by any of the constants in VariableType or VariableType. Default is"free"
. - domain (
cellstr
orSet
): List of domains given either as string or as reference to a symbol.Set object. Default is{}
(for scalar).
Parameter Arguments:
- records: Set records, e.g. a list of strings. Default is
[]
. - description (
string
): Description of symbol. Default is""
. - domain_forwarding (
logical
): Iftrue
, domain entries in records will recursively be added to the domains in case they are not present in the domains already. With a logical vector domain forwarding can be enabled/disabled independently for each domain. Default:false
.
Note, this method may overwrite a variable if its definition (type, domain, domain_forwarding) doesn't differ.
Example:
- See also
- symbol.Variable, Container.addVariable, VariableType