enhancements on dijkstra

[cvvergara]

Changes proposed in this pull request:
Code enhancements on:

• (C/C++,Via functions) Removing prefix pgr_
• (C/C++) dijkstra: simplification of code
• (C/C++, combinations) Removing unused code
• (SQL) Removing unused functions
• (doc) documentation of the changes

@pgRouting/admins

Summary by CodeRabbit

Release Notes for pgRouting 4.0.0

• Code Enhancements

  • Simplified and streamlined internal C/C++ code for Dijkstra's algorithm
  • Removed deprecated functions and signatures

• Deprecated Functions

  • Removed several SQL functions including:
    • pgr_trspviaedges
    • pgr_trspviavertices
    • Multiple overloads of pgr_trsp and pgr_dijkstra

• Internal Changes

  • Renamed internal functions (e.g., pgr_dijkstraVia → dijkstraVia)
  • Marked certain internal C/C++ functions as legacy
  • Updated function signatures to improve clarity and functionality

• Compatibility

  • Significant restructuring of routing function signatures
  • Removal of older, less efficient implementations

[coderabbitai]

Caution

Review failed

The pull request is closed.

Walkthrough

This pull request introduces significant changes to the pgRouting project, focusing on version 4.0.0 release preparations. The modifications primarily involve removing deprecated functions, renaming internal functions, and updating function signatures across multiple components. Key changes include simplifying C/C++ code, removing legacy implementations, and restructuring the Dijkstra algorithm's implementation. The changes span SQL, C++, and documentation files, indicating a comprehensive update to the project's codebase.

Changes

File/Path	Change Summary
NEWS.md, doc/src/release_notes.rst	Added sections on code enhancements, deprecated functions, and legacy functions
include/cpp_common/combinations.hpp	Removed two get_combinations function overloads
include/dijkstra/dijkstraVia.hpp	Renamed pgr_dijkstraVia to dijkstraVia
sql/dijkstra/*	Replaced _pgr_dijkstra calls with _pgr_dijkstrav4, updated function signatures
src/dijkstra/dijkstra.c	Added _pgr_dijkstrav4 function
Multiple driver files	Replaced pgr_dijkstraVia calls with dijkstraVia

Sequence Diagram

sequenceDiagram
    participant Client
    participant SQL Function
    participant Internal Function
    participant Dijkstra Algorithm

    Client->>SQL Function: Call pgr_dijkstra
    SQL Function->>Internal Function: _pgr_dijkstrav4
    Internal Function->>Dijkstra Algorithm: Process pathfinding
    Dijkstra Algorithm-->>Internal Function: Return path results
    Internal Function-->>SQL Function: Return processed results
    SQL Function-->>Client: Return path details

Loading

Possibly related PRs

• Promotion of functions to official #2721: Promotion of functions and signatures to official status
• (C++/performance) Removing passing c_str() to a function that takes s… #2725: Performance improvements by removing unnecessary conversions

Suggested labels

documentation, refactoring, api-changes

Suggested reviewers

• robe2

Poem

🐰 Hop, hop, through code's winding way,
Deprecated paths now fade away!
Dijkstra's dance, a cleaner stride,
Version 4 takes routing's ride!
Refactored routes, now swift and bright! 🚀

---

📜 Recent review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 28cd1f6 and 964916c.

📒 Files selected for processing (19)

• NEWS.md (1 hunks)
• doc/src/release_notes.rst (1 hunks)
• include/cpp_common/combinations.hpp (0 hunks)
• include/dijkstra/dijkstraVia.hpp (1 hunks)
• sql/dijkstra/CMakeLists.txt (0 hunks)
• sql/dijkstra/_dijkstra.sql (2 hunks)
• sql/dijkstra/_dijkstraNear.sql (0 hunks)
• sql/dijkstra/dijkstra.sql (5 hunks)
• sql/dijkstra/dijkstraCost.sql (5 hunks)
• sql/dijkstra/dijkstraCostMatrix.sql (1 hunks)
• sql/dijkstra/dijkstraNear.sql (4 hunks)
• sql/dijkstra/dijkstraNearCost.sql (4 hunks)
• sql/sigs/pgrouting--4.0.sig (1 hunks)
• src/cpp_common/combinations.cpp (0 hunks)
• src/dijkstra/dijkstra.c (2 hunks)
• src/dijkstra/dijkstraVia_driver.cpp (2 hunks)
• src/trsp/trspVia_driver.cpp (2 hunks)
• src/trsp/trspVia_withPoints_driver.cpp (2 hunks)
• src/withPoints/withPointsVia_driver.cpp (2 hunks)

✨ Finishing Touches

• 📝 Generate Docstrings (Beta)

---

🪧 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.
  • Generate unit testing code for this file.
  • 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 generate unit testing code for this file.
  • @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 generate unit testing code.
  • @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.

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. (Beta)
• @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]

@coderabbitai review

[coderabbitai]

✅ Actions performed

Review triggered.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.