3. API documentation

Topics

3.1 Scheduling a task

3.2 Returning from a task

3.3 Futures and promises

3.4 Task continuations

3.5 Waiting for completion

3.6 Shutdown

3.7 Mutexes and condition variables

3.8 Joining futures

3.9 Parallel forEach and mapReduce

3.10 Sequencing tasks

Overview

This chapter contains lots of examples and use-cases on how to use the quantum library properly. Not all methods and interfaces are discussed however, which means that it is up to the individual programmer to read the API documentation and familiarize himself/herself with the concepts. The important headers files to read are located under the quantum/interface directory, since all API access is achieved via interfaces.

NOTE: For brevity purposes, all class names in the code examples are shown without the Bloomberg::quantum namespace.