qiskit-community / qiskit-community/mapomatic

`matching_layout` should return `Iterable`

Open
#79 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Python
Stars
64
Forks
17
PR merge metrics
No merged PRs in 30d

Description

Since vf2_mapping returns and Iterator as stated in documentation, matching_layouts. could return the same (or alternatively, another function could be introduced that returns iterator for back-compatibility). Personally, I could use to start exploring mappings on the way and being able to stop it at the point I would be satisfied with the result.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reading the matching_layouts API and compare its behavior with the documented vf2_mapping iterator. Determine whether matching_layouts should become iterable or whether a separate iterator API is needed for back-compatibility. Done means the chosen API supports stopping while exploring mappings and preserves compatibility where required.

Written by the indexing model from the issue text.

Assessment

Tech stack
python, rust
Domain
api, backend-api-design
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.