Move pgr_topologicalSort to ordering #3023

cvvergara · 2026-01-05T17:27:00Z

This is a reorganization PR

pgr_topologicalSort is about ordering

src, include and sql are moved to ordering directory
- Build in ordering directory is adjusted
docqqueries, doc and pgtap are already in the correct directory
Code is adjusted to new include file locations
define guards are adjusted to new locations
- including a fix for path.hpp

No need to document, its just moving code around

@pgRouting/admins

Summary by CodeRabbit

Refactor
- Reorganized topological sort components under a unified module structure for improved codebase organization and maintainability.

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

- Deleting unused CMakeLists

coderabbitai · 2026-01-05T17:27:12Z

Walkthrough

The changes reorganize the topologicalSort feature from a standalone module into the ordering module, including moving source files, headers, and SQL scripts while updating include paths and build configurations to reflect the new directory structure.

Changes

Cohort / File(s)	Summary
Configuration Removal `configuration.conf`	Removed topologicalSort entry declaring C/C++, SQL, and documentation support.
Header Guard Renames `include/cpp_common/path.hpp`, `include/drivers/ordering/topologicalSort_driver.h`, `include/ordering/topologicalSort.hpp`	Updated include guards to reflect new module paths: BASEPATH_SSEC → PATH, TOPOLOGICALSORT_TOPOLOGICALSORT → ORDERING_TOPOLOGICALSORT, and TOPOLOGICALSORT_TOPOLOGICALSORT → ORDERING_TOPOLOGICALSORT.
Build Reorganization `src/ordering/CMakeLists.txt`, `src/topologicalSort/CMakeLists.txt`	Moved topologicalSort.c and topologicalSort_driver.cpp from standalone topologicalSort target into ordering OBJECT library; removed former target definition.
SQL File Relocation `sql/ordering/CMakeLists.txt`, `sql/topologicalSort/CMakeLists.txt`	Migrated _topologicalSort.sql and topologicalSort.sql from standalone sql/topologicalSort to sql/ordering directory; removed legacy build steps.
Include Path Updates `src/ordering/topologicalSort.c`, `src/ordering/topologicalSort_driver.cpp`	Updated include directives to reference relocated headers: drivers/ordering/topologicalSort_driver.h and ordering/topologicalSort.hpp.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~15 minutes

Suggested reviewers

robe2
iosefa

Poem

🐰 A hop and a skip through the folder tree,
Topological sorts now organized, you see!
From scattered subdirs to ordering's home,
Our features consolidated—no more to roam!
✨ whisker-twitch of satisfaction ✨

Pre-merge checks and finishing touches

❌ Failed checks (1 warning)

Check name	Status	Explanation	Resolution
Docstring Coverage	⚠️ Warning	Docstring coverage is 0.00% 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 'Move pgr_topologicalSort to ordering' accurately and concisely describes the main objective of the pull request—a repository reorganization that relocates the topologicalSort implementation from a standalone directory to an ordering subdirectory.

✨ Finishing touches

📝 Generate docstrings

🧪 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 7b7c422 and 4f8745d.

📒 Files selected for processing (12)

configuration.conf
include/cpp_common/path.hpp
include/drivers/ordering/topologicalSort_driver.h
include/ordering/topologicalSort.hpp
sql/ordering/CMakeLists.txt
sql/ordering/_topologicalSort.sql
sql/ordering/topologicalSort.sql
sql/topologicalSort/CMakeLists.txt
src/ordering/CMakeLists.txt
src/ordering/topologicalSort.c
src/ordering/topologicalSort_driver.cpp
src/topologicalSort/CMakeLists.txt

💤 Files with no reviewable changes (3)

sql/topologicalSort/CMakeLists.txt
src/topologicalSort/CMakeLists.txt
configuration.conf

🧰 Additional context used

🧠 Learnings (6)

📓 Common learnings

Learnt from: cvvergara
Repo: pgRouting/pgrouting PR: 2771
File: doc/topology/pgr_extractVertices.rst:28-35
Timestamp: 2025-02-27T23:09:12.162Z
Learning: In pgRouting documentation, historical version entries should be maintained in reverse chronological order (newest first) to provide context about the evolution of functions over time.

📚 Learning: 2025-04-24T23:29:43.790Z

Learnt from: cvvergara
Repo: pgRouting/pgrouting PR: 2868
File: tools/testers/contractionHierarchies_data.sql:73-85
Timestamp: 2025-04-24T23:29:43.790Z
Learning: Test data for pgRouting algorithms like contraction hierarchies doesn't necessarily need to follow all production best practices such as setting explicit SRIDs on geometries, especially when the algorithm primarily works with graph topology rather than geographic properties.

Applied to files:

include/cpp_common/path.hpp

📚 Learning: 2025-04-25T00:59:52.580Z

Learnt from: cvvergara
Repo: pgRouting/pgrouting PR: 2868
File: src/contraction/contractionHierarchies_driver.cpp:47-56
Timestamp: 2025-04-25T00:59:52.580Z
Learning: In pgRouting, driver functions like `pgr_contractionHierarchies` assume that callers within the project will pass valid non-null pointers, as these functions are only used internally with well-defined call patterns. Null checks on the pointers themselves (as opposed to their dereferenced values) are considered unnecessary since the caller is guaranteed to pass references to variables.

Applied to files:

include/cpp_common/path.hpp

📚 Learning: 2025-04-25T02:12:17.271Z

Learnt from: cvvergara
Repo: pgRouting/pgrouting PR: 2871
File: include/drivers/transitiveClosure/transitiveClosure_driver.h:45-49
Timestamp: 2025-04-25T02:12:17.271Z
Learning: The pgRouting project avoids using named parameters in C header files to prevent conflicts with Doxygen documentation.

Applied to files:

include/cpp_common/path.hpp

📚 Learning: 2025-02-27T16:33:56.959Z

Learnt from: cvvergara
Repo: pgRouting/pgrouting PR: 2764
File: sql/sigs/pgrouting--3.8.sig:125-136
Timestamp: 2025-02-27T16:33:56.959Z
Learning: The file sql/sigs/pgrouting--*.sig is automatically generated by a command and cannot be manually modified. Comments about naming conventions or other improvements should be directed at the source code that generates these signatures, not at the signature file itself.

Applied to files:

include/cpp_common/path.hpp

📚 Learning: 2025-02-27T16:34:57.518Z

Learnt from: cvvergara
Repo: pgRouting/pgrouting PR: 2764
File: sql/sigs/pgrouting--3.8.sig:274-275
Timestamp: 2025-02-27T16:34:57.518Z
Learning: The file `sql/sigs/pgrouting--3.8.sig` is auto-generated by a command and should not be modified manually.

Applied to files:

sql/ordering/CMakeLists.txt

🪛 Cppcheck (2.19.0)

src/ordering/topologicalSort.c