Welcome to APyTypes’ documentation!

APyTypes is a Python library providing algorithmic data types, both fixed- and floating-point in Python. The main purpose is to simplify finite word length design and simulation. Written in C++, the focus is on performance and flexibility.

The repository can be found at https://github.com/apytypes/apytypes. Please report any issues or suggestions there. Contributions are also welcome!

To install APyTypes do

pip install apytypes

To install the latest version from source, without having to set up git etc, do

pip install git+https://github.com/apytypes/apytypes.git

Or look at the Development instructions.

Now, have a look at the examples and play around. Using an enhanced terminal, like Jupyter Notebooks or Spyder, will provide a nicer output of the numbers.

Contents:

• apytypes Python package
• APyTypes C++ API
• Examples
• Computational performance
• Comparison
• Development
• Publications
• Changelog
• Licenses

Indices and tables

• Index

• Module Index

• Search Page

APyTypes is developed by the Division of Electronics and Computer Engineering at Linköping University, Sweden.