Skip to content

Commit 9769b43

Browse files
committed
suppress false positives
1 parent 1d73945 commit 9769b43

File tree

4 files changed

+1
-42
lines changed

4 files changed

+1
-42
lines changed

docs/src/Classical/linear_code.md

Lines changed: 0 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -78,10 +78,6 @@ The minimum distance and its bounds may be manually set as well. Nothing is done
7878
set_distance_lower_bound!
7979
```
8080

81-
```@docs
82-
set_distance_upper_bound!
83-
```
84-
8581
```@docs
8682
set_minimum_distance!
8783
```
@@ -92,10 +88,6 @@ set_minimum_distance!
9288
Singleton_bound
9389
```
9490

95-
```@docs
96-
encode
97-
```
98-
9991
```@docs
10092
syndrome
10193
```

docs/src/Classical/new_codes_from_old.md

Lines changed: 0 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -22,29 +22,16 @@ construction_X3
2222
```
2323

2424
The direct sum code has generator matrix `G1 ⊕ G2` and parity-check matrix `H1 ⊕ H2`.
25-
```@docs
26-
CodingTheory.⊕
27-
```
2825

2926
The generator matrix of the (direct) product code is the kronecker product of the generator matrices of the inputs.
30-
```@docs
31-
CodingTheory.×
32-
```
3327

3428
The parity-check matrix of the tensor product code is the kronecker product of the parity-check matrices of the inputs.
35-
```@docs
36-
CodingTheory.⊗
37-
```
3829

3930
There is some debate on how to define this product. This is known to often be the full ambient space.
4031
```@docs
4132
entrywise_product_code
4233
```
4334

44-
```@docs
45-
CodingTheory./
46-
```
47-
4835
`juxtaposition` is representation dependent and therefore works on the potentially over-complete generator matrices, not on the standard form.
4936
```@docs
5037
juxtaposition
@@ -53,9 +40,6 @@ juxtaposition
5340
## Methods
5441

5542
If `C` is a quasi-cyclic code, `permute_code` returns a `LinearCode` object.
56-
```@docs
57-
permute_code
58-
```
5943

6044
The most common way to extend a code is to add an extra column to the generator matrix whose values make the sum of the rows zero. This is called an even extension and is the default for `extend(C)`. Alternatively, this new column may be inserted at any index `c` in the matrix, e.g. `extend(C, c)`. In the most general case, one may provide a vector `a` and define the values of the new column to be `-a` dot the row. The standard definition is clearly just the special case that `a` is the all-ones vector.
6145
```@docs

docs/src/LDPC/analysis.md

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -27,14 +27,8 @@ optimal_threshold
2727
density_evolution
2828
```
2929

30-
```@docs
31-
plot_EXIT_chart
32-
```
3330

3431
# Misc
35-
```@docs
36-
multiplicative_gap
37-
```
3832

3933
```@docs
4034
multiplicative_gap_lower_bound

docs/src/LDPC/codes.md

Lines changed: 1 addition & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -31,14 +31,7 @@ Parity-check matrix: 6 × 9
3131
1 1 0 0 0 0 1 1 1
3232
```
3333

34-
Random regular LDPC codes maybe be constructed via
35-
```@docs
36-
regular_LDPC_code
37-
```
38-
and irregular LDPC codes via
39-
```@docs
40-
irregular_LDPC_code
41-
```
34+
Random regular LDPC codes maybe be constructed via `regular_LDPC_code` and `irregular_LDPC_code`
4235

4336
## Attributes
4437
The polynomials ``\lambda(x)`` and ``\rho(x)`` as well as the degrees of each variable and check nodes are computed upon construction.
@@ -116,10 +109,6 @@ To count or explicitly enumerate the short cycles of the Tanner graph, use
116109
count_short_cycles
117110
```
118111

119-
```@docs
120-
shortest_cycles
121-
```
122-
123112
Various information about the ACE values of cycles in the Tanner graph may be computed with the following functions.
124113

125114

0 commit comments

Comments
 (0)