gams.control.database.GamsSet Class Reference
This is the representation of a set symbol in GAMS. More...
Inheritance diagram for gams.control.database.GamsSet:
Properties | |
property | settype = property(get_settype) |
Retrieve subtype of set (SetType.Multi, SetType.Singleton) | |
Properties inherited from gams.control.database._GamsSymbol | |
property | domains = property(get_domains) |
Domains of Symbol, each element is either a GamsSet (real domain) or a string (relaxed domain) | |
property | domains_as_strings = property(get_domains_as_strings) |
Domains of Symbol, each element is a string. | |
property | dimension = property(get_dimension) |
Get GamsSymbol dimension. | |
property | text = property(get_text) |
Get explanatory text of GamsSymbol. | |
property | name = property(get_name) |
Get GamsSymbol name. | |
property | database = property(get_database) |
Get GamsDatabase containing GamsSymbol. | |
property | number_records = property(get_number_records) |
Retrieve the number of records of the GamsSymbol. | |
Additional Inherited Members | |
Public Member Functions inherited from gams.control.database._GamsSymbol | |
def | __len__ (self) |
Retrieve the number of records of the GamsSymbol. | |
def | copy_symbol (self, target) |
Copys all records from the GamsSymbol to the target GamsSymbol (if target had records, they will be deleted) | |
def | delete_record (self, keys=None) |
Delete GamsSymbol record. | |
def | clear (self) |
Clear symbol. | |
def | find_record (self, keys=None) |
Find record in GamsSymbol. | |
def | add_record (self, keys=None) |
Add record to GamsSymbol. | |
def | merge_record (self, keys=None) |
Finds record in GamsSymbol if it exists, adds it if not. | |
def | first_record (self, slice=None) |
Retrieve first record in GamsSymbol. | |
def | check_domains (self) |
Check if all records are within the specified domain of the symbol. | |
def | get_symbol_dvs (self, max_viol=0) |
return all GamsSymbolDomainViolations | |
Detailed Description
This is the representation of a set symbol in GAMS.
It exists in a GamsDatabase and contains GamsSetRecords which one can iterate through.