Skip to content

Latest commit

 

History

History
44 lines (26 loc) · 1.11 KB

call_operator.rst

File metadata and controls

44 lines (26 loc) · 1.11 KB

operator()

.. cpp:function:: scalar_reference operator()(size_t const i)

   Returns a reference to the specified entry of the matrix.

   :param i: the index of the entry

   :returns: A value of type :cpp:any:`scalar_reference`.

   :exceptions:
     This function guarantees not to throw a :cpp:any:`LibsemigroupsException`.

   :complexity:
     Constant

   .. warning::
      No checks on the validity of the parameter ``i`` is performed.

.. cpp:function:: scalar_const_reference operator()(size_t const i) const

   Returns a const reference to the specified entry of the matrix.

   :param i: the index of the entry

   :returns: A value of type :cpp:any:`scalar_const_reference`.

   :exceptions:
     This function guarantees not to throw a :cpp:any:`LibsemigroupsException`.

   :complexity:
     Constant

   .. warning::
      No checks on the validity of the parameter ``i`` is performed.