Added cppcoreguidelines-init-variables check to .clang-tidy

[Mohit242-bit]

This PR adds the cppcoreguidelines-init-variables check to the .clang-tidy configuration.

#What does this check do?

• Ensures all variables are initialized before use
• Catches uninitialized variable bugs
• Follows C++ Core Guidelines best practices

Changes made:

• Modified .clang-tidy to include cppcoreguidelines-init-variables check

Summary by CodeRabbit

• Chores

  • Added a new static analysis check to enforce variable initialization across the project.

• Bug Fixes

  • Initialized numerous local variables and flags throughout the codebase to prevent use-of-uninitialized values, improving stability, determinism, and reducing risk of undefined behavior. No public API or behavior changes intended.

_{✏️ Tip: You can customize this high-level summary in your review settings.}

[coderabbitai]

Note

Other AI code review bot(s) detected

CodeRabbit has detected other AI code review bot(s) in this pull request and will avoid duplicating their findings in the review comments. This may lead to a less comprehensive review.

Walkthrough

Seeded explicit initializations across many headers and sources (booleans, counters, numerics, loop indices) and added cppcoreguidelines-init-variables to .clang-tidy. No public API or exported-symbol signatures were changed.

Changes

Cohort / File(s)	Summary
Clang-Tidy Configuration /.clang-tidy	Adds cppcoreguidelines-init-variables to the Checks list (preserves existing checks and ordering).
Contraction / Hierarchies include/contraction/contractionGraph.hpp, include/contraction/contractionHierarchies.hpp, include/contraction/linearContraction.hpp	Initialize local booleans and numerics (inserted, found_e, found_f, found_g, p_max, n_old_edges, m, etc.) to avoid use-before-init.
Routing / A* include/bdAstar/bdAstar.hpp	Initialize current to 0 in heuristic().
Graph & Base Utilities include/cpp_common/base_graph.hpp, include/lineGraph/lineGraphFull.hpp	Initialize local booleans like inserted/found in edge insertion and restore paths.
Postgres / Data Helpers include/cpp_common/get_data.hpp, src/cpp_common/get_check_data.cpp	Initialize counters and PG-related locals (e.g., total_tuples, valid_pgtuples, binval, isNull, typlen, typbyval, typalign, isnull).
Drivers & Result Variables src/chinese/chinesePostman_driver.cpp, src/max_flow/max_flow_driver.cpp, src/max_flow/minCostMaxFlow_driver.cpp, src/trsp/trspHandler.cpp	Initialize numeric result vars (minCost, max_flow, min_cost) to defined values (0 or NAN) or move/init totalCost at use-sites.
Max Flow / Matching src/max_flow/maxflow.cpp, src/max_flow/maximumcardinalitymatching.cpp, src/max_flow/minCostMaxFlow.cpp	Initialize local booleans/indices used in insertion and path algorithms (e.g., added, exists, b, j).
Graph Algorithms & Components src/coloring/edgeColoring.cpp, src/cpp_common/undirectedNoCostBG.cpp, src/components/components.cpp, src/cpp_common/compPaths.cpp	Initialize local booleans/counters/loop indices (e.g., added, num_comps, i) to defined starts.
Utilities / Assertions src/common/assert.cpp	Initialize backtrace loop index i = 0.

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~20 minutes

Poem

A rabbit nudges bits in rows,
I set each flag where cold wind blows,
Counters warmed and booleans true,
No ghosts of UB hopping through,
Build hops onward — nimble shoes 🐇

Pre-merge checks and finishing touches

❌ Failed checks (1 warning)

Check name	Status	Explanation	Resolution
Docstring Coverage	⚠️ Warning	Docstring coverage is 37.50% which is insufficient. The required threshold is 80.00%.	You can run @coderabbitai generate docstrings to improve docstring coverage.

✅ Passed checks (2 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title accurately summarizes the primary change: adding the cppcoreguidelines-init-variables check to .clang-tidy and resolving all related uninitialized variable issues across the codebase.

✨ Finishing touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment

---

📜 Recent review details

Configuration used: Repository UI

Review profile: ASSERTIVE

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 26d3b1a and 4d02360.

📒 Files selected for processing (1)

• .clang-tidy

🧰 Additional context used

🧠 Learnings (4)

📓 Common learnings

Learnt from: cvvergara
Repo: pgRouting/pgrouting PR: 3004
File: .clang-tidy:9-11
Timestamp: 2025-12-30T19:45:24.426Z
Learning: In pgRouting's .clang-tidy file (and similar list configurations), the last line of lists should not have a trailing comma, per project convention.

📚 Learning: 2025-12-30T19:45:24.426Z

Learnt from: cvvergara
Repo: pgRouting/pgrouting PR: 3004
File: .clang-tidy:9-11
Timestamp: 2025-12-30T19:45:24.426Z
Learning: In .clang-tidy files (and similar list-based configuration files), the last entry in a list should not have a trailing comma, following project convention. Enforce that lists do not end with a comma to improve diffs and consistency across configuration files.

Applied to files:

• .clang-tidy

📚 Learning: 2025-12-30T19:45:40.183Z

Learnt from: cvvergara
Repo: pgRouting/pgrouting PR: 3004
File: .clang-tidy:11-11
Timestamp: 2025-12-30T19:45:40.183Z
Learning: In any .clang-tidy configuration files, ensure that the last element of a list does not have a trailing comma, to follow the repository's coding convention. This applies to all pgRouting/.clang-tidy files across the codebase.

Applied to files:

• .clang-tidy

📚 Learning: 2025-01-19T13:17:02.243Z

Learnt from: cvvergara
Repo: pgRouting/pgrouting PR: 2723
File: tools/developer/run.sh:62-68
Timestamp: 2025-01-19T13:17:02.243Z
Learning: For pgRouting project, CMake configuration comments should be kept minimal and concise, avoiding extensive explanations of build options and configurations.

Applied to files:

• .clang-tidy

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)

• GitHub Check: Codacy Static Code Analysis

🔇 Additional comments (1)

.clang-tidy (1)

9-10: LGTM! Check properly added with correct formatting.

The cppcoreguidelines-init-variables check has been correctly added to the configuration. The comma placement follows project convention: line 9 has a trailing comma (as it's not the last item), and line 10 correctly omits the trailing comma (as the last item in the Checks list).

Based on learnings, this adheres to pgRouting's .clang-tidy formatting requirements.

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[Copilot]

Pull request overview

This PR adds the cppcoreguidelines-init-variables check to the .clang-tidy configuration file to enforce C++ Core Guidelines best practices for variable initialization. The check helps catch uninitialized variable bugs by ensuring all variables are initialized before use.

• Added cppcoreguidelines-init-variables to the list of enabled checks
• Included explanatory comment documenting the check's purpose

---

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

[coderabbitai]

Actionable comments posted: 1

📜 Review details

Configuration used: Repository UI

Review profile: ASSERTIVE

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 5d76cc6 and 075cd6e.

📒 Files selected for processing (1)

• .clang-tidy (1 hunks)

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)

• GitHub Check: Codacy Static Code Analysis

🔇 Additional comments (1)

.clang-tidy (1)

9-11: Good addition; aligns with C++ Core Guidelines.

The addition of cppcoreguidelines-init-variables checks whether there are local variables declared without an initial value, helping to catch cases where code paths might read uninitialized variables. This rule aligns with the Type safety (Type.5) profile and ES.20 from the C++ Core Guidelines. The inline comment clearly explains the purpose, and the formatting is consistent with the existing configuration.

[cvvergara]

Add only the check line, no commenta and then proceed to fix all errors generated by it.

[cvvergara]

If there are no warnings to fix, then look for another one to fix

[coderabbitai]

Actionable comments posted: 1

📜 Review details

Configuration used: Repository UI

Review profile: ASSERTIVE

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 075cd6e and b0c929d.

📒 Files selected for processing (21)

• .clang-tidy
• include/bdAstar/bdAstar.hpp
• include/contraction/contractionGraph.hpp
• include/contraction/contractionHierarchies.hpp
• include/contraction/linearContraction.hpp
• include/cpp_common/base_graph.hpp
• include/cpp_common/get_data.hpp
• include/lineGraph/lineGraphFull.hpp
• src/chinese/chinesePostman_driver.cpp
• src/coloring/edgeColoring.cpp
• src/common/assert.cpp
• src/components/components.cpp
• src/cpp_common/compPaths.cpp
• src/cpp_common/get_check_data.cpp
• src/cpp_common/undirectedNoCostBG.cpp
• src/max_flow/max_flow_driver.cpp
• src/max_flow/maxflow.cpp
• src/max_flow/maximumcardinalitymatching.cpp
• src/max_flow/minCostMaxFlow.cpp
• src/max_flow/minCostMaxFlow_driver.cpp
• src/trsp/trspHandler.cpp

🧰 Additional context used

🧠 Learnings (2)

📚 Learning: 2025-01-19T16:18:49.447Z

Learnt from: cvvergara
Repo: pgRouting/pgrouting PR: 2725
File: src/bellman_ford/bellman_ford_neg_driver.cpp:119-119
Timestamp: 2025-01-19T16:18:49.447Z
Learning: The edge count check in bellman_ford_neg_driver.cpp is part of code that is not yet in use, as of January 2025.

Applied to files:

• include/contraction/contractionHierarchies.hpp
• src/coloring/edgeColoring.cpp
• src/components/components.cpp
• include/cpp_common/base_graph.hpp
• src/max_flow/minCostMaxFlow.cpp
• src/max_flow/maximumcardinalitymatching.cpp
• src/cpp_common/undirectedNoCostBG.cpp
• include/contraction/linearContraction.hpp

📚 Learning: 2025-01-19T13:17:02.243Z

Learnt from: cvvergara
Repo: pgRouting/pgrouting PR: 2723
File: tools/developer/run.sh:62-68
Timestamp: 2025-01-19T13:17:02.243Z
Learning: For pgRouting project, CMake configuration comments should be kept minimal and concise, avoiding extensive explanations of build options and configurations.

Applied to files:

• .clang-tidy

🧬 Code graph analysis (1)

src/max_flow/maxflow.cpp (1)

include/cpp_common/path.hpp (1)

• j (132-132)

🪛 Cppcheck (2.19.0)

src/coloring/edgeColoring.cpp

[style] 87-87: The function 'pop_front' is never used.

(unusedFunction)

src/chinese/chinesePostman_driver.cpp

[style] 82-82: The function 'GetBoostVertex' is never used.

(unusedFunction)

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)

• GitHub Check: Codacy Static Code Analysis

🔇 Additional comments (35)

.clang-tidy (1)

10-10: LGTM! The check has been added correctly.

The cppcoreguidelines-init-variables check is properly added to the configuration, maintaining consistency with the existing cppcoreguidelines checks.

src/trsp/trspHandler.cpp (1)

235-235: LGTM! Appropriate initialization for a cost variable.

Initializing totalCost to NAN is correct defensive programming. The variable is assigned from get_tot_cost() before use in all code paths (lines 247 and 263), and the NAN initialization helps catch potential bugs if the variable were ever used before assignment.

src/cpp_common/undirectedNoCostBG.cpp (1)

53-53: LGTM! Standard initialization for boost::tie output parameter.

Initializing added to false is correct practice. Although boost::tie on line 55 will set the value before the check on line 56, the initialization ensures defined behavior and aligns with the cppcoreguidelines-init-variables requirement.

include/lineGraph/lineGraphFull.hpp (1)

197-197: LGTM! Proper initialization for boost::tie output parameter.

Initializing inserted to false is appropriate defensive programming. The variable serves as an output parameter for boost::tie on line 220, and the initialization ensures defined behavior.

src/max_flow/maximumcardinalitymatching.cpp (1)

81-81: LGTM! Appropriate initialization for edge existence check.

Initializing exists to false is correct. The variable is set by boost::tie on line 82 before being checked on line 83, and false is a safe default value for an existence check.

src/max_flow/minCostMaxFlow.cpp (1)

55-55: LGTM! Initialization for boost::tie output parameter.

Initializing b to false is appropriate. The variable serves as an output parameter for boost::tie on line 57, and the initialization ensures defined behavior per the cppcoreguidelines-init-variables check.

include/contraction/linearContraction.hpp (1)

111-111: LGTM! Proper initialization for edge existence flags.

Initializing found_e and found_f to false is correct. These variables are set by boost::tie on lines 117-118 and 125-126 before being checked in the directed graph case, and false is the appropriate default for existence checks.

include/cpp_common/get_data.hpp (2)

64-65: LGTM! Explicit initialization ensures defined behavior.

Initializing total_tuples and valid_pgtuples to 0 is correct. Although these variables are reassigned on line 71, the explicit initialization at declaration aligns with the cppcoreguidelines-init-variables requirement and provides clarity.

---

123-124: LGTM! Consistent initialization pattern.

Initializing total_tuples and valid_pgtuples to 0 mirrors the pattern in the first overload and ensures defined behavior. The subsequent reassignment on line 130 doesn't negate the value of explicit initialization at declaration.

src/max_flow/minCostMaxFlow_driver.cpp (1)

117-118: LGTM: Appropriate initialization for cost variable.

Initializing min_cost to NAN before assignment follows the C++ Core Guidelines and provides a clear sentinel value. The variable is immediately assigned on the next line, so there's no risk of using the uninitialized value.

src/common/assert.cpp (1)

45-45: LGTM: Explicit initialization of loop counter.

Initializing i to 0 at declaration is good defensive programming practice and aligns with the loop's starting value on line 52.

src/cpp_common/compPaths.cpp (1)

58-59: LGTM: Defensive initialization of loop counter.

Explicitly initializing i to 0 is good practice even though the for-loop on line 59 immediately reassigns it. This prevents potential undefined behavior if the code is refactored.

include/bdAstar/bdAstar.hpp (1)

159-183: LGTM: Safe default initialization for switch variable.

Initializing current to 0 ensures defined behavior and aligns with the C++ Core Guidelines. All switch cases assign current before the return statement, making this initialization defensive but harmless.

src/max_flow/maxflow.cpp (6)

77-77: LGTM: Defensive initialization for Boost output parameter.

Initializing added to false before boost::tie assignment is good defensive practice and aligns with C++ Core Guidelines.

---

112-112: LGTM: Defensive initialization for Boost output parameter.

Initializing added to false before boost::tie assignment follows the same defensive pattern as other edge insertion methods.

---

136-136: LGTM: Defensive initialization for Boost output parameter.

Consistent initialization pattern for added variable used with boost::tie.

---

164-164: LGTM: Defensive initialization in supersource setup.

Initializing added to false maintains consistency with other edge insertion helpers.

---

184-184: LGTM: Defensive initialization in supersink setup.

Consistent initialization pattern for the supersink edge insertion logic.

---

281-282: LGTM: Proper initialization of loop and output variables.

Initializing both exists and j ensures defined values before their use in the path construction logic. The variables are assigned by boost::edge (line 288) and used in the loop before being read.

src/max_flow/max_flow_driver.cpp (1)

117-130: LGTM: Safe initialization with comprehensive algorithm dispatch.

Initializing max_flow to 0 is appropriate. All valid algorithm paths (1, 2, 3) assign max_flow before it's used on line 136, and the invalid algorithm case returns an error before any use.

src/coloring/edgeColoring.cpp (1)

87-101: LGTM: Consistent initialization pattern for Boost operations.

Initializing added to false before boost::tie on line 101 follows the established pattern across the codebase and aligns with C++ Core Guidelines.

src/components/components.cpp (5)

52-56: LGTM: Safe initialization for Boost output parameter.

Initializing num_comps to 0 before boost::connected_components assignment is good defensive practice and prevents undefined behavior.

---

77-81: LGTM: Consistent initialization in strongly connected components.

Follows the same safe initialization pattern as pgr_connectedComponents.

---

111-114: LGTM: Proper initialization for biconnected components count.

Consistent defensive initialization before the biconnected_components call.

---

172-176: LGTM: Safe initialization of initial component count.

Initializing ini_comps to 0 ensures defined behavior before the boost::connected_components assignment.

---

234-238: LGTM: Defensive initialization in bridge detection logic.

Initializing now_comps to 0 in the parallel edge check follows the established pattern and ensures safe usage with boost::connected_components.

src/cpp_common/get_check_data.cpp (1)

227-228: LGTM! Variable initializations prevent undefined behavior.

The explicit initialization of local variables (binval, isNull/isnull, typlen, typbyval, typalign) aligns with the C++ Core Guidelines and prevents potential undefined behavior. These variables are assigned immediately after initialization through PostgreSQL API calls, so the defensive initialization doesn't change program behavior.

Also applies to: 277-279, 362-364, 454-456, 559-560, 592-592

include/contraction/contractionHierarchies.hpp (3)

132-132: LGTM! Boolean flags properly initialized.

Initializing found_e, found_f, and found_g to false before their use with boost::tie is good defensive programming that aligns with C++ Core Guidelines.

---

173-173: LGTM! Counter initialization ensures defined value.

Explicitly initializing n_old_edges to 0 ensures a defined value before the conditional assignment in the directed/undirected branches, preventing undefined behavior.

---

228-228: LGTM! Defensive initialization before computation.

Initializing m to 0 before the computation on lines 229-230 is good defensive practice, even though it's immediately overwritten. This prevents undefined behavior if the code is refactored in the future.

src/chinese/chinesePostman_driver.cpp (1)

82-82: LGTM! NAN is an appropriate sentinel value.

Initializing minCost to NAN is a good choice as a sentinel value. If the assignment from digraph.DirectedChPP() were to fail (though it shouldn't), the NAN value ensures that the comparison minCost >= 0.0 on line 87 evaluates to false, preventing incorrect execution of the conditional block.

include/contraction/contractionGraph.hpp (3)

185-185: LGTM! Boolean initialization before boost::tie.

Initializing inserted to false before use with boost::tie is good defensive programming.

---

398-398: LGTM! Boolean flags properly initialized.

Initializing found_e and inserted to false before their use ensures defined behavior.

Also applies to: 426-426

---

446-446: LGTM! Loop variable properly initialized.

Initializing found_f to false within the loop ensures each iteration has a defined starting state.

include/cpp_common/base_graph.hpp (1)

712-712: LGTM! Consistent boolean initialization pattern.

All boolean variables (inserted and found) are properly initialized to false before use with Boost Graph library functions like boost::tie and boost::edge. This defensive initialization aligns with C++ Core Guidelines and prevents undefined behavior while maintaining compatibility with the minimum Boost version (1.56.0).

Also applies to: 733-733, 764-764, 779-779, 796-796, 819-819

[Mohit242-bit]

I have resolved all the uninitialized variable issues and errors from cppcoreguidelines-init-variables.
Please check and review. Thank you!

[cvvergara]

Hi,
Locally things look ok
I am just waiting for all the CI tests to complete to approve and merge

[coderabbitai]

Actionable comments posted: 1

📜 Review details

Configuration used: Repository UI

Review profile: ASSERTIVE

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between ed7257b and 26d3b1a.

📒 Files selected for processing (1)

• .clang-tidy

🧰 Additional context used

🧠 Learnings (1)

📚 Learning: 2025-01-19T13:17:02.243Z

Learnt from: cvvergara
Repo: pgRouting/pgrouting PR: 2723
File: tools/developer/run.sh:62-68
Timestamp: 2025-01-19T13:17:02.243Z
Learning: For pgRouting project, CMake configuration comments should be kept minimal and concise, avoiding extensive explanations of build options and configurations.

Applied to files:

• .clang-tidy

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)

• GitHub Check: Codacy Static Code Analysis

🔇 Additional comments (1)

.clang-tidy (1)

9-10: LGTM! Check addition is correct.

The comma addition and new cppcoreguidelines-init-variables check are properly formatted and align with the PR objectives to enforce variable initialization before use.

[Mohit242-bit]

As per the instructions given in discourse i enabled the github actions for running the CI workflow ->i pushed .clang-tidy adding a blank line only so that the CI workflow will run and the output is visible in my fork repo.

[cvvergara]

Remaining task is to remove the trailing comma

This is just a note:

and also be clean on your commit messages
"as per int instructions" "as per task" what is that?

Here is a summary of commits with comments where applicable and possible rewrites

• added cppcoreguidelines-init-variables check to .clang-tidy as per task 4
  • what is task 4? pgRouting do not have a task 4
  • Added cppcoreguidelines-init-variables check to .clang-tidy
  • clang-tidy: Added cppcoreguidelines-init-variables
• clang-tidy: fixed cppcoreguideline-init-variables and all variables initialization and removed comment from clang-tidy as per instructions
  • We (on any project the people that do reviews) always give instructions, that is redundant
  • Fix warnings from cppcoreguideline-init-variables check and clang-tidy cleanup
• Fix: Remove redundant initialization of p_max in contractionGraph.hpp
• Fix: Initialize totalCost to 0.0 instead of NAN to resolve Codacy warning
• Fix: Reduce variable scope to resolve Codacy warnings (totalCost, added, found_e)
• Clean commit to Trigger CI - enabled github actions in my fork repo: blank line added in .clang-tidy
  • Its clear why you are adding that line that, but you could have created another branch and use that one to solve the
    problem you have on your fork. Aka that is a task you do on your fork not on a PR that is to be merged.

Do not worry about fixing the commit messages I will be doing a squash and will fix the commit messages
By the way you didn't need to fix codacy errors but Thanks for doing those fixes