Skip to content

Add comprehensive documentation for metaheuristic algorithm components#324

Draft
Copilot wants to merge 7 commits into
masterfrom
copilot/add-documentation-skeleton-pages
Draft

Add comprehensive documentation for metaheuristic algorithm components#324
Copilot wants to merge 7 commits into
masterfrom
copilot/add-documentation-skeleton-pages

Conversation

Copy link
Copy Markdown
Contributor

Copilot AI commented Feb 12, 2026

Issue #251 identified that implemented metaheuristics (GRASP, Simulated Annealing, VNS, etc.) were undocumented, leaving users unaware of available optimization methods.

Documentation Added

Summary page (components.md) cataloging all algorithm components with integration diagram and usage patterns.

Metaheuristics (6 pages)

  • Simulated Annealing, Iterated Greedy, Scatter Search, Multi-Start, VND, VNS

Constructors (5 pages)

  • Base Constructive, GRASP variants (standard, GreedyRandom, RandomGreedy), Reconstructive

Improvers (4 pages)

  • Base Improver, Local Search, Best/First Improvement strategies

Shake/Perturbation (4 pages)

  • Base Shake, Random Move, Destructive, Destroy-Rebuild

Page Structure

Each page includes:

  • Algorithm outline with pseudo-code
  • Mermaid flow diagrams
  • Implementation examples
  • Comparison tables (where applicable)
  • Related Java class references
  • Problem-specific use cases (TSP, VRP, scheduling)
  • Performance characteristics

Example

// Multi-Start with GRASP construction
var grasp = new MultiStartAlgorithm<>(
    "GRASP",
    new GRASPConstructive<>(0.3),  // alpha = 0.3
    new BestImprovementLS<>(),
    100  // iterations
);

// VNS with multiple neighborhoods
var vns = new VNSBuilder<MySolution, MyInstance>()
    .withConstructive(constructor)
    .withImprover(new VND<>(List.of(swap, insert, twoOpt)))
    .withShake(new DestroyRebuild<>(destructor, reconstructor))
    .withNeighChange(5)
    .build("VNS");

Navigation

Added .pages files organizing documentation into: Metaheuristics → Constructors → Improvers → Shakes hierarchy.

Documentation builds cleanly with mkdocs build. API doc links point to javadoc paths (generated separately).

Warning

Firewall rules blocked me from connecting to one or more addresses (expand for details)

I tried to connect to the following addresses, but was blocked by firewall rules:

  • unpkg.com
    • Triggering command: /home/REDACTED/.local/bin/mkdocs mkdocs build (dns block)

If you need me to access, download, or install something from one of these locations, you can either:


💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.

Copilot AI and others added 6 commits February 12, 2026 15:53
Co-authored-by: rmartinsanta <55482385+rmartinsanta@users.noreply.github.com>
…-Start, VND)

Co-authored-by: rmartinsanta <55482385+rmartinsanta@users.noreply.github.com>
…constructive)

Co-authored-by: rmartinsanta <55482385+rmartinsanta@users.noreply.github.com>
…irst Improvement)

Co-authored-by: rmartinsanta <55482385+rmartinsanta@users.noreply.github.com>
…Destroy-Rebuild, Random Move)

Co-authored-by: rmartinsanta <55482385+rmartinsanta@users.noreply.github.com>
Co-authored-by: rmartinsanta <55482385+rmartinsanta@users.noreply.github.com>
Copilot AI changed the title [WIP] Add skeleton documentation for algorithms and metaheuristics Add comprehensive documentation for metaheuristic algorithm components Feb 12, 2026
Copilot AI requested a review from rmartinsanta February 12, 2026 16:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants