Skip to content

Commit

Permalink
Updating docs
Browse files Browse the repository at this point in the history
  • Loading branch information
jkhamphousone committed Jul 18, 2024
1 parent 59a2103 commit aeca99a
Show file tree
Hide file tree
Showing 7 changed files with 64 additions and 5 deletions.
2 changes: 1 addition & 1 deletion docs/build/.documenter-siteinfo.json
Original file line number Diff line number Diff line change
@@ -1 +1 @@
{"documenter":{"julia_version":"1.10.4","generation_timestamp":"2024-07-17T15:39:34","documenter_version":"1.5.0"}}
{"documenter":{"julia_version":"1.10.4","generation_timestamp":"2024-07-18T08:37:02","documenter_version":"1.5.0"}}
2 changes: 1 addition & 1 deletion docs/build/index.html
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
<!DOCTYPE html>
<html lang="en"><head><meta charset="UTF-8"/><meta name="viewport" content="width=device-width, initial-scale=1.0"/><title>- · RingStarProblems Documentattion</title><meta name="title" content="- · RingStarProblems Documentattion"/><meta property="og:title" content="- · RingStarProblems Documentattion"/><meta property="twitter:title" content="- · RingStarProblems Documentattion"/><meta name="description" content="Documentation for RingStarProblems Documentattion."/><meta property="og:description" content="Documentation for RingStarProblems Documentattion."/><meta property="twitter:description" content="Documentation for RingStarProblems Documentattion."/><script data-outdated-warner src="assets/warner.js"></script><link href="https://cdnjs.cloudflare.com/ajax/libs/lato-font/3.0.0/css/lato-font.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/juliamono/0.050/juliamono.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/fontawesome.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/solid.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/brands.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.16.8/katex.min.css" rel="stylesheet" type="text/css"/><script>documenterBaseURL="."</script><script src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.6/require.min.js" data-main="assets/documenter.js"></script><script src="search_index.js"></script><script src="siteinfo.js"></script><script src="../versions.js"></script><link class="docs-theme-link" rel="stylesheet" type="text/css" href="assets/themes/catppuccin-mocha.css" data-theme-name="catppuccin-mocha"/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="assets/themes/catppuccin-macchiato.css" data-theme-name="catppuccin-macchiato"/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="assets/themes/catppuccin-frappe.css" data-theme-name="catppuccin-frappe"/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="assets/themes/catppuccin-latte.css" data-theme-name="catppuccin-latte"/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="assets/themes/documenter-dark.css" data-theme-name="documenter-dark" data-theme-primary-dark/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="assets/themes/documenter-light.css" data-theme-name="documenter-light" data-theme-primary/><script src="assets/themeswap.js"></script></head><body><div id="documenter"><nav class="docs-sidebar"><div class="docs-package-name"><span class="docs-autofit"><a href>RingStarProblems Documentattion</a></span></div><button class="docs-search-query input is-rounded is-small is-clickable my-2 mx-auto py-1 px-2" id="documenter-search-query">Search docs (Ctrl + /)</button><ul class="docs-menu"><li class="is-active"><a class="tocitem" href>-</a></li></ul><div class="docs-version-selector field has-addons"><div class="control"><span class="docs-label button is-static is-size-7">Version</span></div><div class="docs-selector control is-expanded"><div class="select is-fullwidth is-size-7"><select id="documenter-version-selector"></select></div></div></div></nav><div class="docs-main"><header class="docs-navbar"><a class="docs-sidebar-button docs-navbar-link fa-solid fa-bars is-hidden-desktop" id="documenter-sidebar-button" href="#"></a><nav class="breadcrumb"><ul class="is-hidden-mobile"><li class="is-active"><a href>-</a></li></ul><ul class="is-hidden-tablet"><li class="is-active"><a href>-</a></li></ul></nav><div class="docs-right"><a class="docs-navbar-link" href="https://github.com/jkhamphousone/RingStarProblems.jl" title="View the repository on GitHub"><span class="docs-icon fa-brands"></span><span class="docs-label is-hidden-touch">GitHub</span></a><a class="docs-navbar-link" href="https://github.com/jkhamphousone/RingStarProblems.jl/blob/main/docs/src/index.md" title="Edit source on GitHub"><span class="docs-icon fa-solid"></span></a><a class="docs-settings-button docs-navbar-link fa-solid fa-gear" id="documenter-settings-button" href="#" title="Settings"></a><a class="docs-article-toggle-button fa-solid fa-chevron-up" id="documenter-article-toggle-button" href="javascript:;" title="Collapse all docstrings"></a></div></header><article class="content" id="documenter-page"></article><nav class="docs-footer"><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="auto">Automatic (OS)</option><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option><option value="catppuccin-latte">catppuccin-latte</option><option value="catppuccin-frappe">catppuccin-frappe</option><option value="catppuccin-macchiato">catppuccin-macchiato</option><option value="catppuccin-mocha">catppuccin-mocha</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.5.0 on <span class="colophon-date" title="Wednesday 17 July 2024 15:39">Wednesday 17 July 2024</span>. Using Julia version 1.10.4.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
<html lang="en"><head><meta charset="UTF-8"/><meta name="viewport" content="width=device-width, initial-scale=1.0"/><title>- · RingStarProblems Documentattion</title><meta name="title" content="- · RingStarProblems Documentattion"/><meta property="og:title" content="- · RingStarProblems Documentattion"/><meta property="twitter:title" content="- · RingStarProblems Documentattion"/><meta name="description" content="Documentation for RingStarProblems Documentattion."/><meta property="og:description" content="Documentation for RingStarProblems Documentattion."/><meta property="twitter:description" content="Documentation for RingStarProblems Documentattion."/><script data-outdated-warner src="assets/warner.js"></script><link href="https://cdnjs.cloudflare.com/ajax/libs/lato-font/3.0.0/css/lato-font.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/juliamono/0.050/juliamono.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/fontawesome.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/solid.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/brands.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.16.8/katex.min.css" rel="stylesheet" type="text/css"/><script>documenterBaseURL="."</script><script src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.6/require.min.js" data-main="assets/documenter.js"></script><script src="search_index.js"></script><script src="siteinfo.js"></script><script src="../versions.js"></script><link class="docs-theme-link" rel="stylesheet" type="text/css" href="assets/themes/catppuccin-mocha.css" data-theme-name="catppuccin-mocha"/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="assets/themes/catppuccin-macchiato.css" data-theme-name="catppuccin-macchiato"/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="assets/themes/catppuccin-frappe.css" data-theme-name="catppuccin-frappe"/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="assets/themes/catppuccin-latte.css" data-theme-name="catppuccin-latte"/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="assets/themes/documenter-dark.css" data-theme-name="documenter-dark" data-theme-primary-dark/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="assets/themes/documenter-light.css" data-theme-name="documenter-light" data-theme-primary/><script src="assets/themeswap.js"></script></head><body><div id="documenter"><nav class="docs-sidebar"><div class="docs-package-name"><span class="docs-autofit"><a href>RingStarProblems Documentattion</a></span></div><button class="docs-search-query input is-rounded is-small is-clickable my-2 mx-auto py-1 px-2" id="documenter-search-query">Search docs (Ctrl + /)</button><ul class="docs-menu"><li class="is-active"><a class="tocitem" href>-</a></li></ul><div class="docs-version-selector field has-addons"><div class="control"><span class="docs-label button is-static is-size-7">Version</span></div><div class="docs-selector control is-expanded"><div class="select is-fullwidth is-size-7"><select id="documenter-version-selector"></select></div></div></div></nav><div class="docs-main"><header class="docs-navbar"><a class="docs-sidebar-button docs-navbar-link fa-solid fa-bars is-hidden-desktop" id="documenter-sidebar-button" href="#"></a><nav class="breadcrumb"><ul class="is-hidden-mobile"><li class="is-active"><a href>-</a></li></ul><ul class="is-hidden-tablet"><li class="is-active"><a href>-</a></li></ul></nav><div class="docs-right"><a class="docs-navbar-link" href="https://github.com/jkhamphousone/RingStarProblems.jl" title="View the repository on GitHub"><span class="docs-icon fa-brands"></span><span class="docs-label is-hidden-touch">GitHub</span></a><a class="docs-navbar-link" href="https://github.com/jkhamphousone/RingStarProblems.jl/blob/main/docs/src/index.md" title="Edit source on GitHub"><span class="docs-icon fa-solid"></span></a><a class="docs-settings-button docs-navbar-link fa-solid fa-gear" id="documenter-settings-button" href="#" title="Settings"></a><a class="docs-article-toggle-button fa-solid fa-chevron-up" id="documenter-article-toggle-button" href="javascript:;" title="Collapse all docstrings"></a></div></header><article class="content" id="documenter-page"><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="RingStarProblems.rspoptimize" href="#RingStarProblems.rspoptimize"><code>RingStarProblems.rspoptimize</code></a> — <span class="docstring-category">Function</span></header><section><div><pre><code class="language-julia hljs">rspoptimize(pars::SolverParameters, id_instance, optimizer, solutionchecker = false)</code></pre><p>Return exit code 0</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/jkhamphousone/RingStarProblems.jl/blob/59a21037fee475c14b4d088025ebef7e4b77105f/src/main.jl#L4-L8">source</a></section></article></article><nav class="docs-footer"><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="auto">Automatic (OS)</option><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option><option value="catppuccin-latte">catppuccin-latte</option><option value="catppuccin-frappe">catppuccin-frappe</option><option value="catppuccin-macchiato">catppuccin-macchiato</option><option value="catppuccin-mocha">catppuccin-mocha</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.5.0 on <span class="colophon-date" title="Thursday 18 July 2024 08:37">Thursday 18 July 2024</span>. Using Julia version 1.10.4.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
Binary file modified docs/build/objects.inv
Binary file not shown.
2 changes: 1 addition & 1 deletion docs/build/search_index.js
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
var documenterSearchIndex = {"docs":
[{"location":"","page":"-","title":"-","text":"rspoptimize(pars, id_instance, optimizer, solutionchecker = false)","category":"page"},{"location":"#RingStarProblems.rspoptimize","page":"-","title":"RingStarProblems.rspoptimize","text":"rspoptimize(pars::SolverParameters, id_instance, optimizer, solutionchecker = false)\n\nReturn exit code 0\n\n\n\n\n\n","category":"function"}]
[{"location":"","page":"-","title":"-","text":"rspoptimize(pars::SolverParameters, id_instance, optimizer, solutionchecker = false)","category":"page"},{"location":"#RingStarProblems.rspoptimize","page":"-","title":"RingStarProblems.rspoptimize","text":"rspoptimize(pars::SolverParameters, id_instance, optimizer, solutionchecker = false)\n\nReturn exit code 0\n\n\n\n\n\n","category":"function"}]
}
2 changes: 1 addition & 1 deletion docs/src/index.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
```@docs
rspoptimize(pars, id_instance, optimizer, solutionchecker = false)
rspoptimize(pars::SolverParameters, id_instance, optimizer, solutionchecker = false)
```
2 changes: 1 addition & 1 deletion src/main.jl
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
Return exit code 0
"""
function rspoptimize(pars, id_instance, optimizer, solutionchecker = false)
function rspoptimize(pars::SolverParameters, id_instance, optimizer, solutionchecker = false)

fd_small = joinpath(@__DIR__, "instances", "Instances_small")
fd_15 = joinpath(@__DIR__, "instances", "Instances_15")
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -1251,6 +1251,65 @@ BACKUP RING

BACKUP STAR

B = 0.0
i★ = 0
j★ = 0
k★ = 0
</details>
</details> ILP ——— 1 hubs —— 1
total time 4.07 (TL 60) gap 100.0
blossom time 0 nb blossom 0.0
LB <= UB 964.75<=0 subtour 0.0
connectivity cuts 1.0 uc strategy true
uc tolerance 0.01 tildeV 2:10
2-opt strategy 0
explored_nodes -1 n lazycuts edges 0.0
F 183.0 post procedure true
o_i 0 r_ij Euclidian()
s_ij Euclidian()
<details><summary>Found solution</summary>
RING NODES
1

RING

STAR

BACKUP RING

BACKUP STAR

B = 0.0
i★ = 0
j★ = 0
k★ = 0
</details>
BD —— 1 hubs —— 1-1
total time 8.49 (TL 60) gap 100.0
blossom time 0 nb blossom 0.0
LB <= UB 902.5<=0 Master/SP costs 0.0/0
Master time 8.49 SP time 0.0
subtour 0.0 connectivity cuts 1.0
uc strategy true uc tolerance 0.01
opt. cuts 0.0 SP method Poly()
tildeV 2:10 inst transformation 2
2-opt strategy 0
explored nodes 0
F 183.0
o_i 0 r_ij Euclidian()
s_ij Euclidian()
<details><summary>Found solution</summary>
RING NODES
1

RING

STAR

BACKUP RING

BACKUP STAR

B = 0.0
i★ = 0
j★ = 0
Expand Down

0 comments on commit aeca99a

Please sign in to comment.