Merge pull request #155 from PermutaTriangle/develop

v2.0.3

Author: christianbean

.github/workflows/build-and-deploy.yml

@@ -0,0 +1,26 @@
+name: build-and-deploy
+
+on:
+  push:
+    branches:
+      - master
+
+jobs:
+  build-and-deploy:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+    - uses: actions/setup-python@v2
+      with:
+        python-version: 3.8
+    - name: install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install setuptools wheel twine
+    - name: build
+      run: python setup.py sdist
+    - name: deploy
+      env:
+        TWINE_USERNAME: __token__
+        TWINE_PASSWORD: ${{ secrets.PYPI_PASSWORD }}
+      run: twine upload dist/*

.github/workflows/test.yml

@@ -0,0 +1,58 @@
+name: tests
+
+on: [push, pull_request]
+
+jobs:
+
+  test:
+    strategy:
+      fail-fast: false
+      matrix:
+        include:
+          - python: 3.8
+            toxenv: flake8
+            os: ubuntu-latest
+          - python: 3.8
+            toxenv: mypy
+            os: ubuntu-latest
+          - python: 3.8
+            toxenv: pylint
+            os: ubuntu-latest
+          - python: 3.8
+            toxenv: black
+            os: ubuntu-latest
+
+          - python: 3.7
+            toxenv: py37
+            os: ubuntu-latest
+          - python: 3.8
+            toxenv: py38
+            os: ubuntu-latest
+          - python: 3.9
+            toxenv: py39
+            os: ubuntu-latest
+          - python: pypy-3.7
+            toxenv: pypy37
+            os: ubuntu-latest
+
+          - python: 3.8
+            toxenv: py38
+            os: macos-latest
+          - python: 3.8
+            toxenv: py38
+            os: windows-latest
+
+    runs-on: ${{ matrix.os }}
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions/setup-python@v2
+        with:
+          python-version: ${{  matrix.python }}
+      - name: install dependencies
+        run: python -m pip install --upgrade pip tox
+      - name: run
+        env:
+          TOXENV: ${{ matrix.toxenv }}
+        run: tox
+      - name: setup
+        run: python setup.py install

.pre-commit-config.yaml

@@ -1,5 +1,5 @@
 repos:
   - repo: https://github.com/psf/black
-    rev: stable
+    rev: 20.8b0
     hooks:
       - id: black

.pylintrc

@@ -9,7 +9,8 @@ ignore= tests
 init-hook="from pylint.config import find_pylintrc; import os, sys; sys.path.append(os.path.dirname(find_pylintrc())+'/permuta')"
 disable=bad-continuation, 
         missing-module-docstring,
-        fixme
+        fixme,
+        unsubscriptable-object
 good-names=i,j,n,k,x,y,_
 
 [SIMILARITIES]

.travis.yml

@@ -0,0 +1,43 @@
+{
+    "upload_type": "software",
+    "creators": [
+        {
+            "name": "Ragnar Pall Ardal"
+        },
+        {
+            "name": "Tomas Ken Magnusson"
+        },
+        {
+            "affiliation": "Reykjavik University",
+            "name": "Émile Nadeau"
+        },
+        {
+            "name": "Bjarni Jens Kristinsson"
+        },
+        {
+            "name": "Bjarki Agust Gudmundsson"
+        },
+        {
+            "affiliation": "Reykjavik University",
+            "name": "Christian Bean"
+        },
+        {
+            "affiliation": "Reykjavik University",
+            "name": "Henning Ulfarsson"
+        },
+        {
+            "affiliation": "Reykjavik University",
+            "name": "Jon Steinn Eliasson"
+        },
+        {
+            "name": "Murray Tannock"
+        },
+        {
+            "name": "Alfur Birkir Bjarnason"
+        },
+        {
+            "affiliation": "Marquette University",
+            "name": "Jay Pantone"
+        },
+    ]
+}

.zenodo.json

@@ -6,6 +6,17 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 
 ## Unreleased
 
+## 2.0.3 - 2021-04-28
+### Added
+ - using Github Actions for testing and deployment
+ - `containment_to_tikz` method in `Perm` that returns an iterator of tikz pictures
+   displaying occurrences of classical patterns in self.
+ - `permuta.permutils.PermutationStatistic` to check statistic distribution in
+   classes and preservation and transformation in bijections.
+
+### Deprecated
+ - Python 3.6 is no longer supported
+
 ## 2.0.2 - 2020-08-06
 ### Fixed
   - Include the type hints in the pypi release.

CHANGELOG.md

@@ -186,6 +186,93 @@ You can get its enumeration up to a fixed length.
     >>> perm_class.count(11)
     1024
 
+You can also look to see if some well know enumeration strategies apply to a
+given class.
+
+.. code-block:: python
+
+    >>> from permuta.enumeration_strategies import find_strategies
+    >>> basis = [Perm((3, 2, 0, 1)), Perm((1, 0, 2, 3))]
+    >>> for strat in find_strategies(basis):
+    ...     print(strat.reference())
+    The insertion encoding of permutations: Corollary 10
+    >>> basis = [Perm((1, 2, 0, 3)), Perm((2, 0, 1, 3)), Perm((0, 1, 2, 3))]
+    >>> for strat in find_strategies(basis):
+    ...     print(strat.reference())
+    Enumeration of Permutation Classes and Weighted Labelled Independent Sets: Corollary 4.3
+
+Permutation statistics
+######################
+
+With the ``PermutationStatistic`` class we can look for distributions of statistics for
+classes and look for statistics preservations (or transformation) either for two classes
+or given a bijection. First we need to import it.
+
+.. code-block:: python
+
+    >>> from permuta.permutils.statistics import PermutationStatistic
+
+To see a distribution for a given statistic we grab its instance and provide a length
+and a class (no class will use the set of all permutations).
+
+.. code-block:: python
+
+    >>> PermutationStatistic.show_predefined_statistics() # Show all statistics with id
+    [0] Number of inversions
+    [1] Number of non-inversions
+    [2] Major index
+    [3] Number of descents
+    [4] Number of ascents
+    [5] Number of peaks
+    [6] Number of valleys
+    [7] Number of cycles
+    [8] Number of left-to-right minimas
+    [9] Number of left-to-right maximas
+    [10] Number of right-to-left minimas
+    [11] Number of right-to-left maximas
+    [12] Number of fixed points
+    [13] Order
+    [14] Longest increasing subsequence
+    [15] Longest decreasing subsequence
+    [16] Depth
+    >>> depth = PermutationStatistic.get_by_index(16)
+    >>> depth.distribution_for_length(5)
+    [1, 4, 12, 24, 35, 24, 20]
+    >>> depth.distribution_up_to(4, Av.from_string("123"))
+    [[1], [1], [1, 1], [0, 2, 3], [0, 0, 3, 7, 4]]
+
+Given a bijection as a dictionary, we can check which statistics are preserved with 
+``check_all_preservations`` and which are transformed with ``check_all_transformed``
+
+.. code-block:: python
+
+    >>> bijection = {p: p.reverse() for p in Perm.up_to_length(5)}
+    >>> for stat in PermutationStatistic.check_all_preservations(bijection):
+    ...     print(stat)
+    Number of peaks
+    Number of valleys
+
+We can find all (predefined) statistics equally distributed over two permutation
+classes with ``equally_distributed``. We also support checks for joint distribution
+of more than one statistics with ``jointly_equally_distributed`` and transformation
+of jointly distributed stats with ``jointly_transformed_equally_distributed``.
+
+.. code-block:: python
+
+    >>> cls1 = Av.from_string("2143,415263")
+    >>> cls2 = Av.from_string("3142")
+    >>> for stat in PermutationStatistic.equally_distributed(cls1, cls2, 6):
+    ...     print(stat)
+    Major index
+    Number of descents
+    Number of ascents
+    Number of peaks
+    Number of valleys
+    Number of left-to-right minimas
+    Number of right-to-left maximas
+    Longest increasing subsequence
+    Longest decreasing subsequence
+
 The BiSC algorithm
 ==================
 

README.rst

@@ -1,6 +1,8 @@
 from .patterns import BivincularPatt, CovincularPatt, MeshPatt, Perm, VincularPatt
 from .perm_sets.permset import Av, Basis, MeshBasis
 
+__version__ = "2.0.3"
+
 __all__ = [
     "Perm",
     "Av",

permuta/__init__.py

@@ -68,9 +68,7 @@ def get_parser() -> argparse.ArgumentParser:
         description="A tool to quickly get the enumeration of permutation classes",
     )
     count_parser.set_defaults(func=enumerate_class)
-    count_parser.add_argument(
-        "basis", help=basis_str,
-    )
+    count_parser.add_argument("basis", help=basis_str)
 
     # The insenc command
     insenc_parser: argparse.ArgumentParser = subparsers.add_parser(
@@ -79,9 +77,7 @@ def get_parser() -> argparse.ArgumentParser:
         " encoding.",
     )
     insenc_parser.set_defaults(func=has_regular_insertion_encoding)
-    insenc_parser.add_argument(
-        "basis", help=basis_str,
-    )
+    insenc_parser.add_argument("basis", help=basis_str)
 
     # The lexmin command
     lexmin_parser: argparse.ArgumentParser = subparsers.add_parser(
@@ -90,9 +86,7 @@ def get_parser() -> argparse.ArgumentParser:
         "representation of the basis.",
     )
     lexmin_parser.set_defaults(func=get_lex_min)
-    lexmin_parser.add_argument(
-        "basis", help=basis_str,
-    )
+    lexmin_parser.add_argument("basis", help=basis_str)
 
     # The poly command
     poly_parser: argparse.ArgumentParser = subparsers.add_parser(