.. Copyright (c) 2019-22, 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.

   This file was auto-generated by docs/generate_from_yml.py, do not edit.

Blocks
======

.. doxygenclass:: libsemigroups::Blocks
   :project: libsemigroups

.. cpp:namespace:: libsemigroups::Blocks


Member types
------------
.. list-table::
   :widths: 50 50
   :header-rows: 0

   * - :cpp:member:`const_iterator`
     - Type for const iterators pointing to the index of the block.


   * - :cpp:member:`iterator`
     - Type for iterators pointing to the index of the block.


   * - :cpp:member:`lookup_const_iterator`
     - Type for const iterators pointing to the transverse block lookup.



Constructors
------------
.. list-table::
   :widths: 50 50
   :header-rows: 0

   * - :cpp:member:`Blocks() noexcept = default`
     - 
   * - :cpp:member:`Blocks(Blocks const&) = default`
     - Default copy constructor.


   * - :cpp:member:`Blocks(Blocks&&) = default`
     - Default move constructor.


   * - :cpp:member:`Blocks(const_iterator,const_iterator)`
     - 
   * - :cpp:member:`Blocks(size_t)`
     - 
   * - :cpp:member:`operator=(Blocks const&) = default`
     - Default copy assignment operator.


   * - :cpp:member:`operator=(Blocks&&) = default`
     - Default move assignment operator.



Initialisation
--------------
.. list-table::
   :widths: 50 50
   :header-rows: 0

   * - :cpp:member:`set_block(size_t, uint32_t)`
     - 
   * - :cpp:member:`set_is_transverse_block(size_t, bool)`
     - 

Operators
---------
.. list-table::
   :widths: 50 50
   :header-rows: 0

   * - :cpp:member:`operator!=(Blocks const&) const`
     - 
   * - :cpp:member:`operator<(Blocks const&) const`
     - 
   * - :cpp:member:`operator==(Blocks const&) const`
     - 
   * - :cpp:member:`operator[](size_t) const`
     - 

Attributes
----------
.. list-table::
   :widths: 50 50
   :header-rows: 0

   * - :cpp:member:`degree() const noexcept`
     - 
   * - :cpp:member:`hash_value() const noexcept`
     - 
   * - :cpp:member:`is_transverse_block(size_t) const noexcept`
     - 
   * - :cpp:member:`number_of_blocks() const noexcept`
     - 
   * - :cpp:member:`rank() const`
     - 

Iterators
---------
.. list-table::
   :widths: 50 50
   :header-rows: 0

   * - :cpp:member:`cbegin() const noexcept`
     - 
   * - :cpp:member:`cbegin_lookup() const noexcept`
     - 
   * - :cpp:member:`cend() const noexcept`
     - 
   * - :cpp:member:`cend_lookup() const noexcept`
     - 

.. toctree::
   :hidden:

   libsemigroups__blocks__member_types.rst
   libsemigroups__blocks__constructors.rst
   libsemigroups__blocks__initialisation.rst
   libsemigroups__blocks__operators.rst
   libsemigroups__blocks__attributes.rst
   libsemigroups__blocks__iterators.rst
