GAMS Alias to Universe. More...

Inheritance diagram for Universe:

GAMS Alias to Universe.

This class represents a GAMS Alias to Universe.

Example:

c = Container();

u = alias.Universe.construct(c, 'u');

matlab::gams::transfer::Container

GAMS Transfer Container stores (multiple) symbols.

Definition: Container.m:67

See also: UniverseAlias, Container.addUniverseAlias

Public Member Functions
function	copy (in obj, in varargin)
	Copies symbol to destination container.

function	isValid (in obj, in varargin)
	Checks correctness of alias.

function	getUELs (in obj, in varargin)
	Returns the UELs used in all symbols.

function	removeUELs (in obj, in varargin)
	Removes UELs from all symbols.

function	renameUELs (in obj, in varargin)
	Renames UELs in all symbols.

function	lowerUELs (in obj, in varargin)
	Converts UELs to lower case.

function	upperUELs (in obj, in varargin)
	Converts UELs to lower case.

Public Member Functions inherited from Abstract
function	copy (in obj, in varargin)
	(Abstract) Copies symbol to destination container

function	equals (in obj, in symbol)
	Checks equivalence with other symbol.

function	isValid (in obj, in varargin)
	(Abstract) Checks correctness of alias

function	getUELs (in obj, in varargin)
	(Abstract) Returns the UELs used in this symbol

function	removeUELs (in obj, in varargin)
	(Abstract) Removes UELs from the symbol

function	renameUELs (in obj, in uels)
	(Abstract) Renames UELs in the symbol

function	lowerUELs (in obj)
	(Abstract) Converts UELs to lower case

function	upperUELs (in obj)
	(Abstract) Converts UELs to lower case

Static Public Member Functions
static function	construct (in container, in name)
	Constructs a GAMS Alias.

Static Public Member Functions inherited from Abstract
static function	describe (in symbols)
	Returns an overview over all aliases given.

Public Attributes
Property	alias_with
	Aliased symbol.

Property	description
	Aliased GAMS Set description.

Property	is_singleton
	Indicator if aliased GAMS Set is singleton.

Property	dimension
	Aliased GAMS Set dimension (in [0,20])

Property	size
	Aliased GAMS Set Shape (length == dimension)

Property	domain
	Aliased GAMS Set domain (length == dimension)

Property	domain_labels
	Expected domain labels in records.

Property	domain_forwarding
	Enables domain forwarding in aliased symbol.

Property	records
	Storage of aliased Set records.

Public Attributes inherited from Abstract
Property	container
	Container the symbol is stored in.

Property	name
	Alias name.

Property	alias_with
	(Abstract) Aliased symbol

Property	description
	(Abstract) Aliased GAMS Set description

Property	is_singleton
	(Abstract) Indicator if aliased GAMS Set is singleton

Property	dimension
	(Abstract) Aliased GAMS Set dimension (in [0,20])

Property	size
	(Abstract) Aliased GAMS Set Shape (length == dimension)

Property	domain
	(Abstract) Aliased GAMS Set domain (length == dimension)

Property	domain_labels
	(Abstract) Expected domain labels in records

Property	domain_forwarding
	(Abstract) Enables domain forwarding in aliased symbol

Property	records
	(Abstract) Storage of aliased Set records

Property	modified
	Flag to indicate modification.

Private Attributes
Property	domain_names
	Aliased GAMS Set domain names.

Property	domain_type
	Specifies if domains are stored 'relaxed' or 'regular'.

Property	format
	Records format of aliased Set records.

Member Function Documentation

◆ construct()

static function construct	(	in	container,
		in	name
	)

static

Constructs a GAMS Alias.

See Creating a Symbol for more information.

Required Arguments:

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

Example:

c = Container();

u = alias.Universe.construct(c, 'u');

See also: UniverseAlias, Container.addUniverseAlias

◆ copy()

function copy	(	in	obj,
		in	varargin
	)

Copies symbol to destination container.

If destination container does not have a symbol equal to the aliased symbol, an error is raised.

Required Arguments:

destination (Container): Destination container

Optional Arguments:

overwrite (bool): Overwrites symbol with same name in destination if true. Default: false.

◆ getUELs()

function getUELs	(	in	obj,
		in	varargin
	)

Returns the UELs used in all symbols.

See also: Container.getUELs

◆ isValid()

function isValid	(	in	obj,
		in	varargin
	)

Checks correctness of alias.

Optional Arguments:

verbose (logical): If true, the reason for an invalid symbol is printed
force (logical): If true, forces reevaluation of validity (resets cache)

◆ lowerUELs()

function lowerUELs	(	in	obj,
		in	varargin
	)

Converts UELs to lower case.

See also: Container.lowerUELs

◆ removeUELs()

function removeUELs	(	in	obj,
		in	varargin
	)

Removes UELs from all symbols.

See also: Container.removeUELs

◆ renameUELs()

function renameUELs	(	in	obj,
		in	varargin
	)

Renames UELs in all symbols.

See also: Container.renameUELs

◆ upperUELs()

function upperUELs	(	in	obj,
		in	varargin
	)