Merge branch 'main' of github.com:ZIB-IOL/BellPolytopes.jl into main

README.md

@@ -3,10 +3,10 @@
 [![Stable](https://img.shields.io/badge/docs-stable-blue.svg)](https://zib-iol.github.io/BellPolytopes.jl/stable/)
 [![Dev](https://img.shields.io/badge/docs-dev-blue.svg)](https://zib-iol.github.io/BellPolytopes.jl/dev/)
 [![Build Status](https://github.com/zib-iol/BellPolytopes.jl/actions/workflows/CI.yml/badge.svg?branch=main)](https://github.com/zib-iol/BellPolytopes.jl/actions/workflows/CI.yml?query=branch%3Amain)
-<!-- [![Coverage](https://codecov.io/gh/zib-iol/BellPolytopes.jl/branch/main/graph/badge.svg)](https://codecov.io/gh/zib-iol/BellPolytopes.jl) -->
 
 This package addresses the membership problem for local polytopes: it constructs Bell inequalities and local models in multipartite Bell scenarios with binary outcomes.
 
+
 ## Installation
 
 The most recent release is available via the julia package manager, e.g., with

docs/make.jl

@@ -34,7 +34,10 @@ makedocs(;
         edit_link="main",
         assets=String[],
     ),
-    pages=["Home" => "index.md"],
+    pages=[
+        "Home" => "index.md",
+        "API reference" => "api.md",
+    ],
 )
 
-deploydocs(; repo="github.com/ZIB-IOL/BellPolytopes.jl", devbranch="main")
+deploydocs(; repo="github.com/ZIB-IOL/BellPolytopes.jl", devbranch="main", push_preview=true)

docs/src/api.md

@@ -0,0 +1,5 @@
+# API reference
+
+```@autodocs
+Modules = [BellPolytopes]
+```

src/BellPolytopes.jl

@@ -29,8 +29,8 @@ Arguments:
 Returns:
  - `x`: a correlation tensor of order `N`, the output of the Frank-Wolfe algorithm,
  - `ds`: a deterministic strategy, the atom returned by the last LMO,
- - `primal`: ½|x-v0*p|²
- - `dual_gap`: <x-v0*p,x-ds>
+ - `primal`: `½|x-v₀*p|²`
+ - `dual_gap`: `⟨x-v₀*p, x-ds⟩`
  - `traj_data`: trajectory of the algorithm,
  - `active_set`: all deterministic strategies used for the decomposition of the last iterate `x`, contains fields `weights`, `atoms`, and `x`,
  - `M`: a Bell inequality, meaningful only if the dual gap is small enough

test/runtests.jl

@@ -19,7 +19,6 @@ using BellPolytopes
     @test abs(bell_frank_wolfe(correlation_matrix(HQVNB17_vec(3)); use_array=true)[3] - 0.613691) <
           1e-5
     @test abs(bell_frank_wolfe(correlation_matrix(HQVNB17_vec(5)))[3] - 5.69) < 1e-1
-    @test abs(bell_frank_wolfe(correlation_matrix(HQVNB17_vec(7)))[3] - 23.02) < 1e-1
 end
 
 @testset "Testing Bell-Frank-Wolfe with d=2, N=2, and cor/marg matrices   " begin