perf(label_table): add TryGetIdByLabel to avoid exception overhead

[inabao]

close: #1729

[gemini-code-assist]

Summary of Changes

Hello, I'm Gemini Code Assist¹! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request focuses on a performance enhancement by modifying the label lookup mechanism. It introduces a non-throwing alternative for retrieving inner IDs by label, which is then integrated into core algorithm components. This change is designed to reduce the computational cost associated with exception handling, particularly in scenarios where label lookups might frequently fail or involve removed labels, leading to a more efficient system overall.

Highlights

• Performance Optimization: Introduced a new method, TryGetIdByLabel, to avoid the overhead of exception handling in performance-critical label lookup operations. This method returns a std::pair<bool, InnerIdType> indicating success or failure, rather than throwing an exception.
• Refactored GetIdByLabel: The existing GetIdByLabel method was refactored to internally use TryGetIdByLabel and only throw an exception if TryGetIdByLabel indicates a lookup failure, maintaining its original behavior for callers expecting exceptions.
• Integration into Algorithms: Updated InnerIndexInterface::cal_distance_by_id and SparseIndex::CalDistanceById to utilize the new TryGetIdByLabel method, replacing try-catch blocks with conditional checks for improved performance.

🧠 New Feature in Public Preview: You can now enable Memory to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console.

Changelog

• src/algorithm/inner_index_interface.cpp
  • Replaced exception-based GetIdByLabel call with TryGetIdByLabel and a conditional check.
  • Updated error handling logic to check the success flag from TryGetIdByLabel.
• src/algorithm/sparse_index.cpp
  • Replaced exception-based GetIdByLabel call with TryGetIdByLabel and a conditional check.
  • Updated error handling logic to check the success flag from TryGetIdByLabel.
• src/impl/label_table.cpp
  • Implemented TryGetIdByLabel to return a std::pair<bool, InnerIdType> indicating lookup success and the inner ID.
  • Modified TryGetIdByLabel to handle INVALID_ID and removed labels by returning false instead of throwing exceptions.
  • Refactored GetIdByLabel to call TryGetIdByLabel and throw a VsagException only if the lookup fails.
• src/impl/label_table.h
  • Added the declaration for the new TryGetIdByLabel method.
• src/impl/label_table_test.cpp
  • Added a new test section for TryGetIdByLabel covering successful lookups, non-existent labels, and removed labels.
  • Included tests for TryGetIdByLabel with return_even_removed parameter.
  • Added tests for TryGetIdByLabel functionality when the reverse map is not used.

Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature	Command	Description
Code Review	/gemini review	Performs a code review for the current pull request in its current state.
Pull Request Summary	/gemini summary	Provides a summary of the current pull request in its current state.
Comment	@gemini-code-assist	Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help	/gemini help	Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for GitHub and other Google products, sign up here.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩

[gemini-code-assist]

Code Review

The pull request successfully refactors the GetIdByLabel functionality by introducing a new TryGetIdByLabel method. This change effectively replaces exception-based error handling with a return value for expected "not found" scenarios, which is a good practice for performance optimization in C++ by avoiding the overhead associated with exceptions. The new method is correctly integrated into the existing GetIdByLabel and other call sites, and comprehensive unit tests have been added to cover its behavior, including cases for successful lookups, non-existent labels, and removed labels.

[LHT129]

LGTM

[wxyucs]

@inabao this pull request cannot cherry-pick the branch 0.16 (CONFLICTS) please create a new pull request to the branch 0.16 .

[wxyucs]

@inabao this pull request cannot cherry-pick to the branch 0.18 (CONFLICTS), please create a nrew pull request to the branch 0.18 .

[wxyucs]

patch to 0.15 in #1769