.. qmatmul: Fast multiplication of quaternion-valued matrices documentation master file, created by
   sphinx-quickstart on Wed May 20 12:39:57 2026.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

qmatmul: Fast multiplication of quaternion-valued matrices (P. Klęsk, A. Cariow)
================================================================================

Welcome to qmatmul's documentation!
-----------------------------------

The core functionalities of this project are embodied in the :doc:`qmatmul`.

We suggest importing it in the following way: ``import qmatmul as qmm``, and then perform multiplications of `quaternion`-valued matrices using function ``qmm.dot``.
Other modules involved in the project play the role of auxiliary utilities.

For `usage examples` and additional information please see the :doc:`qmatmul` documentation,
or the README.md file in project's repository: `<https://github.com/pklesk/quaternions>`_.


.. toctree::
   :maxdepth: 2
   :caption: Contents:

   modules