Loading...
Searching...
No Matches
Namespaces | Classes | Functions
matlab::gams::transfer Namespace Reference

  More...

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:

  1. container (Container): Container object this symbol should be stored in
  2. name (string): name of alias
  3. alias_with (Set or Alias): symbol.Set to be linked to.

Example:

c = Container();
s = Set(c, 's');
a = Alias(c, 'a', s);
matlab::gams::transfer::Container
GAMS Transfer Container stores (multiple) symbols.
Definition Container.m:67
matlab::gams::transfer::Alias
function Alias(in container, in varargin)
GAMS Alias Creator.
matlab::gams::transfer::Set
function Set(in container, in varargin)
GAMS Set Creator.
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:

  1. container (Container): Container object this symbol should be stored in
  2. name (string): Name of equation
  3. type (string, int or EquationType): Specifies the variable type, either as string, as integer given by any of the constants in EquationType or EquationType.

Optional Arguments:

  1. domain (cellstr or Set): List of domains given either as string 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): If true, 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:

c = Container();
e2 = Equation(c, 'e2', 'l', {'*', '*'});
e3 = Equation(c, 'e3', EquationType.EQ, '*', 'description', 'equ e3');
matlab::gams::transfer::Equation
function Equation(in container, in varargin)
GAMS Equation Creator.
See also
symbol.Equation, Container.addEquation, EquationType

◆ Parameter()

function Parameter ( in container,
in varargin )

GAMS Parameter Creator.

Required Arguments:

  1. container (Container): Container object this symbol should be stored in
  2. name (string): Name of parameter

Optional Arguments:

  1. domain (cellstr or Set): List of domains given either as string 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): If true, 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:

c = Container();
p1 = Parameter(c, 'p1');
p2 = Parameter(c, 'p2', {'*', '*'});
p3 = Parameter(c, 'p3', '*', 'description', 'par p3');
matlab::gams::transfer::Parameter
function Parameter(in container, in varargin)
GAMS Parameter Creator.
See also
symbol.Parameter, Container.addParameter

◆ Set()

function Set ( in container,
in varargin )

GAMS Set Creator.

Required Arguments:

  1. container (Container): Container object this symbol should be stored in
  2. name (string): Name of set

Optional Arguments:

  1. domain (cellstr or Set): List of domains given either as string 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 is false.
  • domain_forwarding (logical): If true, 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:

c = Container();
s1 = Set(c, 's1');
s2 = Set(c, 's2', {s1, '*', '*'});
s3 = Set(c, 's3', '*', 'records', {'e1', 'e2', 'e3'}, 'description', 'set s3');
See also
symbol.Set, Container.addSet

◆ UniverseAlias()

function UniverseAlias ( in container,
in varargin )

GAMS Universe Alias Creator.

Required Arguments:

  1. container (Container): Container object this symbol should be stored in
  2. name (string): name of alias

Example:

c = Container();
u = UniverseAlias(c, 'u');
matlab::gams::transfer::UniverseAlias
function UniverseAlias(in container, in varargin)
GAMS Universe Alias Creator.
See also
alias.Universe, Container.addUniverseAlias

◆ Variable()

function Variable ( in container,
in varargin )

GAMS Variable Creator.

Required Arguments:

  1. container (Container): Container object this symbol should be stored in
  2. name (string): Name of variable

Optional Arguments:

  1. type (string, int or VariableType): Specifies the variable type, either as string, as integer given by any of the constants in VariableType or VariableType. Default is "free".
  2. domain (cellstr or Set): 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): If true, 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:

c = Container();
v1 = Variable(c, 'v1');
v2 = Variable(c, 'v2', 'binary', {'*', '*'});
v3 = Variable(c, 'v3', VariableType.BINARY, '*', 'description', 'var v3');
matlab::gams::transfer::Variable
function Variable(in container, in varargin)
GAMS Variable Creator.
See also
symbol.Variable, Container.addVariable, VariableType