Bipart hpp

libsemigroups · Aug 1, 2024 · 952b6e0 · 952b6e0
1 parent 248acbe
commit 952b6e0
Show file tree

Hide file tree

Showing 19 changed files with 788 additions and 652 deletions.
diff --git a/docs/source/data-structures/elements/bipart-helpers.rst b/docs/source/data-structures/elements/bipart-helpers.rst
@@ -0,0 +1,15 @@
+.. Copyright (c) 2024 J. D. Mitchell
+
+   Distributed under the terms of the GPL license version 3.
+
+   The full license is in the file LICENSE, distributed with this software.
+
+Bipartition helpers
+===================
+
+This page contains the documentation for various helper functions for
+manipulating bipartitions.
+
+.. automodule:: libsemigroups_pybind11.bipartition
+   :members:
+   :imported-members:
diff --git a/docs/source/data-structures/elements/bipart.rst b/docs/source/data-structures/elements/bipart.rst
@@ -9,4 +9,23 @@
 Bipartition
 ===========
 
-TODO
+This page contains an overview of the functionality in
+``libsemigroups_pybind11`` for bipartitions and blocks.
+
+There are a number of functions for computing things about
+:py:class:`Bipartition` objects detailed below.
+
+.. toctree::
+   :maxdepth: 1
+
+   bipart-helpers
+
+Full API
+--------
+
+.. autoclass:: Bipartition
+   :class-doc-from: class
+   :members:
+   :inherited-members:
+   :special-members: __init__
+
diff --git a/docs/source/data-structures/elements/blocks-helpers.rst b/docs/source/data-structures/elements/blocks-helpers.rst
@@ -0,0 +1,15 @@
+.. Copyright (c) 2024 J. D. Mitchell
+
+   Distributed under the terms of the GPL license version 3.
+
+   The full license is in the file LICENSE, distributed with this software.
+
+Blocks helpers
+==============
+
+This page contains the documentation for various helper functions for
+manipulating blocks.
+
+.. automodule:: libsemigroups_pybind11.blocks
+   :members:
+   :imported-members:
diff --git a/docs/source/data-structures/elements/blocks.rst b/docs/source/data-structures/elements/blocks.rst
@@ -0,0 +1,46 @@
+.. Copyright (c) 2021-2024 J. D. Mitchell
+
+   Distributed under the terms of the GPL license version 3.
+
+   The full license is in the file LICENSE, distributed with this software.
+
+.. currentmodule:: _libsemigroups_pybind11
+
+Blocks
+======
+
+This page contains an overview of the functionality in
+``libsemigroups_pybind11`` for blocks. See also :any:`Bipartition` for more
+details and context.
+
+There are a number of functions for computing things about
+:py:class:`Blocks` objects detailed below.
+
+.. toctree::
+   :maxdepth: 1
+
+   blocks-helpers
+
+Contents
+--------
+
+.. autosummary::
+   :nosignatures:
+
+   ~Blocks
+   Blocks.copy
+   Blocks.degree
+   Blocks.is_transverse_block
+   Blocks.iterator
+   Blocks.lookup
+   Blocks.number_of_blocks
+   Blocks.rank
+
+Full API
+--------
+
+.. autoclass:: Blocks
+   :class-doc-from: class
+   :members:
+   :inherited-members:
+   :special-members: __init__
diff --git a/docs/source/data-structures/elements/index.rst b/docs/source/data-structures/elements/index.rst
@@ -14,6 +14,7 @@ This page contains an overview summary of the functionality in
    :maxdepth: 1
 
    bipart
+   blocks
    matrix/index
    pperm
    perm

diff --git a/libsemigroups_pybind11/__init__.py b/libsemigroups_pybind11/__init__.py
@@ -52,6 +52,8 @@
         BMat8,
         side,
         AhoCorasick,
+        Bipartition,
+        Blocks,
     )
 except ModuleNotFoundError as e:
     raise ModuleNotFoundError(

diff --git a/libsemigroups_pybind11/bipartition.py b/libsemigroups_pybind11/bipartition.py
@@ -0,0 +1,19 @@
+# -*- coding: utf-8 -*-
+
+# Copyright (c) 2024 J. D. Mitchell
+#
+# Distributed under the terms of the GPL license version 3.
+#
+# The full license is in the file LICENSE, distributed with this software.
+
+# pylint: disable=no-name-in-module, invalid-name, unused-import, fixme
+
+"""
+This package provides the user-facing python part of libsemigroups_pybind11 for
+the libsemigroups::bipartition namespace from libsemigroups.
+"""
+
+from _libsemigroups_pybind11 import (
+    bipartition_underlying_partition as underlying_partition,
+    bipartition_one as one,
+)
diff --git a/libsemigroups_pybind11/blocks.py b/libsemigroups_pybind11/blocks.py
@@ -0,0 +1,18 @@
+# -*- coding: utf-8 -*-
+
+# Copyright (c) 2024 J. D. Mitchell
+#
+# Distributed under the terms of the GPL license version 3.
+#
+# The full license is in the file LICENSE, distributed with this software.
+
+# pylint: disable=no-name-in-module, invalid-name, unused-import, fixme
+
+"""
+This package provides the user-facing python part of ``libsemigroups_pybind11`` for
+the ``libsemigroups::blocks`` namespace from ``libsemigroups``.
+"""
+
+from _libsemigroups_pybind11 import (
+    blocks_underlying_partition as underlying_partition,
+)
diff --git a/libsemigroups_pybind11/fpsemigroup.py b/libsemigroups_pybind11/fpsemigroup.py
@@ -14,7 +14,7 @@
 """
 
 from _libsemigroups_pybind11 import (
-    author,
+    # author,
     symmetric_group,
     alternating_group,
     full_transformation_monoid,
-Original file line number
+Diff line change
@@ Expand Up @@
        :maxdepth: 1
        bipart
+       blocks
        matrix/index
        pperm
        perm
@@ Expand Down @@