gamsapi 52.5.0__cp312-cp312-win_amd64.whl

gams/tools/tools.py

@@ -0,0 +1,116 @@
+#
+# GAMS - General Algebraic Modeling System Python API
+#
+# Copyright (c) 2017-2026 GAMS Development Corp. <support@gams.com>
+# Copyright (c) 2017-2026 GAMS Software GmbH <support@gams.com>
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in all
+# copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+# SOFTWARE.
+#
+
+import os
+import sys
+import importlib
+from gams.tools.errors import GamsToolsException
+
+class Tools(object):
+    def __init__(self, system_directory, ecdb=None, argv=[]):
+        self._system_directory = system_directory
+        self._ecdb = ecdb
+        self._argv = argv
+
+
+    def print_log(self, msg):
+        if self._ecdb:
+            self._ecdb.printLog(msg)
+        else:
+            print(msg)
+            sys.stdout.flush()
+
+    def all_tools(self):
+        from pkgutil import iter_modules
+        import importlib
+        import gams.tools.toolcollection as gtc
+        d = {}
+        for mod in iter_modules(gtc.__path__):
+            if mod.name != 'tooltemplate':
+                d[mod.name] = [m.name for m in iter_modules(importlib.import_module(gtc.__package__ + "." + mod.name).__path__)]
+        return d
+
+    def help(self, tc, category='', long=True):
+        if len(category):
+            self.print_log(f'List of tools in {category}:')
+            cats = [category]
+        else:
+            self.print_log('List of tools:')
+            cats = list(tc.keys())
+        for cat in cats:            
+            if not len(category):
+                self.print_log(f'  {cat}:')
+            for tool in tc[cat]:
+                try:
+                    mod = importlib.import_module(f"gams.tools.toolcollection.{cat}.{tool}")
+                except ModuleNotFoundError as e:
+                    if e.name != "gams.tools.toolcollection.{cat}.{tool}": # the tool module itself was found but an import in the source itself did fail
+                        raise e
+                    mod = importlib.import_module(tool)
+                task_class = vars(mod)[tool.capitalize()]
+                task_instance = task_class(self._system_directory, self)
+                task_instance.help(prefix='    ', long=long)
+
+    def exec_tool(self):
+        tc = self.all_tools()
+        if len(self._argv) == 0 or self._argv[0] == '-h':
+            self.help(tc, long=False)
+            return
+        if len(self._argv) == 0 or self._argv[0] == '--help':
+            self.help(tc)
+            return
+        ct = self._argv[0]
+        if '.' in ct:
+            cat, tool = [ s.lower() for s in ct.split('.') ]
+        else:
+            tool = ct.lower()
+            cat = []
+            for c,tl in tc.items():
+                if tool in tl:
+                    cat.append(c)
+            if len(cat) == 0: # could be cat -h
+                if tool in tc and (len(self._argv) == 1 or self._argv[1] == '-h'):
+                    self.help(tc, category=tool, long=False)
+                    return
+                if tool in tc and (len(self._argv) == 1 or self._argv[1] == '--help'):
+                    self.help(tc, category=tool)
+                    return
+                raise GamsToolsException(f'No tool {tool} found.', error_code=2, traceback=False)
+            if len(cat) > 1:
+                raise GamsToolsException(f'Tool {tool} found in following categories: {cat}. Use e.g. {cat[0]}.{tool} to select specific tool.', error_code=2, traceback=False)
+            cat = cat[0]
+        try:
+            mod = importlib.import_module(f"gams.tools.toolcollection.{cat}.{tool}")
+        except ModuleNotFoundError as e:
+            if e.name != "gams.tools.toolcollection.{cat}.{tool}": # the tool module itself was found but an import in the source itself did fail
+                raise GamsToolsException(str(e), error_code=2, traceback=False)
+            mod = importlib.import_module(tool)
+        task_class = vars(mod)[tool.capitalize()]
+        task_instance = task_class(self._system_directory, self)
+        task_instance.execute()
+            
+    def _get_ecdb(self):
+        return self._ecdb
+    ecdb = property(_get_ecdb)

gams/transfer/__init__.py

@@ -0,0 +1,35 @@
+#
+# GAMS - General Algebraic Modeling System Python API
+#
+# Copyright (c) 2017-2026 GAMS Development Corp. <support@gams.com>
+# Copyright (c) 2017-2026 GAMS Software GmbH <support@gams.com>
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in all
+# copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+# SOFTWARE.
+#
+
+from gams.transfer._internals import CasePreservingDict, SpecialValues, DomainViolation
+from gams.transfer.containers import Container
+from gams.transfer.syms import (
+    Set,
+    Parameter,
+    Variable,
+    Equation,
+    Alias,
+    UniverseAlias,
+)

gams/transfer/_abcs/__init__.py

@@ -0,0 +1,37 @@
+#
+# GAMS - General Algebraic Modeling System Python API
+#
+# Copyright (c) 2017-2026 GAMS Development Corp. <support@gams.com>
+# Copyright (c) 2017-2026 GAMS Software GmbH <support@gams.com>
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in all
+# copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+# SOFTWARE.
+#
+
+from gams.transfer._abcs.container_abcs import (
+    ABCContainer,
+    ABCSet,
+    ABCParameter,
+    ABCVariable,
+    ABCEquation,
+    ABCAlias,
+    ABCUniverseAlias,
+    AnyContainerSymbol,
+    AnyContainerDomainSymbol,
+    AnyContainerAlias,
+)

gams/transfer/_abcs/container_abcs.py

@@ -0,0 +1,433 @@
+#
+# GAMS - General Algebraic Modeling System Python API
+#
+# Copyright (c) 2017-2026 GAMS Development Corp. <support@gams.com>
+# Copyright (c) 2017-2026 GAMS Software GmbH <support@gams.com>
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in all
+# copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+# SOFTWARE.
+#
+
+from abc import ABC, abstractmethod
+
+
+class AnyContainerSymbol: ...
+
+
+class AnyContainerDomainSymbol: ...
+
+
+class AnyContainerAlias: ...
+
+
+class ABC_SAPVE_Container(ABC):
+    @abstractmethod
+    def __init__(self): ...
+
+    @abstractmethod
+    def __repr__(self): ...
+
+    @abstractmethod
+    def _assert_is_valid(self): ...
+
+    @abstractmethod
+    def countDomainViolations(self): ...
+
+    @abstractmethod
+    def countDuplicateRecords(self): ...
+
+    @abstractmethod
+    def dropDomainViolations(self): ...
+
+    @abstractmethod
+    def dropDuplicateRecords(self): ...
+
+    @abstractmethod
+    def getDomainViolations(self): ...
+
+    @abstractmethod
+    def getUELs(self): ...
+
+    @abstractmethod
+    def lowerUELs(self): ...
+
+    @abstractmethod
+    def upperUELs(self): ...
+
+    @abstractmethod
+    def lstripUELs(self): ...
+
+    @abstractmethod
+    def rstripUELs(self): ...
+
+    @abstractmethod
+    def stripUELs(self): ...
+
+    @abstractmethod
+    def capitalizeUELs(self): ...
+
+    @abstractmethod
+    def casefoldUELs(self): ...
+
+    @abstractmethod
+    def titleUELs(self): ...
+
+    @abstractmethod
+    def ljustUELs(self): ...
+
+    @abstractmethod
+    def rjustUELs(self): ...
+
+    @abstractmethod
+    def hasDomainViolations(self): ...
+
+    @abstractmethod
+    def hasDuplicateRecords(self): ...
+
+    @abstractmethod
+    def isValid(self): ...
+
+    @abstractmethod
+    def modified(self): ...
+
+    @abstractmethod
+    def removeUELs(self): ...
+
+    @abstractmethod
+    def renameUELs(self): ...
+
+
+class ABC_SAPVE_UA(ABC):
+    @abstractmethod
+    def __init__(self): ...
+
+    @abstractmethod
+    def __repr__(self): ...
+
+    @abstractmethod
+    def _assert_is_valid(self): ...
+
+    @abstractmethod
+    def description(self): ...
+
+    @abstractmethod
+    def dimension(self): ...
+
+    @abstractmethod
+    def domain(self): ...
+
+    @abstractmethod
+    def domain_labels(self): ...
+
+    @abstractmethod
+    def domain_names(self): ...
+
+    @abstractmethod
+    def domain_type(self): ...
+
+    @abstractmethod
+    def equals(self): ...
+
+    @abstractmethod
+    def getSparsity(self): ...
+
+    @abstractmethod
+    def getUELs(self): ...
+
+    @abstractmethod
+    def isValid(self): ...
+
+    @abstractmethod
+    def modified(self): ...
+
+    @abstractmethod
+    def name(self): ...
+
+    @abstractmethod
+    def number_records(self): ...
+
+    @abstractmethod
+    def pivot(self): ...
+
+    @abstractmethod
+    def records(self): ...
+
+    @abstractmethod
+    def container(self): ...
+
+    @abstractmethod
+    def summary(self): ...
+
+    @abstractmethod
+    def toList(self): ...
+
+
+class ABC_SAPVE(ABC):
+    @abstractmethod
+    def _getUELCodes(self): ...
+
+    @abstractmethod
+    def addUELs(self): ...
+
+    @abstractmethod
+    def countDomainViolations(self): ...
+
+    @abstractmethod
+    def countDuplicateRecords(self): ...
+
+    @abstractmethod
+    def dropDomainViolations(self): ...
+
+    @abstractmethod
+    def dropDuplicateRecords(self): ...
+
+    @abstractmethod
+    def findDomainViolations(self): ...
+
+    @abstractmethod
+    def findDuplicateRecords(self): ...
+
+    @abstractmethod
+    def getDomainViolations(self): ...
+
+    @abstractmethod
+    def hasDomainViolations(self): ...
+
+    @abstractmethod
+    def hasDuplicateRecords(self): ...
+
+    @abstractmethod
+    def removeUELs(self): ...
+
+    @abstractmethod
+    def renameUELs(self): ...
+
+    @abstractmethod
+    def reorderUELs(self): ...
+
+    @abstractmethod
+    def setRecords(self): ...
+
+    @abstractmethod
+    def setUELs(self): ...
+
+
+class ABC_SPVE(ABC):
+    @abstractmethod
+    def _assert_scalar_values(self): ...
+
+    @abstractmethod
+    def _assert_symbol_attributes(self): ...
+
+    @abstractmethod
+    def _assert_symbol_domains(self): ...
+
+    @abstractmethod
+    def _attributes(self): ...
+
+    @abstractmethod
+    def _domainForwarding(self): ...
+
+    @abstractmethod
+    def _merge_records(self): ...
+
+    @abstractmethod
+    def domain_forwarding(self): ...
+
+    @abstractmethod
+    def _domain_status(self): ...
+
+    @abstractmethod
+    def generateRecords(self): ...
+
+
+class ABC_SAUA(ABC):
+    @abstractmethod
+    def is_singleton(self): ...
+
+
+class ABC_PVE(ABC):
+    @abstractmethod
+    def _assert_symbol_values(self): ...
+
+    @abstractmethod
+    def _filter_zero_records(self): ...
+
+    @abstractmethod
+    def _countSpecialValues(self): ...
+
+    @abstractmethod
+    def _getMetric(self): ...
+
+    @abstractmethod
+    def _whereMetric(self): ...
+
+    @abstractmethod
+    def countEps(self): ...
+
+    @abstractmethod
+    def countNA(self): ...
+
+    @abstractmethod
+    def countNegInf(self): ...
+
+    @abstractmethod
+    def countPosInf(self): ...
+
+    @abstractmethod
+    def countUndef(self): ...
+
+    @abstractmethod
+    def findEps(self): ...
+
+    @abstractmethod
+    def findNA(self): ...
+
+    @abstractmethod
+    def findNegInf(self): ...
+
+    @abstractmethod
+    def findPosInf(self): ...
+
+    @abstractmethod
+    def findSpecialValues(self): ...
+
+    @abstractmethod
+    def findUndef(self): ...
+
+    @abstractmethod
+    def getMaxAbsValue(self): ...
+
+    @abstractmethod
+    def getMaxValue(self): ...
+
+    @abstractmethod
+    def getMeanValue(self): ...
+
+    @abstractmethod
+    def getMinValue(self): ...
+
+    @abstractmethod
+    def is_scalar(self): ...
+
+    @abstractmethod
+    def shape(self): ...
+
+    @abstractmethod
+    def toDense(self): ...
+
+    @abstractmethod
+    def toDict(self): ...
+
+    @abstractmethod
+    def toSparseCoo(self): ...
+
+    @abstractmethod
+    def toValue(self): ...
+
+    @abstractmethod
+    def whereMax(self): ...
+
+    @abstractmethod
+    def whereMaxAbs(self): ...
+
+    @abstractmethod
+    def whereMin(self): ...
+
+
+class ABC_VE(ABC):
+    @abstractmethod
+    def type(self): ...
+
+
+class ABC_AUA(ABC):
+    @abstractmethod
+    def alias_with(self): ...
+
+
+class ABCSet(
+    AnyContainerSymbol,
+    AnyContainerDomainSymbol,
+    ABC_SAPVE_Container,
+    ABC_SAPVE_UA,
+    ABC_SAPVE,
+    ABC_SPVE,
+    ABC_SAUA,
+): ...
+
+
+class ABCParameter(
+    AnyContainerSymbol,
+    ABC_SAPVE_Container,
+    ABC_SAPVE_UA,
+    ABC_SAPVE,
+    ABC_SPVE,
+    ABC_PVE,
+): ...
+
+
+class ABCVariable(
+    AnyContainerSymbol,
+    ABC_SAPVE_Container,
+    ABC_SAPVE_UA,
+    ABC_SAPVE,
+    ABC_SPVE,
+    ABC_PVE,
+    ABC_VE,
+): ...
+
+
+class ABCEquation(
+    AnyContainerSymbol,
+    ABC_SAPVE_Container,
+    ABC_SAPVE_UA,
+    ABC_SAPVE,
+    ABC_SPVE,
+    ABC_PVE,
+    ABC_VE,
+): ...
+
+
+class ABCAlias(
+    AnyContainerSymbol,
+    AnyContainerDomainSymbol,
+    AnyContainerAlias,
+    ABC_SAPVE_Container,
+    ABC_SAPVE_UA,
+    ABC_SAPVE,
+    ABC_SAUA,
+    ABC_AUA,
+): ...
+
+
+class ABCUniverseAlias(
+    AnyContainerSymbol,
+    AnyContainerDomainSymbol,
+    AnyContainerAlias,
+    ABC_SAPVE_UA,
+    ABC_SAUA,
+    ABC_AUA,
+): ...
+
+
+class ABCContainer(ABC_SAPVE_Container):
+    @abstractmethod
+    def summary(self): ...
+
+    @abstractmethod
+    def hasSymbols(self): ...

gams/transfer/_internals/__init__.py

@@ -0,0 +1,63 @@
+#
+# GAMS - General Algebraic Modeling System Python API
+#
+# Copyright (c) 2017-2026 GAMS Development Corp. <support@gams.com>
+# Copyright (c) 2017-2026 GAMS Software GmbH <support@gams.com>
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in all
+# copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+# SOFTWARE.
+#
+
+from gams.transfer._internals.casepreservingdict import CasePreservingDict
+
+from gams.transfer._internals.specialvalues import SpecialValues
+
+from gams.transfer._internals.constants import (
+    GAMS_SYMBOL_MAX_LENGTH,
+    GAMS_UEL_MAX_LENGTH,
+    GAMS_DESCRIPTION_MAX_LENGTH,
+    GAMS_MAX_INDEX_DIM,
+    SourceType,
+    DestinationType,
+    DomainStatus,
+    DictFormat,
+    EPS,
+    UNDEF,
+    NA,
+    VAR_DEFAULT_VALUES,
+    EQU_TYPE,
+    EQU_DEFAULT_VALUES,
+    DICT_FORMAT,
+    GAMS_VARIABLE_SUBTYPES,
+    GAMS_EQUATION_SUBTYPES,
+    TRANSFER_TO_GAMS_VARIABLE_SUBTYPES,
+    TRANSFER_TO_GAMS_EQUATION_SUBTYPES,
+    GAMS_DOMAIN_STATUS,
+)
+
+from gams.transfer._internals.domainviolation import DomainViolation
+
+from gams.transfer._internals.algorithms import (
+    cartesian_product,
+    choice_no_replace,
+    generate_unique_labels,
+    convert_to_categoricals_cat,
+    convert_to_categoricals_str,
+    get_keys_and_values,
+    check_all_same,
+)