free_groups_26 1.2.0__tar.gz

free_groups_26-1.2.0/.github/workflows/pytest.yml

@@ -0,0 +1,42 @@
+name: Run Pytest
+
+on:
+  push:
+    branches: [ "main", "refactor-word"]
+  pull_request:
+    branches: [ "main" ]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ["3.13", "3.14"]
+
+    steps:
+    - name: Checkout repository
+      uses: actions/checkout@v4
+
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v5
+      with:
+        python-version: ${{ matrix.python-version }}
+        cache: 'pip' 
+
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install -e .[test]
+
+    - name: Run tests with pytest
+      run: |
+        pytest
+
+    - name: Upload test results
+      if: always() 
+      uses: actions/upload-artifact@v4
+      with:
+        name: pytest-results-${{ matrix.python-version }}
+        path: |
+          junit/test-results-${{ matrix.python-version }}.xml
+          coverage.xml

free_groups_26-1.2.0/.github/workflows/sphinx.yml

@@ -0,0 +1,37 @@
+name: "Sphinx: Render docs"
+
+on: push
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+    steps:
+    - uses: actions/checkout@v4
+      with:
+        persist-credentials: false
+    - uses: actions/setup-python@v5
+      with:
+        python-version: "3.13"
+    - name: Install dependencies
+      run: | 
+        python -m pip install --upgrade pip
+        pip install -r docs/requirements.txt
+        pip install -e .
+    - name: Build HTML
+      run: |
+        cd docs
+        make html
+        cd -
+    - name: Upload artifacts
+      uses: actions/upload-artifact@v4
+      with:
+        name: html-docs
+        path: docs/build/html/
+    - name: Deploy
+      uses: peaceiris/actions-gh-pages@v3
+      if: github.ref == 'refs/heads/main'
+      with:
+        github_token: ${{ secrets.GITHUB_TOKEN }}
+        publish_dir: docs/build/html

free_groups_26-1.2.0/.gitignore

@@ -0,0 +1,29 @@
+# Devenv
+.devenv*
+devenv.local.nix
+devenv.local.yaml
+
+# direnv
+.direnv
+
+# environment
+.envrc
+.env
+
+# pre-commit
+.pre-commit-config.yaml
+
+# builds
+dist
+
+# testing
+*__pycache__
+.pytest_cache
+jupyter_test
+temp
+
+# documentation
+docs/build
+
+# generated typings
+typings/sortedcontainers

free_groups_26-1.2.0/.ipynb_checkpoints/Untitled-checkpoint.ipynb

@@ -0,0 +1,6 @@
+{
+ "cells": [],
+ "metadata": {},
+ "nbformat": 4,
+ "nbformat_minor": 5
+}

free_groups_26-1.2.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Sudhir Krisna
+
+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.

free_groups_26-1.2.0/PKG-INFO

@@ -0,0 +1,31 @@
+Metadata-Version: 2.5
+Name: free_groups_26
+Version: 1.2.0
+Summary: A Python Module for working with Free Groups
+Project-URL: Documentation, https://www.sudhirkrisna.com/free_groups_26/
+Project-URL: Repository, https://github.com/Sudhboi/free_groups_26
+Project-URL: Issues, https://github.com/Sudhboi/free_groups_26/issues
+Author-email: Sudhir Krisna <sudhcontent@gmail.com>
+License-Expression: MIT
+License-File: LICENSE
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Requires-Python: >=3.13
+Requires-Dist: matplotlib>=3.10.8
+Requires-Dist: networkx>=3.6.1
+Requires-Dist: sortedcontainers>=2.4.0
+Provides-Extra: docs
+Requires-Dist: sphinx; extra == 'docs'
+Provides-Extra: test
+Requires-Dist: pytest; extra == 'test'
+Requires-Dist: pytest-cov; extra == 'test'
+Description-Content-Type: text/markdown
+
+# free_groups_26
+
+### Install:
+```
+pip install free-groups-26
+```
+
+Documentation can be found at the official website - [free_groups_26](https://www.sudhirkrisna.com/free_groups_26/index.html)

free_groups_26-1.2.0/README.md

@@ -0,0 +1,8 @@
+# free_groups_26
+
+### Install:
+```
+pip install free-groups-26
+```
+
+Documentation can be found at the official website - [free_groups_26](https://www.sudhirkrisna.com/free_groups_26/index.html)

free_groups_26-1.2.0/devenv.lock

@@ -0,0 +1,65 @@
+{
+  "nodes": {
+    "devenv": {
+      "locked": {
+        "dir": "src/modules",
+        "lastModified": 1789691577,
+        "narHash": "sha256-mS9lQo1gpKzwWMYgzdxc4yv4sIdwqI0GfFMCbV4LZtA=",
+        "owner": "cachix",
+        "repo": "devenv",
+        "rev": "ccb4a99d35474afd07634ee194174ae40f7d98af",
+        "type": "github"
+      },
+      "original": {
+        "dir": "src/modules",
+        "owner": "cachix",
+        "repo": "devenv",
+        "type": "github"
+      }
+    },
+    "nixpkgs": {
+      "inputs": {
+        "nixpkgs-src": "nixpkgs-src"
+      },
+      "locked": {
+        "lastModified": 1789506231,
+        "narHash": "sha256-vNkJbtmqyBfFhn/HnzQo4ROuoyYWuy/allqTfJb4kMY=",
+        "owner": "cachix",
+        "repo": "devenv-nixpkgs",
+        "rev": "c2f38fe7f9e04d9aadd354d380f2bd40531d9737",
+        "type": "github"
+      },
+      "original": {
+        "owner": "cachix",
+        "ref": "rolling",
+        "repo": "devenv-nixpkgs",
+        "type": "github"
+      }
+    },
+    "nixpkgs-src": {
+      "flake": false,
+      "locked": {
+        "lastModified": 1789370336,
+        "narHash": "sha256-6RSEDHIWQtesQKWSu5qRai8L2h4KgCgMEfJHstW99G4=",
+        "owner": "NixOS",
+        "repo": "nixpkgs",
+        "rev": "c7def046b9a883d46974757852106483d741586f",
+        "type": "github"
+      },
+      "original": {
+        "owner": "NixOS",
+        "ref": "nixpkgs-unstable",
+        "repo": "nixpkgs",
+        "type": "github"
+      }
+    },
+    "root": {
+      "inputs": {
+        "devenv": "devenv",
+        "nixpkgs": "nixpkgs"
+      }
+    }
+  },
+  "root": "root",
+  "version": 7
+}

free_groups_26-1.2.0/devenv.nix

@@ -0,0 +1,85 @@
+{ pkgs, ... }:
+
+{
+  # https://devenv.sh/basics/
+  env.GREET = "devenv";
+
+  # https://devenv.sh/packages/
+  packages = with pkgs; [
+    (python3.withPackages (
+      ps: with ps; [
+        numpy
+        networkx
+        matplotlib
+        scipy
+        sortedcontainers
+
+        # Distribution
+        build
+        twine
+        uv
+
+        # Documentation
+        sphinx
+        sphinx-autobuild
+        furo
+
+        # Testing
+        pytest
+        jupyter
+        jupyterlab-vim
+        jupyterlab-lsp
+        jupyter-client
+      ]
+    ))
+    black
+    python3
+    basedpyright
+  ];
+
+  scripts.publish.exec = ''
+    uv build && uv publish
+  '';
+
+  scripts.tests.exec = ''
+    python3 -m pytest
+  '';
+
+  scripts.build_website.exec = ''
+    cd $DEVENV_ROOT/docs
+    make html 
+    cd -
+  '';
+
+  scripts.doctests.exec = ''
+    cd $DEVENV_ROOT/docs
+    make doctest
+    cd -
+  '';
+
+  scripts.site.exec = ''
+    xdg-open $DEVENV_ROOT/docs/build/html/index.html
+  '';
+
+  scripts.live.exec = ''
+    cd $DEVENV_ROOT/docs
+    make livehtml 
+    cd -
+  '';
+
+  scripts.format.exec = ''
+    cd $DEVENV_ROOT
+    black ./src 
+    cd -
+  '';
+
+  enterShell = ''
+    export PYTHONPATH="$DEVENV_ROOT/src/:$PYTHONPATH"
+  '';
+
+  enterTest = ''
+    echo "Running tests"
+    git --version | grep --color=auto "${pkgs.git.version}"
+  '';
+
+}

free_groups_26-1.2.0/devenv.yaml

@@ -0,0 +1,18 @@
+# yaml-language-server: $schema=https://devenv.sh/devenv.schema.json
+inputs:
+  nixpkgs:
+    url: github:cachix/devenv-nixpkgs/rolling
+
+# If you're using non-OSS software, you can set allowUnfree to true.
+# allowUnfree: true
+
+# If you're not willing to allow unsupported packages:
+# allowUnsupportedSystem: false
+
+# If you're willing to use a package that's vulnerable
+# permittedInsecurePackages:
+#  - "openssl-1.1.1w"
+
+# If you have more than one devenv you can merge them
+#imports:
+# - ./backend

free_groups_26-1.2.0/docs/Makefile

@@ -0,0 +1,26 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line, and also
+# from the environment for the first two.
+SPHINXOPTS    ?=
+SPHINXBUILD   ?= sphinx-build
+SOURCEDIR     = source
+BUILDDIR      = build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+
+livehtml:
+	sphinx-autobuild "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+

free_groups_26-1.2.0/docs/make.bat

@@ -0,0 +1,35 @@
+@ECHO OFF
+
+pushd %~dp0
+
+REM Command file for Sphinx documentation
+
+if "%SPHINXBUILD%" == "" (
+	set SPHINXBUILD=sphinx-build
+)
+set SOURCEDIR=source
+set BUILDDIR=build
+
+%SPHINXBUILD% >NUL 2>NUL
+if errorlevel 9009 (
+	echo.
+	echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
+	echo.installed, then set the SPHINXBUILD environment variable to point
+	echo.to the full path of the 'sphinx-build' executable. Alternatively you
+	echo.may add the Sphinx directory to PATH.
+	echo.
+	echo.If you don't have Sphinx installed, grab it from
+	echo.https://www.sphinx-doc.org/
+	exit /b 1
+)
+
+if "%1" == "" goto help
+
+%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+goto end
+
+:help
+%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+
+:end
+popd

free_groups_26-1.2.0/docs/requirements.txt

@@ -0,0 +1,3 @@
+sphinx==9.1.0
+furo==2025.12.19
+

free_groups_26-1.2.0/docs/source/_static/logo.svg

@@ -0,0 +1 @@
+<svg xmlns="http://www.w3.org/2000/svg" version="1.1" xmlns:xlink="http://www.w3.org/1999/xlink" viewBox="0 0 200 200"><rect width="200" height="200" fill="url('#gradient')"></rect><defs><linearGradient id="gradient" gradientTransform="rotate(45 0.5 0.5)"><stop offset="0%" stop-color="#304b63"></stop><stop offset="100%" stop-color="#261b1d"></stop></linearGradient></defs><g><g fill="#87ced8" transform="matrix(3.4629197427959038,0,0,3.4629197427959038,28.59447772265453,119.13009392574135)" stroke="#374f42" stroke-width="0.7"><path d="M4.95 0L1.65 0L1.65-8.28L0.12-8.28L0.12-10.57L1.65-10.57L1.65-11.41Q1.65-13.21 2.71-14.21Q3.78-15.21 5.70-15.21L5.70-15.21Q6.41-15.21 7.25-15L7.25-15L7.26-12.58Q6.95-12.67 6.45-12.67L6.45-12.67Q4.95-12.67 4.95-11.38L4.95-11.38L4.95-10.57L7.01-10.57L7.01-8.28L4.95-8.28L4.95 0ZM7.55-5.24L7.55-5.36Q7.55-6.96 8.08-8.19Q8.60-9.42 9.59-10.09Q10.58-10.76 11.88-10.76L11.88-10.76Q13.54-10.76 14.46-9.65L14.46-9.65L14.58-10.57L17.57-10.57L17.57-0.40Q17.57 1.00 16.92 2.03Q16.27 3.06 15.04 3.61Q13.81 4.16 12.19 4.16L12.19 4.16Q11.03 4.16 9.94 3.72Q8.85 3.28 8.27 2.58L8.27 2.58L9.65 0.64Q10.57 1.73 12.07 1.73L12.07 1.73Q14.26 1.73 14.26-0.52L14.26-0.52L14.26-0.85Q13.31 0.20 11.87 0.20L11.87 0.20Q9.93 0.20 8.74-1.28Q7.55-2.76 7.55-5.24L7.55-5.24ZM10.85-5.16L10.85-5.16Q10.85-3.86 11.34-3.10Q11.83-2.34 12.71-2.34L12.71-2.34Q13.77-2.34 14.26-3.06L14.26-3.06L14.26-7.50Q13.78-8.22 12.72-8.22L12.72-8.22Q11.85-8.22 11.35-7.44Q10.85-6.65 10.85-5.16ZM29.31-2.54L29.31 0L19.38 0L19.38-2.15L23.96-6.95Q25.64-8.88 25.64-10.01L25.64-10.01Q25.64-10.93 25.24-11.41Q24.84-11.88 24.08-11.88L24.08-11.88Q23.33-11.88 22.86-11.25Q22.39-10.61 22.39-9.65L22.39-9.65L19.09-9.65Q19.09-10.96 19.75-12.07Q20.40-13.17 21.56-13.80Q22.72-14.42 24.16-14.42L24.16-14.42Q26.46-14.42 27.71-13.36Q28.96-12.29 28.96-10.30L28.96-10.30Q28.96-9.46 28.64-8.67Q28.33-7.87 27.67-7.00Q27.01-6.12 25.55-4.66L25.55-4.66L23.71-2.54L29.31-2.54ZM38.42-14.42L38.92-14.42L38.92-11.84L38.77-11.84Q36.92-11.84 35.74-10.95Q34.55-10.07 34.28-8.50L34.28-8.50Q35.39-9.59 37.09-9.59L37.09-9.59Q38.94-9.59 40.03-8.24Q41.12-6.89 41.12-4.71L41.12-4.71Q41.12-3.35 40.48-2.22Q39.84-1.08 38.70-0.44Q37.55 0.20 36.15 0.20L36.15 0.20Q34.64 0.20 33.45-0.49Q32.26-1.18 31.59-2.46Q30.93-3.74 30.91-5.41L30.91-5.41L30.91-6.73Q30.91-8.93 31.85-10.68Q32.79-12.43 34.54-13.43Q36.29-14.42 38.42-14.42L38.42-14.42ZM35.95-7.07L35.95-7.07Q35.29-7.07 34.85-6.77Q34.41-6.46 34.20-6.03L34.20-6.03L34.20-5.04Q34.20-2.34 36.06-2.34L36.06-2.34Q36.82-2.34 37.32-3.02Q37.82-3.69 37.82-4.71L37.82-4.71Q37.82-5.75 37.31-6.41Q36.80-7.07 35.95-7.07Z"></path></g></g></svg>

free_groups_26-1.2.0/docs/source/api.rst

@@ -0,0 +1,14 @@
+API
+===
+
+.. autosummary::
+   :toctree: generated
+
+    free_groups_26.letter
+    free_groups_26.free_group
+    free_groups_26.word
+    free_groups_26.morphism
+    free_groups_26.whitehead_automorphism
+    free_groups_26.whitehead_graph
+    free_groups_26.whitehead_minimization
+    free_groups_26.aut_orbit_bruteforce

free_groups_26-1.2.0/docs/source/classes/classes.rst

@@ -0,0 +1,11 @@
+Classes
+=======
+
+.. toctree::
+
+   letter
+   free_group
+   word
+   morphism
+   log
+   whitehead_graph

free_groups_26-1.2.0/docs/source/classes/free_group.rst

@@ -0,0 +1,14 @@
+FreeGroup
+=========
+
+.. py:currentmodule:: free_groups_26
+
+.. testsetup::
+
+   from free_groups_26 import *
+
+This class is defined in ``free_groups_26.free_group``.
+
+.. autoclass:: FreeGroup
+   :members:
+   :special-members: __eq__

free_groups_26-1.2.0/docs/source/classes/letter.rst

@@ -0,0 +1,17 @@
+Letter
+======
+
+.. py:currentmodule:: free_groups_26
+
+.. testsetup::
+
+   from free_groups_26 import Letter
+
+.. autotype:: Symbol
+.. autotype:: Exponent
+
+This class is defined in ``free_groups_26.letter``.
+
+.. autoclass:: Letter
+   :members:
+

free_groups_26-1.2.0/docs/source/classes/log.rst

@@ -0,0 +1,20 @@
+Log
+===
+
+.. py:currentmodule:: free_groups_26
+
+.. testsetup::
+
+   from free_groups_26 import *
+
+.. autotype:: Log
+
+This class is defined in ``free_groups_26.log``.
+
+.. autoclass:: LogItem
+   :members:
+
+
+.. autofunction:: new_log
+
+.. autofunction:: display_log

free_groups_26-1.2.0/docs/source/classes/morphism.rst

@@ -0,0 +1,15 @@
+Morphism
+========
+
+.. py:currentmodule:: free_groups_26
+
+.. testsetup::
+
+   from free_groups_26 import *
+   from sortedcontainers import SortedDict
+
+This class is defined in ``free_groups_26.morphism``.
+
+.. autoclass:: Morphism
+   :members:
+   :special-members: __call__

free_groups_26-1.2.0/docs/source/classes/whitehead_graph.rst

@@ -0,0 +1,19 @@
+Whitehead Graph
+===============
+
+.. py:currentmodule:: free_groups_26
+
+.. testsetup::
+
+   from free_groups_26 import *
+
+This type alias is defined in ``free_groups_26.whitehead_graph``.
+
+.. py:type:: WhiteheadGraph
+   :canonical: Graph[Letter]
+
+``Graph`` refers to ``networkx.Graph``.
+
+.. seealso::
+
+   The documentation for ``networkx``: https://networkx.org/documentation/stable/index.html

free_groups_26-1.2.0/docs/source/classes/word.rst

@@ -0,0 +1,14 @@
+Word
+====
+
+.. py:currentmodule:: free_groups_26
+
+.. testsetup::
+
+   from free_groups_26 import *
+
+This class is defined in ``free_groups_26.word``.
+
+.. autoclass:: Word
+   :members:
+   :special-members: __eq__, __mul__, __pow__, __repr__, __len__, __getitem__

free_groups_26-1.2.0/docs/source/conf.py

@@ -0,0 +1,42 @@
+import sys
+from pathlib import Path
+
+path = str(Path("../..", "src").resolve())
+print(path)
+sys.path.insert(0, path)
+# Configuration file for the Sphinx documentation builder.
+#
+# For the full list of built-in configuration values, see the documentation:
+# https://www.sphinx-doc.org/en/master/usage/configuration.html
+
+# -- Project information -----------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
+
+project = "free_groups_26"
+copyright = "2026, Sudhir Krisna"
+author = "Sudhir Krisna"
+release = "v1.1.1"
+
+# -- General configuration ---------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
+
+extensions = [
+    "sphinx.ext.autodoc",
+    "sphinx.ext.doctest",
+    "sphinx.ext.autosummary",
+]
+
+templates_path = ["_templates"]
+exclude_patterns = []
+
+
+# -- Options for HTML output -------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
+
+html_theme = "furo"
+html_logo = "_static/logo.svg"
+html_favicon = "_static/logo.svg"
+html_static_path = ["_static"]
+add_module_names = False
+autoclass_content = "both"
+autodoc_member_order = "bysource"

free_groups_26-1.2.0/docs/source/functionality/bruteforce.rst

@@ -0,0 +1,16 @@
+Bruteforce Minimization Functions
+=================================
+
+.. py:currentmodule:: free_groups_26
+
+.. testsetup::
+
+   from free_groups_26 import *
+
+These functions are defined in ``free_groups_26.minimize_bruteforce``.
+
+.. autofunction:: minimize_once_bruteforce
+
+.. autofunction:: minimize_once_bruteforce_lazy
+
+.. autofunction:: minimize_bruteforce

free_groups_26-1.2.0/docs/source/functionality/bruteforce_orbit.rst

@@ -0,0 +1,12 @@
+Bruteforce Orbit Functions
+=================================
+
+.. py:currentmodule:: free_groups_26
+
+.. testsetup::
+
+   from free_groups_26 import *
+
+These functions are defined in ``free_groups_26.aut_orbit_bruteforce``.
+
+.. autofunction:: find_minimal_automorphic_orbit

free_groups_26-1.2.0/docs/source/functionality/free_group.rst

@@ -0,0 +1,12 @@
+Free Group Functions
+=========================
+
+.. py:currentmodule:: free_groups_26
+
+.. testsetup::
+
+   from free_groups_26 import *
+
+These functions are defined in ``free_groups_26.free_group``.
+
+.. autofunction:: get_free_group

free_groups_26-1.2.0/docs/source/functionality/functions.rst

@@ -0,0 +1,13 @@
+Functions
+=========
+
+.. toctree::
+
+   letter
+   free_group
+   word
+   whitehead_automorphism
+   bruteforce
+   whitehead_graph
+   whitehead_minimization
+   bruteforce_orbit

free_groups_26-1.2.0/docs/source/functionality/letter.rst

@@ -0,0 +1,16 @@
+Letter Functions
+=====================
+
+.. py:currentmodule:: free_groups_26
+
+.. testsetup::
+
+   from free_groups_26 import letter_from_str_a, letter_from_str_b, letter_from_str
+
+These functions are defined in ``free_groups_26.letter``.
+
+.. autofunction:: letter_from_str_a
+
+.. autofunction:: letter_from_str_b
+
+.. autofunction:: letter_from_str