hpcombi: support Vect16 + PTransf16 + Transf16

Author: james-d-mitchell

docs/source/data-structures/elements/transformations/index.rst

@@ -18,3 +18,5 @@ This page describes the functionality for various partial transformations in
     pperm
     transf
     helpers
+
+See also :any:`hpcombi.PTransf16`.

docs/source/data-structures/hpcombi/index.rst

@@ -0,0 +1,29 @@
+..
+    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
+
+HPCombi
+=======
+
+This page describes the functionality from ``HPCombi`` available in 
+``libsemigroups_pybind11``. This functionality is only available if 
+:any:`LIBSEMIGROUPS_HPCOMBI_ENABLED` is ``True``.
+
+.. py:attribute:: LIBSEMIGROUPS_HPCOMBI_ENABLED
+   :type: bool
+
+   This variable indicates whether or not the version of ``libsemigroups``
+   being used by ``libsemigroups_pybind11`` was compiled with ``HPCombi``
+   enabled.
+
+.. toctree::
+    :maxdepth: 1
+
+    ptransf16
+    transf16
+    vect16

docs/source/data-structures/hpcombi/ptransf16.rst

@@ -0,0 +1,48 @@
+..
+    Copyright (c) 2025 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.hpcombi
+
+The PTransf16 class
+===================
+
+.. autoclass:: PTransf16 
+    :doc-only:
+
+Contents
+--------
+
+.. autosummary::
+    :signatures: short
+
+    ~PTransf16
+    PTransf16.domain_bitset
+    PTransf16.domain_mask
+    PTransf16.fix_points_bitset
+    PTransf16.fix_points_mask
+    PTransf16.image_bitset
+    PTransf16.image_mask
+    PTransf16.image_mask_ref
+    PTransf16.largest_fix_point
+    PTransf16.largest_moved_point
+    PTransf16.left_one
+    PTransf16.nb_fix_points
+    PTransf16.one
+    PTransf16.rank
+    PTransf16.rank_cmpestrm
+    PTransf16.rank_ref
+    PTransf16.right_one
+    PTransf16.smallest_fix_point
+    PTransf16.smallest_moved_point
+    PTransf16.validate
+
+Full API
+--------
+
+.. autoclass:: PTransf16
+    :class-doc-from: init
+    :members:

docs/source/data-structures/hpcombi/transf16.rst

@@ -0,0 +1,29 @@
+..
+    Copyright (c) 2025 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.hpcombi
+
+The Transf16 class
+==================
+
+.. autoclass:: Transf16 
+    :doc-only:
+
+Contents
+--------
+
+.. autosummary::
+    :signatures: short
+
+    ~Transf16
+
+Full API
+--------
+
+.. autoclass:: Transf16
+    :class-doc-from: init
+    :members:

docs/source/data-structures/hpcombi/vect16.rst

@@ -0,0 +1,40 @@
+..
+    Copyright (c) 2025 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.hpcombi
+
+The Vect16 class
+================
+
+.. autoclass:: Vect16
+    :doc-only:
+
+Contents
+--------
+
+.. autosummary::
+    :signatures: short
+
+    ~Vect16
+    Vect16.eval16
+    Vect16.first_diff
+    Vect16.first_non_zero
+    Vect16.first_zero
+    Vect16.is_permutation
+    Vect16.last_diff
+    Vect16.last_non_zero
+    Vect16.last_zero
+    Vect16.less_partial
+    Vect16.partial_sums
+    Vect16.sum
+
+Full API
+--------
+
+.. autoclass:: Vect16 
+    :class-doc-from: init
+    :members:

docs/source/index.rst

@@ -139,6 +139,7 @@ We would like to thank the authors and contributors of these projects!
     data-structures/constants/index
     data-structures/elements/index
     data-structures/enums/index
+    data-structures/hpcombi/index
     data-structures/order/index
     data-structures/presentations/index
     data-structures/suffix-trees/index