Week 6 sloan ordering

[bipashabg]

Fixes # .

Changes proposed in this pull request:

• Write boost function call for sloan ordering in sloanOrdering.hpp file
• Add result file for initial docqueries testing.
• Mark unneeded code.
• Resolve subsequent compilation errors.

@pgRouting/admins

[coderabbitai]

Caution

Review failed

The pull request is closed.

Walkthrough

This change refines the Sloan ordering feature by filtering the input graph edges in the SQL query, updating the C++ implementation to simplify the function interface, adjusting related test and configuration files, and ensuring the function always returns at least one result. Minor code and documentation cleanups are also included.

Changes

Cohort / File(s)	Change Summary
SQL Query Filtering and Test Update docqueries/ordering/sloanOrdering.pg, docqueries/ordering/sloanOrdering.result	The SQL query for pgr_sloanOrdering now filters edges with id < 2. The result script is updated to reflect this change and includes transaction control statements.
Test Configuration docqueries/ordering/test.conf	Adds a duplicate entry of sloanOrdering.pg to the test file list under the 'any' key.
C++ Implementation Refactor include/ordering/sloanOrdering.hpp	Renames the header, updates includes, simplifies the main function interface to return a flat vector, removes unused code, and updates the ordering logic.
Ordering Driver Update src/ordering/ordering_driver.cpp	Removes checks for the presence of start/end vertices, updates the include to use the new header, and retains the main logic.
Result Handling Fix src/ordering/sloanOrdering.c	Ensures at least one result is returned by allocating a default value if the result set is empty.
SQL Formatting sql/ordering/sloanOrdering.sql	Removes an extra blank line before the version comment.

Sequence Diagram(s)

sequenceDiagram
    participant SQL as SQL Client
    participant PG as pgr_sloanOrdering (C)
    participant CPP as sloanOrdering (C++)
    participant DB as Database

    SQL->>DB: SELECT id, source, target, cost, reverse_cost FROM edges WHERE id < 2
    SQL->>PG: CALL pgr_sloanOrdering(filtered_edges)
    PG->>CPP: sloanOrdering(graph)
    CPP-->>PG: vector<int64_t> result
    PG-->>SQL: Return result (ensure at least one row)

Loading

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~15 minutes

Possibly related PRs

• pgRouting/GSoC-pgRouting#460: Directly related as both PRs modify and refactor the pgr_sloanOrdering function and its associated implementation and documentation.

Suggested reviewers

• sanak
• cvvergara
• robe2

Poem

A bunny hopped through code so neat,
Filtering edges for a streamlined feat.
With Sloan’s path now clear and bright,
Results return, no empty fright!
Headers renamed, tests in tow—
This rabbit’s work is set to go!
🐇✨

Note

⚡️ Unit Test Generation is now available in beta!

Learn more here, or try it out under "Finishing Touches" below.

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 8d19133 and dba0a26.

📒 Files selected for processing (7)

• docqueries/ordering/sloanOrdering.pg (1 hunks)
• docqueries/ordering/sloanOrdering.result (1 hunks)
• docqueries/ordering/test.conf (1 hunks)
• include/ordering/sloanOrdering.hpp (2 hunks)
• sql/ordering/sloanOrdering.sql (0 hunks)
• src/ordering/ordering_driver.cpp (1 hunks)
• src/ordering/sloanOrdering.c (1 hunks)

✨ Finishing Touches

• 📝 Generate Docstrings

🧪 Generate unit tests

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

---

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

🪧 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 generate unit tests to generate unit tests for 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.

[bipashabg]

@CodeRabbit summary

[coderabbitai]

✅ Actions performed

Summary regeneration triggered.