gamsapi 52.5.0__cp312-cp312-win_amd64.whl

gams/transfer/syms/__init__.py

@@ -0,0 +1,33 @@
+#
+# 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.syms.container_syms import (
+    Set,
+    Parameter,
+    Variable,
+    Equation,
+    Alias,
+    UniverseAlias,
+)

gams/transfer/syms/_methods/__init__.py

@@ -0,0 +1,24 @@
+#
+# 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.
+#

gams/transfer/syms/_methods/tables.py

@@ -0,0 +1,120 @@
+#
+# 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 pandas as pd
+import numpy as np
+
+AXES = ["index", "columns"]
+
+
+def _get_implied_dimension_from_axes(records):
+    return sum([axis.nlevels for axis in records.axes])
+
+
+def _assert_axes_no_nans(records):
+    for axis_name, axis in zip(AXES, records.axes):
+        if isinstance(axis, pd.MultiIndex):
+            axis_as_frame = pd.DataFrame(np.array(axis.tolist(), dtype=object))
+            for n in range(axis.nlevels):
+                if axis_as_frame.iloc[:, n].hasnans:
+                    raise Exception(
+                        "Tabular 'records' cannot have missing index information "
+                        f"(i.e., NaNs detected in 'records.{axis_name} level_index={n}')"
+                    )
+        else:
+            if axis.hasnans:
+                raise Exception(
+                    "Tabular 'records' cannot have missing index information "
+                    f"(i.e., NaNs detected in 'records.{axis_name}')"
+                )
+
+
+def _flatten_and_convert(records):
+    AXES = ["index", "columns"]
+    drop_needed = False
+    for axis_name, axis in zip(AXES, records.axes):
+        idx = pd.DataFrame(columns=list(range(axis.nlevels)))
+
+        # go through axis
+        axis_as_frame = pd.DataFrame(np.array(axis.tolist(), dtype=object))
+        for n in range(axis.nlevels):
+            level = axis.levels[n] if hasattr(axis, "levels") else axis
+
+            # factorize
+            # preserve order of appearance, not lexicographical order + str/rstrip
+            codes, cats = pd.Series(
+                map(str.rstrip, map(str, axis_as_frame.iloc[:, n]))
+            ).factorize()
+
+            # create categorical
+            categorical = pd.Categorical.from_codes(
+                codes, categories=cats, ordered=True
+            )
+
+            # preserve user order if CategoricalDtype
+            if isinstance(level.dtype, pd.CategoricalDtype):
+                categorical = categorical.reorder_categories(
+                    dict.fromkeys(map(str.rstrip, level.categories)),
+                    ordered=True,
+                )
+
+            # set
+            idx.isetitem(n, categorical)
+
+        # TODO: need a workaround here to avoid an error with pandas stack
+        if axis_name == "columns":
+            if idx.set_index(list(idx.columns)).index.has_duplicates:
+                drop_needed = True
+                idx["__ai"] = range(len(idx))
+
+        # create categorical index and set on records
+        setattr(records, axis_name, idx.set_index(list(idx.columns)).index)
+
+        # remove names
+        getattr(records, axis_name).names = [None] * getattr(records, axis_name).nlevels
+
+    if isinstance(records, pd.DataFrame):
+        major, minor, *_ = pd.__version__.split(".")
+        major, minor = (int(major), int(minor))
+
+        # TODO: remove in future... allows support for pandas < 2.1.0
+        if (major, minor) >= (2, 2):
+            to_drop = (records.index.nlevels - 1) + (records.columns.nlevels)
+            records = records.stack(
+                list(range(records.columns.nlevels)),
+                future_stack=True,
+            ).reset_index(drop=False)
+        else:
+            to_drop = (records.index.nlevels - 1) + (records.columns.nlevels)
+            records = records.stack(
+                list(range(records.columns.nlevels)), dropna=False
+            ).reset_index(drop=False)
+
+        if drop_needed:
+            records.drop(columns=records.columns[to_drop], inplace=True)
+    else:
+        records = records.reset_index(drop=False)
+
+    return records

gams/transfer/syms/_methods/toDict.py

@@ -0,0 +1,115 @@
+#
+# 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 DICT_FORMAT, DictFormat
+
+
+def _toDict_orient_chk(orient):
+    if orient is None:
+        orient = "natural"
+
+    if orient.casefold() not in DICT_FORMAT.keys():
+        raise ValueError(
+            f"Argument 'orient' expects one of the following (mixed-case OK): {list(DICT_FORMAT.keys())}"
+        )
+
+    return DICT_FORMAT[orient.casefold()]
+
+
+def toDictParameter(symbol, orient=None):
+    # check and/or set orient
+    orient = _toDict_orient_chk(orient)
+
+    if symbol.is_scalar:
+        raise TypeError(
+            f"Symbol `{symbol.name}` is a scalar and cannot be converted into a dict."
+        )
+
+    if symbol.records is not None:
+        if orient is DictFormat.NATURAL:
+            if symbol.dimension == 1:
+                return dict(zip(symbol.records.iloc[:, 0], symbol.records.iloc[:, -1]))
+
+            else:
+                doms = zip(
+                    *[symbol.records.iloc[:, i] for i in range(symbol.dimension)]
+                )
+                vals = symbol.records[symbol.records.columns[-1]]
+
+                return dict(zip(doms, vals))
+
+        if orient is DictFormat.COLUMNS:
+            return symbol.records.to_dict()
+
+
+def toDictVariableEquation(symbol, columns=None, orient=None):
+    # check and/or set orient
+    orient = _toDict_orient_chk(orient)
+
+    # ARG: columns
+    # set defaults
+    if columns is None:
+        columns = "level"
+
+    # checks
+    if not isinstance(columns, (str, list)):
+        raise TypeError(
+            f"Argument 'columns' must be type str or list. User passed {type(columns)}."
+        )
+
+    if isinstance(columns, str):
+        columns = [columns]
+
+    if any(not isinstance(i, str) for i in columns):
+        raise TypeError(f"Argument 'columns' must contain only type str.")
+
+    if any(i not in symbol._attributes for i in columns):
+        raise TypeError(
+            f"Argument 'columns' must be a subset of the following: {symbol._attributes}"
+        )
+
+    if symbol.is_scalar:
+        raise TypeError(
+            f"Symbol `{symbol.name}` is a scalar and cannot be converted into a dict."
+        )
+
+    if symbol.records is not None:
+        if orient is DictFormat.NATURAL:
+            if symbol.dimension == 1:
+                doms = symbol.records.iloc[:, 0]
+            else:
+                doms = zip(
+                    *[symbol.records.iloc[:, i] for i in range(symbol.dimension)]
+                )
+
+            if len(columns) == 1:
+                return dict(zip(doms, symbol.records[columns[0]]))
+            else:
+                vals = symbol.records[columns].to_dict("records")
+
+                return dict(zip(doms, vals))
+
+        if orient is DictFormat.COLUMNS:
+            return symbol.records[symbol.domain_labels + columns].to_dict()

gams/transfer/syms/_methods/toList.py

@@ -0,0 +1,83 @@
+#
+# 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.
+#
+
+
+def toListSet(symbol, include_element_text=False):
+    if not isinstance(include_element_text, bool):
+        raise TypeError("Argument 'include_element_text' must be type bool")
+
+    if symbol.records is not None:
+        if include_element_text:
+            return symbol.records.set_index(
+                symbol.records.columns.to_list()
+            ).index.to_list()
+        else:
+            return symbol.records.set_index(
+                symbol.records.columns.to_list()[: symbol.dimension]
+            ).index.to_list()
+
+
+def toListParameter(symbol):
+    if symbol.records is not None:
+        if symbol.is_scalar:
+            return list(symbol.records.iloc[:, 0])
+        else:
+            return list(
+                zip(
+                    *[
+                        symbol.records.iloc[:, x]
+                        for x in range(len(symbol.records.columns))
+                    ]
+                )
+            )
+
+
+def toListVariableEquation(symbol, columns=None):
+    # ARG: columns
+    # set defaults
+    if columns is None:
+        columns = "level"
+
+    # checks
+    if not isinstance(columns, (str, list)):
+        raise TypeError(
+            f"Argument 'columns' must be type str or list. User passed {type(columns)}."
+        )
+
+    if isinstance(columns, str):
+        columns = [columns]
+
+    if any(not isinstance(i, str) for i in columns):
+        raise TypeError(f"Argument 'columns' must contain only type str.")
+
+    if any(i not in symbol._attributes for i in columns):
+        raise TypeError(
+            f"Argument 'columns' must be a subset of the following: {symbol._attributes}"
+        )
+
+    if symbol.records is not None:
+        return symbol.records.set_index(
+            [i for i in symbol.domain_labels + columns]
+        ).index.to_list()

gams/transfer/syms/_methods/toValue.py

@@ -0,0 +1,60 @@
+#
+# 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.
+#
+
+
+def toValueParameter(symbol):
+    if not symbol.is_scalar:
+        raise TypeError(
+            "Cannot extract value data for non-scalar symbols "
+            f"(symbol dimension is {symbol.dimension})"
+        )
+
+    if symbol.records is not None:
+        return symbol.records["value"][0]
+
+
+def toValueVariableEquation(symbol, column=None):
+    if not symbol.is_scalar:
+        raise TypeError(
+            "Cannot extract value data for non-scalar symbols "
+            f"(symbol dimension is {symbol.dimension})"
+        )
+
+    # checks
+    if column is None:
+        column = "level"
+
+    if not isinstance(column, str):
+        raise TypeError(
+            f"Argument 'column' must be type str. User passed {type(column)}."
+        )
+
+    if column not in symbol._attributes:
+        raise TypeError(
+            f"Argument 'column' must be one of the following: {symbol._attributes}"
+        )
+
+    if symbol.records is not None:
+        return symbol.records[column][0]

gams/transfer/syms/_mixins/__init__.py

@@ -0,0 +1,32 @@
+#
+# 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.syms._mixins.pve import PVEMixin
+from gams.transfer.syms._mixins.sa import SAMixin
+from gams.transfer.syms._mixins.sapve import SAPVEMixin
+from gams.transfer.syms._mixins.saua import SAUAMixin
+from gams.transfer.syms._mixins.sauapve import SAUAPVEMixin
+from gams.transfer.syms._mixins.spve import SPVEMixin
+from gams.transfer.syms._mixins.ve import VEMixin