Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Rename Hit struct to Match #446

Merged
merged 1 commit into from
Oct 4, 2024
Merged

Rename Hit struct to Match #446

merged 1 commit into from
Oct 4, 2024

Conversation

marcelm
Copy link
Collaborator

@marcelm marcelm commented Oct 1, 2024

We use the term "hit" both for

  • a query strobemer successfully looked up in the index
  • a locus on the query paired with a locus on the reference (this type of hit is merged into NAMs)

I think choosing the name for the latter to be "match" makes sense because the M in NAM stands for "match". That is, we can then say that we merge multiple overlapping matches into non-overlapping, approximate matches (=NAMs).

The flow would then be: hit -> match -> NAM.

Marking as draft because this should only be merged after #426 as it will otherwise cause conflicts.

@ksahlin
Copy link
Owner

ksahlin commented Oct 1, 2024

Great, approved for merge after #426.

We use the term "hit" both for
- a query strobemer successfully looked up in the index
- a locus on the query paired with a locus on the reference (this type of
  hit is merged into NAMs)

I think choosing the name for the latter to be "match" makes sense because
the M in NAM stands for "match". That is, we can then say that we merge
multiple overlapping matches into non-overlapping, approximate matches (=NAMs).

The flow would then be: hit -> match -> NAM.
@marcelm marcelm marked this pull request as ready for review October 4, 2024 13:53
@marcelm
Copy link
Collaborator Author

marcelm commented Oct 4, 2024

After merging most of #426, this PR no longer conflicts, so merging.

@marcelm marcelm merged commit 2491b3d into main Oct 4, 2024
11 checks passed
@marcelm marcelm deleted the rename-hit branch October 4, 2024 14:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants