gamsapi 52.5.0__cp312-cp312-win_amd64.whl

gams/tools/toolcollection/gdxservice/gdxencoding.py

@@ -0,0 +1,104 @@
+#
+# 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.tools.toolcollection.tooltemplate  import ToolTemplate
+from ctypes import *
+
+class Gdxencoding (ToolTemplate):
+
+    def __init__(self, system_directory, tool):
+        super().__init__(system_directory, tool)
+        self.title = 'gdxencoding: This converts the unique elements in the GDX file from one encoding to another one.'
+        self.add_posargdef('gdxFile',   'fnExist',    'Name of GDX file')
+        self.add_namedargdef('encodingIn=codingIn',    'str',         'Input encoding of GDX string', argdefault='latin_1')
+        self.add_namedargdef('encodingOut=codingOut',  'str',         'Output encoding of GDX string', argdefault='utf_8')
+        self.add_namedargdef('numConv=id',             'id.out:par:0','GAMS scalar symbol to store the number of actual conversions')
+        self.add_namedargdef('gdxOut=fileOut.gdx',     'fnWriteable', 'Name of GDX file that contains symbol numConv after execution')
+
+    def _get_last_gdx_error(self, gdx_handle, gdx):
+        from gams.core.gdx import GMS_SSSIZE
+        error_nr = gdx.c__gdxgetlasterror(gdx_handle)
+        error_msg = create_string_buffer(GMS_SSSIZE)
+        gdx.c__gdxerrorstr(gdx_handle, error_nr, error_msg)
+        return error_msg.value.decode('utf-8')
+
+    def execute(self):
+        if self.dohelp():
+            return
+
+        self.process_args()
+        gdxFile = self.posargs[0]
+        encodeIn = self.namedargs_val("encodingIn")
+        encodeOut = self.namedargs_val("encodingOut")
+
+        if self._tools._ecdb is None and 'numconv' in self.namedargs and not 'gdxout' in self.namedargs:
+            self.tool_error('Command line use requires gdxOut=<fileOut.gdx> if numConv=id is set')
+
+        import os
+        import sys
+
+        if sys.platform in ["linux", "linux2"]:
+            so_name = "libgdxcclib64.so"
+        elif sys.platform == "darwin":
+            so_name = "libgdxcclib64.dylib"
+        elif sys.platform == "win32":
+            so_name = "gdxcclib64.dll"
+        else:
+            raise Exception(f'unknown OS {sys.platform}')
+        gdx = cdll.LoadLibrary(os.path.join(self._tools._system_directory, so_name))
+
+        gdx_handle = c_void_p()
+        gdx.xcreate(byref(gdx_handle))
+        ival = c_int()
+        ival_p = byref(ival)
+
+        rc = gdx.c__gdxopenappend(gdx_handle, c_char_p(gdxFile.encode()), c_char_p(f'gdxService gdxEncoding {encodeIn} -> {encodeOut}'.encode()), ival_p)
+        if not rc == 1:
+            self.tool_error(f'Error gdxOpenAppend: {self._get_last_gdx_error(gdx_handle, gdx)}', print_help=False)
+
+        uel_nr = 1
+        num_conv = 0
+        uel = create_string_buffer(gdx.c__gdxuelmaxlength(gdx_handle)+1)
+        while True:
+            rc = gdx.c__gdxumuelget(gdx_handle, c_int(uel_nr), uel, ival_p)
+            if rc != 1: break
+            uel_out = uel.value.decode(encodeIn).encode(encodeOut)
+            if uel_out != uel.value:
+                if self._trace > 0:
+                    self._tools.print_log(f'Converted {uel.value} to {uel_out}')
+                rc = gdx.c__gdxrenameuel(gdx_handle, uel.value, uel_out)
+                if not rc == 0:
+                    self.tool_error(f'Error gdxRenameUEL: {self._get_last_gdx_error(gdx_handle, gdx)}', print_help=False)
+                num_conv += 1
+            uel_nr += 1
+        gdx.c__gdxclose(gdx_handle)
+        gdx.xfree(byref(gdx_handle))
+
+        if 'numconv' in self.namedargs:
+            import gams.transfer as gt
+
+            m = gt.Container(system_directory=self._system_directory)
+            m.addParameter(self.namedargs_val("numconv"), records=num_conv)
+            self.write_id_outputs(m, self.namedargs_val("numconv"))

gams/tools/toolcollection/gdxservice/gdxrename.py

@@ -0,0 +1,94 @@
+#
+# 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.tools.toolcollection.tooltemplate  import ToolTemplate
+
+class Gdxrename (ToolTemplate):
+
+    def __init__(self, system_directory, tool):
+        super().__init__(system_directory, tool)
+        self.title = 'gdxrename: This renames the labels in the GDX file.'
+        self.add_posargdef('gdxFile',   'fnExist',    'Name of GDX file')
+        self.add_posargdef('mapSet',    'id.in:set:2','Set of labels to be used for renaming mapSet(*,*)')
+        self.add_namedargdef('gdxIn=fileIn.gdx', 'fnExist', 'Name of GDX file that contains map symbol "mapSet"', shell_req=True)
+        self.add_namedargdef('reverse=0|1',        'int',     'Determines if mapSet with record a.b leads to a replace of\na by b or to a replace of b by a', argdefault=0)
+
+    def execute(self):
+        if self.dohelp():
+            return
+
+        import gams.transfer as gt
+
+        self.process_args()
+        gdxFile, mapSet = self.posargs
+        reverse = self.namedargs_val("reverse")
+
+        m = gt.Container(system_directory=self._system_directory)
+        self.read_id_inputs(m, mapSet)
+
+        # Make sure that mapSet is a 1-to-1 map so check for a->1 a->2 and a->1 b->1
+        m1 = {}
+        m2 = {}
+        for rec in m[mapSet].toList():
+            if reverse == 0:
+                a, b  = rec[0], rec[1]
+            else:
+                b, a  = rec[0], rec[1]
+            if m1.get(a,' ') == ' ':
+                m1[a] = b
+            else:
+                self.tool_error(f'mapSet "{mapSet}" is multimap "{a}" to "{m1[a]}" and "{b}"', print_help=False)
+            if m2.get(b,' ') == ' ':
+                m2[b] = a
+            else:
+                self.tool_error(f'mapSet "{mapSet}" is multimap "{b}" to "{m2[b]}" and "{a}"', print_help=False)
+        # Avoid a->b->c
+        for a, b in m1.items():
+            if not m1.get(b,' ') == ' ':
+                self.tool_error(f'mapSet "{mapSet}" has chain "{a}"->"{b}"->"{m1[b]}"', print_help=False)
+
+        # Apply map to gdxFile uels
+        import gams.core.gdx as gdx
+        h = gdx.new_gdxHandle_tp()
+        rc , msg = gdx.gdxCreate(h, gdx.GMS_SSSIZE)
+        if not rc == 1 or not len(msg) == 0:
+            self.tool_error(f'Error gdxCreate: rc={rc} msg={msg}', print_help=False)
+
+        if 0==gdx.gdxOpenAppend(h, gdxFile, 'gdxrename')[0]:
+            self.tool_error(f'Error gdxOpenAppend: {gdx.gdxErrorStr(h,gdx.gdxGetLastError(h))[1]}', print_help=False)
+
+        for a, b in m1.items():
+            rc = gdx.gdxRenameUEL(h, a, b);
+            if rc == -1:
+                self.tool_error(f'Error gdxRenameUEL: No UelTable', print_help=False)
+            elif rc in [0,2]: # everything ok, uel k does not exist
+                pass
+            elif rc == 3:
+                self.tool_error(f'Error gdxRenameUEL: Label "{b}" exists already', print_help=False)
+            else:
+                self.tool_error(f'Error gdxRenameUEL: Unknown return code rc={rc}', print_help=False)
+
+        gdx.gdxClose(h)
+        gdx.gdxFree(h)

gams/tools/toolcollection/linalg/__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/tools/toolcollection/linalg/cholesky.py

@@ -0,0 +1,57 @@
+#
+# 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.tools.toolcollection.tooltemplate  import ToolTemplate
+
+class Cholesky (ToolTemplate):
+
+    def __init__(self, system_directory, tool):
+        super().__init__(system_directory, tool)
+        self.title = 'cholesky: This calculates the Cholesky decomposition of a symmetric positive definite matrix A = LL^t.'
+        self.add_posargdef('i',   'id.in:set:1',  'Name of set used in matrix i(*)')
+        self.add_posargdef('A',   'id.in:par:2',  'Name of two-dimensional matrix parameter A(i,i)')
+        self.add_posargdef('L',   'id.out:par:2', 'Name of two-dimensional parameter containing the factor L(i,i)')
+        self.add_namedargdef('gdxIn=fileIn.gdx',  'fnExist',    'Name of GDX file that contains symbols i and A', shell_req=True)
+        self.add_namedargdef('gdxOut=fileOut.gdx','fnWriteable','Name of GDX file that contains symbol L after execution', shell_req=True)
+
+    def execute(self):
+        if self.dohelp():
+            return
+
+        import gams.transfer as gt
+        import numpy as np
+
+        self.process_args()
+        i, A, L = self.posargs
+
+        m = gt.Container(system_directory=self._system_directory)
+        self.read_id_inputs(m, [i, A])
+
+        m[A].domain = [m[i],m[i]]
+        a = m[A].toDense()
+        upper = self.is_upper_matrix(a)
+        l = np.linalg.cholesky(a, upper=upper)
+        m.addParameter(L,[m[i],m[i]], records=l)
+        self.write_id_outputs(m, L)

gams/tools/toolcollection/linalg/eigenvalue.py

@@ -0,0 +1,56 @@
+#
+# 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.tools.toolcollection.tooltemplate  import ToolTemplate
+
+class Eigenvalue (ToolTemplate):
+
+    def __init__(self, system_directory, tool):
+        super().__init__(system_directory, tool)
+        self.title = 'eigenvalue: This calculates the Eigenvalues of a symmetric positive definite matrix.'
+        self.add_posargdef('i',   'id.in:set:1',  'Name of set used in matrix i(*)')
+        self.add_posargdef('A',   'id.in:par:2',  'Name of two-dimensional matrix parameter A(i,i)')
+        self.add_posargdef('AVal','id.out:par:1', 'Name of one-dimensional parameter to store the Eigenvalues AVal(i)')
+        self.add_namedargdef('gdxIn=fileIn.gdx',  'fnExist',    'Name of GDX file that contains symbols i and A', shell_req=True)
+        self.add_namedargdef('gdxOut=fileOut.gdx','fnWriteable','Name of GDX file that contains symbol AVal after execution', shell_req=True)
+
+    def execute(self):
+        if self.dohelp():
+            return
+
+        import gams.transfer as gt
+        import numpy as np
+
+        self.process_args()
+        i, A, AVal = self.posargs
+
+        m = gt.Container(system_directory=self._system_directory)
+        self.read_id_inputs(m, [i, A])
+        m[A].domain = [m[i],m[i]]
+        a = m[A].toDense()
+        upper = self.is_upper_matrix(a)
+        eigval = np.linalg.eigvalsh(a, UPLO="U" if upper else "L")
+        m.addParameter(AVal,[m[i]], records=eigval)
+        self.write_id_outputs(m, AVal)

gams/tools/toolcollection/linalg/eigenvector.py

@@ -0,0 +1,58 @@
+#
+# 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.tools.toolcollection.tooltemplate  import ToolTemplate
+
+class Eigenvector (ToolTemplate):
+
+    def __init__(self, system_directory, tool):
+        super().__init__(system_directory, tool)
+        self.title = 'eigenvector: This calculates the Eigenvalues and Eigenvecors of a symmetric positive definite matrix.'
+        self.add_posargdef('i',   'id.in:set:1',  'Name of set used in matrix i(*)')
+        self.add_posargdef('A',   'id.in:par:2',  'Name of two-dimensional matrix parameter A(i,i)')
+        self.add_posargdef('AVal','id.out:par:1',  'Name of one-dimensional parameter to store the Eigenvalues AVal(i)')
+        self.add_posargdef('AVec','id.out:par:2',  'Name of two-dimensional matrix to store the Eigenvectors AVec(i,i)')
+        self.add_namedargdef('gdxIn=fileIn.gdx',  'fnExist',    'Name of GDX file that contains symbols i and A', shell_req=True)
+        self.add_namedargdef('gdxOut=fileOut.gdx','fnWriteable','Name of GDX file that contains symbols Aval and AVec after execution', shell_req=True)
+
+    def execute(self):
+        if self.dohelp():
+            return
+
+        import gams.transfer as gt
+        import numpy as np
+
+        self.process_args()
+        i, A, AVal, AVec= self.posargs
+
+        m = gt.Container(system_directory=self._system_directory)
+        self.read_id_inputs(m, [i, A])
+        m[A].domain = [m[i],m[i]]
+        a = m[A].toDense()
+        upper = self.is_upper_matrix(a)
+        eigval, eigvec = np.linalg.eigh(a, UPLO="U" if upper else "L")
+        m.addParameter(AVal,[m[i]], records=eigval)
+        m.addParameter(AVec,[m[i],m[i]], records=eigvec)
+        self.write_id_outputs(m, [AVal, AVec])

gams/tools/toolcollection/linalg/invert.py

@@ -0,0 +1,55 @@
+#
+# 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.tools.toolcollection.tooltemplate  import ToolTemplate
+
+class Invert (ToolTemplate):
+
+    def __init__(self, system_directory, tool):
+        super().__init__(system_directory, tool)
+        self.title = 'invert: This calculates the inverse of a square matrix A: A*AInv = I.'
+        self.add_posargdef('i',   'id.in:set:1',  'Name of set used in matrix i(*)')
+        self.add_posargdef('A',   'id.in:par:2',  'Name of two-dimensional matrix parameter A(i,i)')
+        self.add_posargdef('AInv','id.out:par:2', 'Name of two-dimensional parameter containing the inverse AInv(i,i)')
+        self.add_namedargdef('gdxIn=fileIn.gdx',  'fnExist',    'Name of GDX file that contains symbols i and A', shell_req=True)
+        self.add_namedargdef('gdxOut=fileOut.gdx','fnWriteable','Name of GDX file that contains symbol AInv after execution', shell_req=True)
+
+    def execute(self):
+        if self.dohelp():
+            return
+
+        import gams.transfer as gt
+        import numpy as np
+
+        self.process_args()
+        i, A, AInv = self.posargs
+
+        m = gt.Container(system_directory=self._system_directory)
+        self.read_id_inputs(m, [i, A])
+
+        m[A].domain = [m[i],m[i]]
+        inv = np.linalg.inv(m[A].toDense())
+        m.addParameter(AInv,[m[i],m[i]], records=inv)
+        self.write_id_outputs(m, AInv)

gams/tools/toolcollection/linalg/ols.py

@@ -0,0 +1,138 @@
+#
+# 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.tools.toolcollection.tooltemplate  import ToolTemplate
+
+class Ols (ToolTemplate):
+
+    def __init__(self, system_directory, tool):
+        super().__init__(system_directory, tool)
+        self.title = 'ols: This estimates the unknown parameters in a linear regression model.'
+        self.add_posargdef('i',   'id.in:set:1',  'Name of set of observations i(*)')
+        self.add_posargdef('p',   'id.in:set:1',  'Name of set of estimates p(*)')
+        self.add_posargdef('A',   'id.in:par:2',  'Name of two-dimensional explanatory variable matrix A(i,p)')
+        self.add_posargdef('y',   'id.in:par:1',  'Name of one-dimensional dependent variable y(i)')
+        self.add_posargdef('est', 'id.out:par:1', 'Name of one-dimensional estimated statistical coefficients est(p)')
+        self.add_namedargdef('gdxIn=fileIn.gdx',  'fnExist',    'Name of GDX file that contains symbols i, p, A, and y', shell_req=True)
+        self.add_namedargdef('gdxOut=fileOut.gdx','fnWriteable','Name of GDX file that contains symbol est and info symbols after execution', shell_req=True)
+        self.add_namedargdef('intercept=0|1|2','int','Choice for constant term\n0 - no constant term or intercept will be added to the problem\n1 - a constant term will always be added\n2 - the algorithm will add a constant term only if there is\n    no data column with all ones in the matrix A', argdefault=2)
+        self.add_namedargdef('rcond=val','float','Cut-off ratio for small singular values of A used as\nargument rcond to np.linalg.lstsq', argdefault=-1.0)
+        self.add_namedargdef('covar=id','id.out:par:2','Statistical info: variance-covariance matrix CoVar(p,p)')
+        self.add_namedargdef('df=id','id.out:par:0','Statistical info: degrees of freedom (scalar)')
+        self.add_namedargdef('fitted=id','id.out:par:1','Statistical info: fitted values for dependent variable fitted(i)')
+        self.add_namedargdef('r2=id','id.out:par:0','Statistical info: R squared (scalar)')
+        self.add_namedargdef('resid=id','id.out:par:1','Statistical info: residuals resid(i)')
+        self.add_namedargdef('resvar=id','id.out:par:0','Statistical info: residual variance (scalar)')
+        self.add_namedargdef('rss=id','id.out:par:0','Statistical info: residual sum of squares (scalar)')
+        self.add_namedargdef('se=id','id.out:par:1','Statistical info: standard errors se(p)')
+        self.add_namedargdef('sigma=id','id.out:par:0','Statistical info: standard error (scalar)')
+        self.add_namedargdef('tval=id','id.out:par:1','Statistical info: standard errors se(p)')
+        self._export = []
+
+    def add_to_output(self, m, key, domain=None, recs=None):
+        if key in self.namedargs:
+            id = self.namedargs[key]
+            self._export.append(id)
+            if domain is None:
+                m.addParameter(id, records=recs)
+            else:
+                m.addParameter(id, domain, records=recs)
+
+    def execute(self):
+        if self.dohelp():
+            return
+        import gams.transfer as gt
+        import numpy as np
+        self.process_args()
+        i, p, A, y, est = self.posargs
+
+        m = gt.Container(system_directory=self._system_directory)
+        self.read_id_inputs(m, [i, p, A, y])
+
+        m[A].domain = [m[i],m[p]]
+        m[y].domain = [m[i]]
+        a = m[A].toDense()
+        Y = m[y].toDense()
+
+        rb = None
+        rcond = self.namedargs_val("rcond")
+        intercept = self.namedargs_val("intercept")
+        need_intercept = True if intercept in [1,2] else False
+        if intercept == 2:
+            for c in range(a.shape[1]):
+                if np.all(a[:,c] == 1):
+                    need_intercept = False
+                    break
+        if need_intercept:
+            self._tools.print_log('Intercept added')
+            rb = -1
+            o = np.ones((a.shape[0], 1))
+            a = np.append(a, o, axis=1)
+
+        mm = a.shape[0]
+        nn = a.shape[1]
+        x, rss = np.linalg.lstsq(a, Y, rcond=rcond)[:2]
+        fitted = np.matmul(a, x)
+        residuals = Y - fitted
+        df = mm - nn
+        if df <= 0:
+            self.tool_error(f'Degrees of freedom df=m-n should be >0, is {mm}-{nn}={df}', print_help=False)
+        resvar = rss[0]/df
+        sigma = np.sqrt(resvar)
+        meanf = np.sum(fitted)/mm
+        mss = np.dot(fitted-meanf, fitted-meanf)
+        r2 = mss/(mss+rss[0])
+  
+        if 'se' in self.namedargs or 'covar' in self.namedargs or 'tval' in self.namedargs:
+            try:
+                MSE = (sum((Y-fitted)**2))/df
+                ainv = np.linalg.inv(np.dot(a.T,a))
+                var_b = MSE*(ainv.diagonal())
+                if len([v for v in var_b if v < 0]):
+                    self.tool_error('Unexpected negative values in var_b', print_help=False)
+                se = np.sqrt(var_b)
+                tval = x / se
+                covar = ainv*resvar
+            except Exception as e:
+                self._tools.print_log(str(e))
+                if not np.allclose(np.dot(np.dot(a.T,a), ainv), np.eye(ainv.shape[0])):
+                    self._tools.print_log(f'Inversion of matrix failed. Condition number: {np.linalg.cond(np.dot(a.T,a))}')
+                se = []
+                tval = []
+                covar = []
+        m.addParameter(est,[m[p]], records=x[:rb])
+        self._export.append(est)
+        if 'covar'  in self.namedargs: self.add_to_output(m,'covar' , [m[p],m[p]], recs=covar[:rb,:rb])
+        if 'df'     in self.namedargs: self.add_to_output(m,'df'    , recs=df)
+        if 'fitted' in self.namedargs: self.add_to_output(m,'fitted', [m[i]], recs=fitted)
+        if 'r2'     in self.namedargs: self.add_to_output(m,'r2'    , recs=r2)
+        if 'resid'  in self.namedargs: self.add_to_output(m,'resid' , [m[i]], recs=residuals)
+        if 'resvar' in self.namedargs: self.add_to_output(m,'resvar', recs=resvar)
+        if 'rss'    in self.namedargs: self.add_to_output(m,'rss'   , recs=rss[0])
+        if 'se'     in self.namedargs: self.add_to_output(m,'se'    , [m[p]], recs=se[:rb])
+        if 'sigma'  in self.namedargs: self.add_to_output(m,'sigma' , recs=sigma)
+        if 'tval'   in self.namedargs: self.add_to_output(m,'tval'  , [m[p]], recs=tval[:rb])
+
+        self.write_id_outputs(m, self._export)