From 427e6d5b13e14022646c243a37d790f57a036f9c Mon Sep 17 00:00:00 2001
From: Martin Sandfuchs <martisan@phys.ethz.ch>
Date: Fri, 11 Aug 2023 23:56:03 +0200
Subject: [PATCH] Add some comments

---
 rel_qkd/key_rates_qber.jl | 10 ++++++++++
 1 file changed, 10 insertions(+)

diff --git a/rel_qkd/key_rates_qber.jl b/rel_qkd/key_rates_qber.jl
index 5a23ff3..8dc94c2 100755
--- a/rel_qkd/key_rates_qber.jl
+++ b/rel_qkd/key_rates_qber.jl
@@ -317,11 +317,21 @@ function HAgB(alpha, q; eta)
 end
 
 
+"""
+    key_rate(α, q; eta)
+
+The key rate for a given alpha, qber `q` and transmittance `eta`.
+"""
 function key_rate(α, q; eta)
     return compute_entropy(α, q; eta) - HAgB(α, q; eta)
 end
 
 
+"""
+    key_rate(q; eta)
+
+The key rate for a given qber `q` and transmittance `eta`, optimized over alpha.
+"""
 function key_rate(q; eta)
     res = Optim.optimize(alpha -> -key_rate(alpha, q; eta), 0.0, 0.8)
     @show res
-- 
GitLab