Skip to content

Commit 23425c5

Browse files
committed
fix documentation errors
1 parent dc65a44 commit 23425c5

File tree

7 files changed

+10
-42
lines changed

7 files changed

+10
-42
lines changed

docs/src/Classical/cyclic_code.md

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -82,10 +82,6 @@ qcosets
8282
qcosets_reps
8383
```
8484

85-
```@docs
86-
defining_set
87-
```
88-
8985
```@docs
9086
zeros
9187
```

docs/src/Classical/linear_code.md

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -50,9 +50,6 @@ standard_form_permutation
5050
```
5151

5252
The minimum distance of some code families are known and are set during construction. The minimum distance is automatically computed in the constructor for codes which are deemed "small enough". Otherwise, the minimum distance is `missing`. Primitive bounds on the minimum distance are given by
53-
```@docs
54-
minimum_distance_lower_bound
55-
```
5653

5754
```@docs
5855
minimum_distance_upper_bound

docs/src/LDPC/codes.md

Lines changed: 0 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -121,28 +121,6 @@ shortest_cycles
121121
```
122122

123123
Various information about the ACE values of cycles in the Tanner graph may be computed with the following functions.
124-
```@docs
125-
ACE_spectrum
126-
```
127-
128-
```@docs
129-
shortest_cycle_ACE
130-
```
131-
132-
```@docs
133-
ACE_distribution
134-
```
135124

136-
```@docs
137-
average_ACE_distribution
138-
```
139-
140-
```@docs
141-
median_ACE_distribution
142-
```
143-
144-
```@docs
145-
mode_ACE_distribution
146-
```
147125

148126
## Greedy Construction Algorithms

docs/src/LDPC/decoders.md

Lines changed: 0 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -21,18 +21,10 @@ sum_product_box_plus
2121
min_sum
2222
```
2323

24-
```@docs
25-
find_MP_schedule
26-
```
27-
2824
## Linear Programming
2925

3026
```@docs
3127
LP_decoder_LDPC
3228
```
3329

3430
## Simulations
35-
36-
```@docs
37-
decoder_simulation
38-
```

docs/src/Tutorials/Message Passing.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -406,7 +406,7 @@ julia> Gallager_B(H, y)
406406
```
407407

408408
## Decimation
409-
Decimation was previously used in message-passing applications outside of error correction and was applied to stabilizer codes in [](@cite). The idea is to freeze the value of a variable node. We can either do this from the start to obtain a so-called *genie-aided* decoder, or we can periodically pause message passing to fix a bit. In *guided decimation*, we pause every fixed number of rounds and freeze the value of the variable node with the highest log-likelihood ratio. In *automated decimation*, we pause after every iteration and fix any bit whose absolute value has passed a certain threshold.
409+
Decimation was previously used in message-passing applications outside of error correction and was applied to stabilizer codes [yao2024belief](@cite). The idea is to freeze the value of a variable node. We can either do this from the start to obtain a so-called *genie-aided* decoder, or we can periodically pause message passing to fix a bit. In *guided decimation*, we pause every fixed number of rounds and freeze the value of the variable node with the highest log-likelihood ratio. In *automated decimation*, we pause after every iteration and fix any bit whose absolute value has passed a certain threshold.
410410

411411
It is important to note that when a variable node is fixed to a specific value, the decoder is now sampling possible solutions with that fixed bit, which is different from the ML and MAP problems above. Furthermore, if there is a unique solution and a bit is fixed which does not match the solution, the decoder will fail instead of correcting that bit. For example, fixing the most reliable bit in guided decimation may mean fixing a bit which is still far from reliable and could go either way. On the other hand, fixing a bit could help the decoder converge faster and also break out of trapping sets. In this sense, decimation can be very helpful decoding degenerate stabilizer codes where there are many valid solutions and BP has a difficult time picking one to converge to.
412412

docs/src/references.bib

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -174,3 +174,12 @@ @article{roffe2023bias
174174
year={2023},
175175
publisher={Verein zur F{\"o}rderung des Open Access Publizierens in den Quantenwissenschaften}
176176
}
177+
178+
@inproceedings{yao2024belief,
179+
title={Belief propagation decoding of quantum LDPC codes with guided decimation},
180+
author={Yao, Hanwen and Laban, Waleed Abu and H{\"a}ger, Christian and i Amat, Alexandre Graell and Pfister, Henry D},
181+
booktitle={2024 IEEE International Symposium on Information Theory (ISIT)},
182+
pages={2478--2483},
183+
year={2024},
184+
organization={IEEE}
185+
}

src/Classical/cyclic_code.jl

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -433,11 +433,7 @@ Return the set of representatives for the q-cyclotomic cosets of the cyclic code
433433
"""
434434
qcosets_reps(C::AbstractCyclicCode) = C.qcosets_reps
435435

436-
"""
437-
defining_set(C::AbstractCyclicCode)
438436

439-
Return the defining set of the cyclic code.
440-
"""
441437
defining_set(C::AbstractCyclicCode) = C.def_set
442438

443439
"""

0 commit comments

Comments
 (0)