Welcome to libfork - v3.8.0

This is libfork’s API documentation, for info on building and installing please see the README.md.

Core API

namespace core

An inline namespace that wraps core functionality.

This is the namespace that contains the minimal user-facing API of libfork, notably this excludes schedulers and algorithms.

• Core API
  • Enums and tags
    • Dispatch tags
    • Dispatch modifiers
  • Concepts and traits
    • Building blocks
    • API
    • Functional
  • Control flow
    • Sync to async
    • Fork-join
    • Invocation
    • Explicit
    • Advanced/generic
  • Classes
    • Task
    • Future
    • Eventually
    • Defer
    • Exceptions
  • Stack allocation
    • Functions
    • Classes
  • Forward declarations

Schedulers

Schedulers are objects that map the computation graph to worker threads, libfork supplies a selection of useful defaults.

• Schedulers
  • Lazy pool
  • Busy pool
  • Unit pool

Algorithms

Algorithms operate at a higher level of abstraction than pure fork-join, currently libfork does not have many but watch this space…

• Algorithms
  • Concepts and type traits
    • Asynchronous std concepts
    • Asynchronous std traits
    • Groups
    • Constraints
  • Lifting functions
  • Iteration with for_each
  • Transformations with map
  • Reductions with fold
  • Generalized prefix sums with scan

Extension API

namespace ext

An inline namespace that wraps extension functionality.

This namespace is part of libforks public API but is intended for advanced users writing schedulers, It exposes the scheduler/context API’s alongside some implementation details (such as lock-free dequeues, a hwloc abstraction, and synchronization primitives) that could be useful when implementing custom schedulers.

• Extension API
  • Worker API
  • Containers
  • Components

Internal documentation

namespace impl

An internal namespace that wraps implementation details.

Warning

This is exposed as internal documentation only it is not part of the public facing API.

• Internal docs