NVIDIA / NVIDIA/cuvs

[FEA] Rename C enums to avoid symbol collisions

Open
#1,717 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

feature request
Dominant language
Cuda
Stars
854
Forks
236
Avg merge
3d 3h
Merged PRs (30d)
62

Description

C enums in the global namespace should be renamed to avoid symbol collisions.
https://github.com/rapidsai/cuvs/pull/1278#discussion_r2699764485

Here's a non-exhaustive list of potential enum to rename:

  • cuvsKMeansInitMethod
  • cuvsDistanceType
  • cuvsCagraGraphBuildAlgo
  • cuvsCagraSearchAlgo
  • cuvsCagraHashMode
  • cuvsFilterType
  • cuvsHnswHierarchy
  • cuvsBinaryQuantizerThreshold

Contributor guide

Open the contributing guide

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 with the linked pull-request discussion, then search the repository for each listed enum name, including cuvsKMeansInitMethod and cuvsDistanceType. Map every global C enum declaration and its uses before deciding on consistent replacements. Done means the affected enums no longer collide in the global namespace and all references are updated.

Written by the indexing model from the issue text.

Assessment

Tech stack
c
Domain
api
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 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.