Add order objects

docs/source/data-structures/order/functions.rst

@@ -0,0 +1,75 @@
+..
+    Copyright (c) 2026 Joseph Edwards, 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
+
+Functions for orders
+====================
+
+This page contains the documentation for functions that compare lists of
+integers ``list[int]`` or strings ``str`` with respect to certain reduction
+orderings.
+
+.. important:: 
+
+   The following functions are deprecated in v1.5.0 and will be removed v2.0.0:
+
+    * ``lexicographical_compare``, please use :any:`lex_cmp` instead.
+    * ``recursive_path_compare`` please use :any:`rev_rpo_cmp` instead.
+    * ``shortlex_compare`` please use :any:`lenlex_cmp` instead.
+
+Contents
+--------
+
+.. autosummary::
+    :signatures: short
+
+    len_wt_lex_cmp
+    lenlex_cmp
+    lex_cmp
+    rev_len_wt_lex_cmp
+    rev_lenlex_cmp
+    rev_lex_cmp
+    rev_rpo_cmp
+    rev_wr_cmp
+    rev_wt_lenlex_cmp
+    rev_wt_lex_cmp
+    rpo_cmp
+    wr_cmp
+    wt_lenlex_cmp
+    wt_lex_cmp
+
+Full API
+--------
+
+.. autofunction:: len_wt_lex_cmp
+
+.. autofunction:: lenlex_cmp
+
+.. autofunction:: lex_cmp
+
+.. autofunction:: rev_len_wt_lex_cmp
+
+.. autofunction:: rev_lenlex_cmp
+
+.. autofunction:: rev_lex_cmp
+
+.. autofunction:: rev_rpo_cmp
+
+.. autofunction:: rev_wr_cmp
+
+.. autofunction:: rev_wt_lenlex_cmp
+
+.. autofunction:: rev_wt_lex_cmp
+
+.. autofunction:: rpo_cmp
+
+.. autofunction:: wr_cmp
+
+.. autofunction:: wt_lenlex_cmp
+
+.. autofunction:: wt_lex_cmp

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

@@ -10,70 +10,33 @@
 Orders
 ======
 
-This page contains the documentation for several functions for comparing words
-or strings with respect to certain reduction orderings.
+This page contains the documentation for classes and several functions for
+comparing words (i.e. lists of integers ``list[int]`` or strings ``str``) with
+respect to certain reduction orderings.
 
 .. seealso::
 
     - :any:`Order`
     - :any:`Alphabet`
 
-.. important:: 
-
-   The following functions are deprecated in v1.5.0 and will be removed v2.0.0:
-
-    * ``lexicographical_compare``, please use :any:`lex_cmp` instead.
-    * ``recursive_path_compare`` please use :any:`rev_rpo_cmp` instead.
-    * ``shortlex_compare`` please use :any:`lenlex_cmp` instead.
-
-Contents
---------
-
-.. autosummary::
-    :signatures: short
-
-    len_wt_lex_cmp
-    lenlex_cmp
-    lex_cmp
-    rev_len_wt_lex_cmp
-    rev_lenlex_cmp
-    rev_lex_cmp
-    rev_rpo_cmp
-    rev_wr_cmp
-    rev_wt_lenlex_cmp
-    rev_wt_lex_cmp
-    rpo_cmp
-    wr_cmp
-    wt_lenlex_cmp
-    wt_lex_cmp
-
-Full API
---------
-
-.. autofunction:: len_wt_lex_cmp
-
-.. autofunction:: lenlex_cmp
-
-.. autofunction:: lex_cmp
-
-.. autofunction:: rev_len_wt_lex_cmp
-
-.. autofunction:: rev_lenlex_cmp
-
-.. autofunction:: rev_lex_cmp
-
-.. autofunction:: rev_rpo_cmp
-
-.. autofunction:: rev_wr_cmp
-
-.. autofunction:: rev_wt_lenlex_cmp
-
-.. autofunction:: rev_wt_lex_cmp
-
-.. autofunction:: rpo_cmp
-
-.. autofunction:: wr_cmp
-
-.. autofunction:: wt_lenlex_cmp
-
-.. autofunction:: wt_lex_cmp
+The classes and functions in ``libsemigroups_pybind11`` for comparing words
+are described on the following pages:
+
+.. toctree::
+    :maxdepth: 1
+
+    lex-cmp
+    rev-lex-cmp
+    lenlex-cmp
+    rev-lenlex-cmp
+    rpo-cmp
+    rev-rpo-cmp
+    wr-cmp
+    rev-wr-cmp
+    wt-lenlex-cmp
+    rev-wt-lenlex-cmp
+    wt-lex-cmp
+    rev-wt-lex-cmp
+    len-wt-lex-cmp
+    rev-len-wt-lex-cmp
+    functions

docs/source/data-structures/order/len-wt-lex-cmp.rst

@@ -0,0 +1,35 @@
+..
+    Copyright (c) 2026 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
+
+The LenWtLexCmp class
+=====================
+
+.. autoclass:: LenWtLexCmp
+    :doc-only:
+
+Contents
+--------
+
+.. autosummary::
+    :signatures: short
+
+    ~LenWtLexCmp
+    LenWtLexCmp.__call__
+    LenWtLexCmp.alphabet
+    LenWtLexCmp.copy
+    LenWtLexCmp.init
+    LenWtLexCmp.weights
+
+Full API
+--------
+
+.. autoclass:: LenWtLexCmp
+    :class-doc-from: init
+    :special-members: __call__
+    :members:

docs/source/data-structures/order/lenlex-cmp.rst

@@ -0,0 +1,34 @@
+..
+    Copyright (c) 2026 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
+
+The LenLexCmp class
+===================
+
+.. autoclass:: LenLexCmp
+    :doc-only:
+
+Contents
+--------
+
+.. autosummary::
+    :signatures: short
+
+    ~LenLexCmp
+    LenLexCmp.__call__
+    LenLexCmp.alphabet
+    LenLexCmp.copy
+    LenLexCmp.init
+
+Full API
+--------
+
+.. autoclass:: LenLexCmp
+    :class-doc-from: init
+    :special-members: __call__
+    :members:

docs/source/data-structures/order/lex-cmp.rst

@@ -0,0 +1,34 @@
+..
+    Copyright (c) 2026 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
+
+The LexCmp class
+================
+
+.. autoclass:: LexCmp
+    :doc-only:
+
+Contents
+--------
+
+.. autosummary::
+    :signatures: short
+
+    ~LexCmp
+    LexCmp.__call__
+    LexCmp.alphabet
+    LexCmp.copy
+    LexCmp.init
+
+Full API
+--------
+
+.. autoclass:: LexCmp
+    :class-doc-from: init
+    :special-members: __call__
+    :members:

docs/source/data-structures/order/rev-len-wt-lex-cmp.rst

@@ -0,0 +1,35 @@
+..
+    Copyright (c) 2026 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
+
+The RevLenWtLexCmp class
+========================
+
+.. autoclass:: RevLenWtLexCmp
+    :doc-only:
+
+Contents
+--------
+
+.. autosummary::
+    :signatures: short
+
+    ~RevLenWtLexCmp
+    RevLenWtLexCmp.__call__
+    RevLenWtLexCmp.alphabet
+    RevLenWtLexCmp.copy
+    RevLenWtLexCmp.init
+    RevLenWtLexCmp.weights
+
+Full API
+--------
+
+.. autoclass:: RevLenWtLexCmp
+    :class-doc-from: init
+    :special-members: __call__
+    :members:

docs/source/data-structures/order/rev-lenlex-cmp.rst

@@ -0,0 +1,34 @@
+..
+    Copyright (c) 2026 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
+
+The RevLenLexCmp class
+======================
+
+.. autoclass:: RevLenLexCmp
+    :doc-only:
+
+Contents
+--------
+
+.. autosummary::
+    :signatures: short
+
+    ~RevLenLexCmp
+    RevLenLexCmp.__call__
+    RevLenLexCmp.alphabet
+    RevLenLexCmp.copy
+    RevLenLexCmp.init
+
+Full API
+--------
+
+.. autoclass:: RevLenLexCmp
+    :class-doc-from: init
+    :special-members: __call__
+    :members:

docs/source/data-structures/order/rev-lex-cmp.rst

@@ -0,0 +1,34 @@
+..
+    Copyright (c) 2026 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
+
+The RevLexCmp class
+===================
+
+.. autoclass:: RevLexCmp
+    :doc-only:
+
+Contents
+--------
+
+.. autosummary::
+    :signatures: short
+
+    ~RevLexCmp
+    RevLexCmp.__call__
+    RevLexCmp.alphabet
+    RevLexCmp.copy
+    RevLexCmp.init
+
+Full API
+--------
+
+.. autoclass:: RevLexCmp
+    :class-doc-from: init
+    :special-members: __call__
+    :members: