C API

The C API allows any language that supports C bindings to use DQCsim for making plugins or host programs. It consists of a shared object and a header file, which are automatically installed along with the DQCsim Python package (more detailed notes here).

How to read this chapter

The sections form a somewhat coherent story that runs you through the entire API, starting with some conceptual things, and followed by a walkthrough of the objects encapsulated by the API using a bottom-up approach. The final section summarizes all the functions/types exposed by the API in alphabetical order, in case you're just looking for a searchable list.

The documentation assumes that you already know what DQCsim is, and have a decent understanding of the basic concepts. If you don't, start here.

Contents