pw_coverage/docs.rst

.. _module-pw_coverage:

===========
pw_coverage
===========
.. pigweed-module::
   :name: pw_coverage

   - **Optimization**: Generate optimal test suites using standard solvers
   - **Scale**: Handle millions of configurations efficiently
   - **Clarity**: Declarative Python API for defining constraints and goals

   :py:mod:`pw_coverage` provides tools for generating, optimizing, and managing
   test configurations. It bridges the gap between simple matrix testing (which requires
   exhaustive enumeration) and complex real-world requirements involving hard constraints,
   resource costs, and coverage goals.

   The module currently features a **Config Solver** that uses Google OR-Tools to
   solve the "Weighted Set Cover" problem for test configuration selection.

.. grid:: 1

   .. grid-item-card:: :octicon:`codespaces` Config Solver
      :link: module-pw_coverage-config_solver
      :link-type: ref
      :class-item: sales-pitch-cta-primary

      A constraint solver for generating optimal test configurations.

.. toctree::
   :maxdepth: 1
   :hidden:

   config_solver
   coverage_formulation