Week 5 sloan ordering #460

bipashabg · 2025-06-30T12:41:21Z

Fixes # .

Changes proposed in this pull request:

TBD

@pgRouting/admins

Summary by CodeRabbit

Documentation
- Updated documentation to remove references to the pgr_sloanOrdering function and align function signature comments with the actual implementation.
- Added a new SQL query example for pgr_sloanOrdering in the documentation.
Bug Fixes
- Corrected function signature comments to accurately reflect the current parameter list.
Refactor
- Simplified internal data structures and function signatures for ordering-related functions, improving consistency and maintainability.
Tests
- Updated and expanded test cases for pgr_sloanOrdering to ensure broader version coverage and accuracy.
Chores
- Adjusted build configuration files to include new and updated source and documentation files.

coderabbitai · 2025-06-30T12:41:27Z

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

References to the pgr_sloanOrdering function were removed from the ordering family documentation. The build and test system was updated to include a new example and test for sloanOrdering. Several C++ and C headers and source files were refactored to simplify function signatures and data structures, primarily replacing custom tuple types with int64_t arrays and updating related function interfaces.

Changes

File(s)	Change Summary
doc/ordering/ordering-family.rst	Removed all documentation references to `pgr_sloanOrdering`.
docqueries/ordering/CMakeLists.txt, docqueries/ordering/sloanOrdering.pg, docqueries/ordering/test.conf	Added `sloanOrdering` example and test to documentation build and test configuration.
include/drivers/ordering_driver.hpp, include/process/ordering_process.h, src/ordering/ordering_driver.cpp, src/ordering/ordering_process.cpp	Refactored function signatures and parameter types, replacing custom tuple types with `int64_t` arrays.
include/ordering/sloanOrdering.hpp	Minor formatting and include adjustments; no logic changes.
pgtap/ordering/sloan/types_check.pg	Updated test plan logic and array argument formatting.
sql/ordering/_sloanOrdering.sql, sql/ordering/sloanOrdering.sql	Removed extra whitespace and corrected function signature in comments.
src/ordering/CMakeLists.txt	Added `ordering_process.cpp` to build sources.
src/ordering/sloanOrdering.c	Simplified result tuple logic and removed unused helper and type includes.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant SQL_Function (pgr_sloanOrdering)
    participant C_Layer (_pgr_sloanordering)
    participant Ordering_Process (pgr_process_ordering)
    participant Ordering_Driver (do_ordering)
    participant Result

    User->>SQL_Function: CALL pgr_sloanOrdering(edges_sql)
    SQL_Function->>C_Layer: _pgr_sloanordering(PG_FUNCTION_ARGS)
    C_Layer->>Ordering_Process: pgr_process_ordering(edges_sql, which, int64_t **, size_t *)
    Ordering_Process->>Ordering_Driver: do_ordering(edges_sql, which, int64_t **, size_t *, ...)
    Ordering_Driver-->>Ordering_Process: result_tuples (int64_t array)
    Ordering_Process-->>C_Layer: result_tuples, result_count
    C_Layer-->>SQL_Function: Construct tuples from int64_t array
    SQL_Function-->>User: Return result set

Poem

A hop, a skip, a code refactor,
Sloan hops out, the docs grow neater.
Arrays of numbers, tuples trimmed,
The build and tests now freshly primmed.
With every change, the code grows light—
Let’s order graphs from left to right!

((\
( -.-)
o_(")(")

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-30T17:26:59Z

@bipashabg
It was my fault the server crash, forgot to : hint = "" further down in the driver code (had hint = nullptr).

Please write in a comment all the tasks/commits I made during the meeting, I suppose that at least you took notes, a screenshot or something so that you don't forget what to do. I just want to make sure that you do not forget.

Here are some additional TODO:

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

bipashabg · 2025-06-30T17:46:51Z

…ent files

bipashabg · 2025-07-04T14:56:25Z

@coderabbitai summary

coderabbitai · 2025-07-04T14:56:31Z

✅ Actions performed

Summary regeneration triggered.

cvvergara · 2025-07-04T16:34:32Z

src/ordering/ordering_driver.cpp

-void 
-pgr_do_ordering(
+void
+do_ordering(


you get this kind of error:

ERROR: could not load library "/usr/lib/postgresql/16/lib/libpgrouting-4.0.so": /usr/lib/postgresql/16/lib/libpgrouting-4.0.so: undefined symbol: _Z11do_orderingPKciPlPmPPcS4_S4_

Because the implementation does not match the definition.

https://github.com/pgRouting/GSoC-pgRouting/pull/460/files#diff-c78780c857dc6a395eed58eab37e1edbee777cbc83eca43be4e3e57971ff36ae

cvvergara · 2025-07-04T16:35:11Z

include/drivers/ordering_driver.hpp

 #include <string>


 void
 do_ordering(
-        std::string, int64_t, int64_t,
+        const char*, int,


I dont understand why in 100% C++ code you want to use C arrays?

to start week 5

6b73b7e

add ordering_process.cpp file to CMakeLists.txt

dc71f2e

bipashabg added 23 commits July 1, 2025 18:14

fix include file in ordering_process.cpp

382a22f

fix comment in ordering_process.cpp

938072b

removed unused code

65e017b

fixing parameter int in ordering_driver.hpp

a6ca75f

fixing parameter in ordering_process.h

dd5cd18

fix type of hint

c8aa1b2

fix input parameters in sql file

962dd52

fix types_check.pg file

fb58002

rename ordering.hpp file to sloanOrdering.hpp

d383433

adjust return queries in types_check.pg

d67d4e0

new file sloanOrdering.pg in docqueries/ordering

ac5fd8a

add sloanOrdering to CMakeLists.txt

5914d37

created the initial files of the documentation queries

9c8f35b

modify ordering-family.rst to previous version for now

5ba6e9d

replace tab with whitespaces in sloanOrdering.c

d7b6da8

update size_t num to 2

7fba8e5

change type ii_t_rt to int64_t

1038c3e

update the type ii_t_rt to int64_t and remove the includes in subsequ…

00dffe9

…ent files

fix style_check errors in some files

0f9177c

fix parameters to resolve compilation error

d94905a

resolve more style_check errors

58d4cff

remove whitespaces and clean code

8d22d70

fix ordering of header files

5e95cab

cvvergara reviewed Jul 4, 2025

View reviewed changes

bipashabg added 3 commits July 4, 2025 23:27

update datatype to use string

51041f4

fix minor issue while compiling

80413c1

add signature for sloan ordering

dceb5f6

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

Week 5 sloan ordering #460

Week 5 sloan ordering #460

Uh oh!

bipashabg 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 bipashabg

Loading

Uh oh!

bipashabg commented Jun 30, 2025 •

edited

Loading

Uh oh!

bipashabg commented Jul 4, 2025

Uh oh!

coderabbitai bot commented Jul 4, 2025

Uh oh!

cvvergara Jul 4, 2025

Uh oh!

cvvergara Jul 4, 2025

Uh oh!

Uh oh!

Uh oh!

Week 5 sloan ordering #460

Are you sure you want to change the base?

Week 5 sloan ordering #460

Uh oh!

Conversation

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

Uh oh!

Changes proposed in this pull request:

Summary by CodeRabbit

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 bipashabg Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

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

Uh oh!

Uh oh!

bipashabg commented Jul 4, 2025

Uh oh!

coderabbitai bot commented Jul 4, 2025

Uh oh!

cvvergara Jul 4, 2025

Choose a reason for hiding this comment

Uh oh!

cvvergara Jul 4, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

bipashabg 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 bipashabg

Loading

bipashabg commented Jun 30, 2025 •

edited

Loading