Skip to content

Rename Hit struct to Match#446

Merged
marcelm merged 1 commit intomainfrom
rename-hit
Oct 4, 2024
Merged

Rename Hit struct to Match#446
marcelm merged 1 commit intomainfrom
rename-hit

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
@marcelm marcelm deleted the rename-hit branch October 4, 2024 14:02
rebjannik pushed a commit to rebjannik/strobealign that referenced this pull request May 17, 2025
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