..
    Copyright (c) 2019 The STE||AR-Group

    SPDX-License-Identifier: BSL-1.0
    Distributed under the Boost Software License, Version 1.0. (See accompanying
    file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)

.. _modules_topology:

========
topology
========

This module provides the class :cpp:class:`hpx::threads::topology` which
represents the hardware resources available on a node. The class is a light
wrapper around the |hwloc|_ library. The :cpp:class:`hpx::threads::cpu_mask` is
a small companion class that represents a set of resources on a node.

See the :ref:`API reference <modules_topology_api>` of the module for more details.
