Week 5 king and minimumdegree ordering #461

wifiBlack · 2025-06-30T15:01:27Z

Changes proposed in this pull request:

Simplified internal data structures by returning arrays of integers instead of custom composite types.
Reduced the number of output columns in ordering functions from three to two.
Removed legacy logic and internal classes specific to individual ordering algorithms.
Improved formatting and inline comments in SQL and test files.
Updated version annotations in SQL files to ensure consistency.

@pgRouting/admins

coderabbitai · 2025-06-30T15:01:34Z

Important

Review skipped

Auto reviews are disabled on base/target branches other than the default branch.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Walkthrough

This update removes the custom data structure II_t_rt and related type aliases from the codebase, replacing them with primitive int64_t types for result handling in ordering functions. The previously implemented King Ordering and Minimum Degree Ordering algorithms are deleted, and their interfaces are replaced with new function declarations that return vectors of integer vectors. The core logic in the ordering driver is simplified to only retrieve edges without applying ordering algorithms. Corresponding test and SQL files are updated for consistency, and function signatures are adjusted throughout the codebase.

Changes

Files/Paths	Change Summary
include/drivers/ordering_driver.hpp src/ordering/ordering_driver.cpp src/ordering/ordering_process.cpp include/process/ordering_process.h	Removed `II_t_rt` type; updated function signatures and result handling to use `int64_t` pointers. Removed King/MinDegree ordering logic from driver.
include/ordering/kingOrdering.hpp include/ordering/minDegreeOrdering.hpp	Deleted files implementing KingOrdering and MinDegreeOrdering class templates.
include/ordering/ordering.hpp	Added new header declaring `kingOrdering` and `minDegreeOrdering` template functions returning `std::vector<std::vector<int64_t>>`.
src/ordering/kingOrdering.c src/ordering/minDegreeOrdering.c	Removed `II_t_rt` usage; simplified result tuple handling to use `int64_t`; reduced output columns from 3 to 2.
pgtap/ordering/kingOrdering/types_check.pg pgtap/ordering/minDegreeOrdering/types_check.pg	Simplified `RETURN QUERY` syntax; adjusted argument array formatting in function signature checks.
sql/ordering/kingOrdering.sql sql/ordering/minDegreeOrdering.sql sql/ordering/_minDegreeOrdering.sql	Updated version annotation comments from `--v4.0.0` to `--v4.0`.

Sequence Diagram(s)

sequenceDiagram
    participant SQL_Client
    participant C_Function
    participant Ordering_Driver
    participant Edge_Retriever

    SQL_Client->>C_Function: Call ordering function (e.g., pgr_kingOrdering)
    C_Function->>Ordering_Driver: do_ordering(edges_sql, which, int64_t**, ...)
    Ordering_Driver->>Edge_Retriever: get_edges(edges_sql)
    Edge_Retriever-->>Ordering_Driver: Edges as int64_t
    Ordering_Driver-->>C_Function: int64_t* result_tuples
    C_Function-->>SQL_Client: Result rows (2 columns)

Poem

A bunny hopped through code so neat,
Replacing structs with numbers sweet.
Old orderings now hop away,
Simpler types come out to play.
Fewer columns, lighter load,
A tidier, more direct road!
🐇✨

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

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

Review comments: Directly reply to a review comment made by CodeRabbit. Example:
- I pushed a fix in commit <commit_id>, please review it.
- Explain this complex logic.
- Open a follow-up GitHub issue for this discussion.
Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
- @coderabbitai explain this code block.
- @coderabbitai modularize this function.
PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
- @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
- @coderabbitai read src/utils.ts and explain its main purpose.
- @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
- @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

@coderabbitai pause to pause the reviews on a PR.
@coderabbitai resume to resume the paused reviews.
@coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
@coderabbitai full review to do a full review from scratch and review all the files again.
@coderabbitai summary to regenerate the summary of the PR.
@coderabbitai generate docstrings to generate docstrings for this PR.
@coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
@coderabbitai resolve resolve all the CodeRabbit review comments.
@coderabbitai configuration to show the current CodeRabbit configuration for the repository.
@coderabbitai help to get help.

Other keywords and placeholders

Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (`.coderabbit.yaml`)

You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
Please see the configuration documentation for more information.
If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

Visit our Documentation for detailed information on how to use CodeRabbit.
Join our Discord Community to get help, request features, and share feedback.
Follow us on X/Twitter for updates and announcements.

cvvergara · 2025-06-30T18:03:22Z

TODO

Please be less fancy, remove useless comments like this one
None of this goes here
Instead of II_r_t type use int64_t here
- Fix all consequences of that small change
  - Hint: easier to do with a one liner perl command to substitute perl -pi -e 's/fromwhat/towhat/' file
Remove the includes of the type for example: here

…ingOrdering

…ove unused code

…ix all consequences of that small change

…rectedGraph

…cludes

wifiBlack · 2025-07-04T04:51:00Z

@coderabbitai summary

coderabbitai · 2025-07-04T04:51:05Z

✅ Actions performed

Summary regeneration triggered.

cvvergara · 2025-07-04T16:40:20Z

to fix this problem do:

tools/release-scripts/get_signatures.sh

Commit the file change and push

Just to start week 5 PR

e49ab3d

wifi:) added 5 commits July 3, 2025 00:24

Refactor types_check function to streamline return queries

f806593

Refactor types_check function to improve readability of return queries

c4f450a

Remove unnecessary preprocessor directives

8fbe8c1

Update versioning in function definitions for minDegreeOrdering and k…

dee6037

…ingOrdering

Remove useless comment

73f1771

wifiBlack added this to the 2025 First period milestone Jul 2, 2025

wifiBlack added the wifi-2025 Done by Fan Wu label Jul 2, 2025

wifiBlack self-assigned this Jul 2, 2025

wifi:) added 8 commits July 3, 2025 10:56

(ordering_driver) Duplicate unused code

23876b8

Fix the num variable

6d0bd28

Remove unused comment

7e65bba

Replace kingOrdering.hpp & minDegreeOrdering.hpp with ordering.hpp

9a9bad3

Refactor ordering_driver.cpp to consolidate ordering includes and rem…

d250622

…ove unused code

Update data types from II_t_rt to int64_t in ordering functions and f…

ab5e1f9

…ix all consequences of that small change

Remove unused ii_t_rt.h includes from ordering files

f61229c

Refactor do_ordering function to simplify usage of get_edges and Undi…

7d36f36

…rectedGraph

wifiBlack requested review from sanak, robe2, cvvergara and iosefa July 3, 2025 06:18

Clean up code by removing unnecessary whitespace and consolidating in…

06c5bea

…cludes

Delete the unused file

74a7f25

Add signatures for king ordering and minimum degree ordering

e5cb8dd

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

Week 5 king and minimumdegree ordering #461

Week 5 king and minimumdegree ordering #461

wifiBlack commented Jun 30, 2025 •

edited

Loading

Uh oh!

coderabbitai bot commented Jun 30, 2025 •

edited

Loading

Review skipped

Chat

Support

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

Uh oh!

cvvergara commented Jun 30, 2025 •

edited by wifiBlack

Loading

Uh oh!

wifiBlack commented Jul 4, 2025

Uh oh!

coderabbitai bot commented Jul 4, 2025

Uh oh!

cvvergara commented Jul 4, 2025

Uh oh!

Uh oh!

Uh oh!

Week 5 king and minimumdegree ordering #461

Are you sure you want to change the base?

Week 5 king and minimumdegree ordering #461

Conversation

wifiBlack commented Jun 30, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

coderabbitai bot commented Jun 30, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Review skipped

Walkthrough

Changes

Sequence Diagram(s)

Poem

Chat

Support

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

Uh oh!

cvvergara commented Jun 30, 2025 • edited by wifiBlack Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

wifiBlack commented Jul 4, 2025

Uh oh!

coderabbitai bot commented Jul 4, 2025

Uh oh!

cvvergara commented Jul 4, 2025

Uh oh!

Uh oh!

wifiBlack commented Jun 30, 2025 •

edited

Loading

coderabbitai bot commented Jun 30, 2025 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)

cvvergara commented Jun 30, 2025 •

edited by wifiBlack

Loading