Merge branch 'master' into dev_minpay

Author: tturocy

.github/ISSUE_TEMPLATE/tutorial_request.yml

@@ -32,4 +32,4 @@ body:
       description: Add links to any research papers or other resources the author will need to write this tutorial.
       value: "`[Markdown link text](url)`"
     validations:
-      required: false
+      required: false

.github/workflows/lint.yml

@@ -2,15 +2,7 @@ name: Linters and coding standards checks
 
 on:
   push:
-    paths-ignore:
-      - 'doc/**'
-      - '.github/ISSUE_TEMPLATE/**'
-      - 'README.md'
   pull_request:
-    paths-ignore:
-      - 'doc/**'
-      - '.github/ISSUE_TEMPLATE/**'
-      - 'README.md'
 
 jobs:
   clang-format:

.github/workflows/osxbinary.yml

@@ -2,10 +2,6 @@ name: MacOS static GUI binary
 
 on:
   push:
-    paths-ignore:
-      - 'doc/**'
-      - '.github/ISSUE_TEMPLATE/**'
-      - 'README.md'
     tags:
       - 'v*'
   schedule:

.github/workflows/python.yml

@@ -2,15 +2,7 @@ name: pygambit Python extension
 
 on:
   push:
-    paths-ignore:
-      - 'doc/**'
-      - '.github/ISSUE_TEMPLATE/**'
-      - 'README.md'
   pull_request:
-    paths-ignore:
-      - 'doc/**'
-      - '.github/ISSUE_TEMPLATE/**'
-      - 'README.md'
 
 jobs:
   linux:
@@ -29,7 +21,9 @@ jobs:
       - name: Set up dependencies
         run: |
           python -m pip install --upgrade pip
-          pip install setuptools build cython pytest pytest-skip-slow wheel lxml numpy scipy nbformat nbclient ipykernel
+          pip install setuptools build cython wheel
+          pip install -r tests/requirements.txt
+          pip install -r doc/requirements.txt
       - name: Build source distribution
         run:
           python -m build
@@ -38,13 +32,7 @@ jobs:
           cd dist
           pip install -v pygambit*.tar.gz
       - name: Run tests
-        run: |
-          if [ "${{ matrix.python-version }}" = "3.9" ]; then
-            # Python 3.9 on linux skips the notebook execution test (notebooks may require newer kernels/deps)
-            pytest -q -k 'not test_execute_notebook'
-          else
-            pytest
-          fi
+        run: pytest
 
   macos-13:
     runs-on: macos-13
@@ -62,7 +50,9 @@ jobs:
       - name: Set up dependencies
         run: |
           python -m pip install --upgrade pip
-          pip install cython pytest pytest-skip-slow wheel lxml numpy scipy nbformat nbclient ipykernel
+          pip install setuptools build cython wheel
+          pip install -r tests/requirements.txt
+          pip install -r doc/requirements.txt
       - name: Build extension
         run: |
           python -m pip install -v .
@@ -85,7 +75,9 @@ jobs:
       - name: Set up dependencies
         run: |
           python -m pip install --upgrade pip
-          pip install cython pytest pytest-skip-slow wheel lxml numpy scipy nbformat nbclient ipykernel
+          pip install setuptools build cython wheel
+          pip install -r tests/requirements.txt
+          pip install -r doc/requirements.txt
       - name: Build extension
         run: |
           python -m pip install -v .
@@ -108,7 +100,9 @@ jobs:
       - name: Set up dependencies
         run: |
           python -m pip install --upgrade pip
-          pip install cython pytest pytest-skip-slow wheel lxml numpy scipy nbformat nbclient ipykernel
+          pip install setuptools build cython wheel
+          pip install -r tests/requirements.txt
+          pip install nbformat nbclient ipykernel jupyter matplotlib
       - name: Build extension
         run: |
           python -m pip install -v .

.github/workflows/tools.yml

@@ -2,15 +2,7 @@ name: Build executables
 
 on:
   push:
-    paths-ignore:
-      - 'doc/**'
-      - '.github/ISSUE_TEMPLATE/**'
-      - 'README.md'
   pull_request:
-    paths-ignore:
-      - 'doc/**'
-      - '.github/ISSUE_TEMPLATE/**'
-      - 'README.md'
 
 jobs:
   linux:

.github/workflows/wheels.yml

@@ -3,10 +3,6 @@ name: pygambit wheels
 
 on:
   push:
-    paths-ignore:
-      - 'doc/**'
-      - '.github/ISSUE_TEMPLATE/**'
-      - 'README.md'
     tags:
       - 'v*'
   schedule:

.gitignore

@@ -44,4 +44,4 @@ Gambit.app/*
 doc/tutorials/games/*.nfg
 doc/tutorials/games/*.efg
 *.dmg
-Gambit.app/*
+Gambit.app/*

doc/requirements.txt

@@ -1,12 +1,12 @@
-Cython==3.1.2
-numpy==2.3.2
-scipy==1.16.1
-pydata-sphinx-theme==0.16.1
-sphinx_design==0.6.1
-sphinx-autobuild==2024.10.3
-nbsphinx==0.9.7
-ipython==9.4.0
-matplotlib==3.10.5
-pickleshare==0.7.5
-jupyter==1.1.1
-open_spiel==1.6.9
+Cython
+numpy
+scipy
+pydata-sphinx-theme
+sphinx_design
+sphinx-autobuild
+nbsphinx
+ipython
+matplotlib
+pickleshare
+jupyter
+open_spiel

doc/tutorials/running_locally.rst

@@ -3,22 +3,34 @@
 How to run PyGambit tutorials on your computer
 ==============================================
 
-The PyGambit tutorials are available as Jupyter notebooks and can be run interactively using any program that supports Jupyter notebooks, such as JupyterLab or VSCode.
-You will need a working installation of Python 3.9+ on your machine to run PyGambit (however the tutorials contain some syntax that may not be compatible with earlier versions of Python than 3.13).
+Running the PyGambit tutorials on your machine requires some familiarity with the basics of Python and how to use Git & GitHub.
+The tutorials are available as Jupyter notebooks and can be run interactively using any program that supports Jupyter notebooks, such as JupyterLab or VSCode.
+
+.. tip:: Create a virtual environment with Python 3.13 or higher
 
 1. To download the tutorials, open your OS's command prompt and clone the Gambit repository from GitHub, then navigate to the tutorials directory: ::
 
     git clone https://github.com/gambitproject/gambit.git
-    cd gambit/doc
 
-2. Install `pygambit` and other requirements (including `JupyterLab` and other packages used by the tutorials). We recommend creating a new virtual environment and installing both the requirements there. e.g. ::
+2. Install `pygambit`:
+
+   * To install the latest release from PyPI::
+
+       pip install pygambit
+
+   * Alternatively, to install the latest development version::
 
-    python -m venv pygambit-env
-    source pygambit-env/bin/activate
-    pip install pygambit
+       pip install .
+
+3. Install other requirements (including `JupyterLab`) used by the tutorials ::
+
+    cd gambit/doc
     pip install -r requirements.txt
 
-3. Open `JupyterLab` and click on any of the tutorial notebooks (files ending in `.ipynb`) ::
+   .. warning::
+       Windows users will encounter an error when installing the requirements, which include the OpenSpiel library. Users wishing to run the OpenSpiel tutorial will need to install this manually; see the `OpenSpiel installation instructions <https://openspiel.readthedocs.io/en/latest/windows.html>`_ for details.
+
+4. Open `JupyterLab` and click on any of the tutorial notebooks (files ending in `.ipynb`) ::
 
     cd tutorials
     jupyter lab

src/games/ndarray.h

@@ -2,7 +2,7 @@
 // This file is part of Gambit
 // Copyright (c) 1994-2024, The Gambit Project (http://www.gambit-project.org)
 //
-// FILE: src/solvers/enumpoly/ndarray.h
+// FILE: src/games/ndarray.h
 // A simple N-dimensional array class
 //
 // This program is free software; you can redistribute it and/or modify
@@ -20,8 +20,8 @@
 // Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
 //
 
-#ifndef NDARRAY_H
-#define NDARRAY_H
+#ifndef GAMBIT_GAMES_NDARRAY_H
+#define GAMBIT_GAMES_NDARRAY_H
 
 #include <numeric>
 
@@ -42,11 +42,14 @@ namespace Gambit {
 ///
 /// @tparam T The data type of elements of the array
 template <class T> class NDArray {
+  using reference = typename std::vector<T>::reference;
+  using const_reference = typename std::vector<T>::const_reference;
+
 protected:
   Array<int> m_index_dim;
-  int m_vector_dim;
+  int m_vector_dim{0};
   Array<int> m_offsets;
-  int m_offsets_sum;
+  int m_offsets_sum{0};
   std::vector<T> m_storage;
 
   int ComputeOffset(const Array<int> &p_array_index, int p_vector_index) const
@@ -59,10 +62,9 @@ template <class T> class NDArray {
   }
 
 public:
-  NDArray() : m_vector_dim(0), m_offsets_sum(0) {}
-  explicit NDArray(const Array<int> &p_index_dim, int p_vector_dim)
+  NDArray() = default;
+  explicit NDArray(const Array<int> &p_index_dim, const int p_vector_dim)
     : m_index_dim(p_index_dim), m_vector_dim(p_vector_dim), m_offsets(p_index_dim.size() + 1),
-      m_offsets_sum(0),
       m_storage(std::accumulate(m_index_dim.begin(), m_index_dim.end(), 1, std::multiplies<>()) *
                 m_vector_dim)
   {
@@ -74,21 +76,24 @@ template <class T> class NDArray {
     // NOLINTEND(cppcoreguidelines-prefer-member-initializer)
   }
 
-  NDArray(const NDArray<T> &) = default;
+  NDArray(const NDArray &) = default;
   ~NDArray() = default;
 
-  NDArray<T> &operator=(const NDArray<T> &) = default;
+  NDArray &operator=(const NDArray &) = default;
 
-  const T &at(const Array<int> &v, int index) const
+  const_reference at(const Array<int> &v, const int index) const
+  {
+    return m_storage.at(ComputeOffset(v, index));
+  }
+  reference at(const Array<int> &v, const int index)
   {
     return m_storage.at(ComputeOffset(v, index));
   }
-  T &at(const Array<int> &v, int index) { return m_storage.at(ComputeOffset(v, index)); }
 
   const Array<int> &GetIndexDimension() const { return m_index_dim; }
-  int GetVectorDimension() { return m_vector_dim; }
+  int GetVectorDimension() const { return m_vector_dim; }
 };
 
 } // end namespace Gambit
 
-#endif // NDARRAY_H
+#endif // GAMBIT_GAMES_NDARRAY_H