Skip to content

Commit 4a434ca

Browse files
committed
fixup
1 parent dbdbf03 commit 4a434ca

File tree

5 files changed

+13
-2
lines changed

5 files changed

+13
-2
lines changed

docs/src/Classical/linear_code.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,8 @@ cardinality
3131
rate
3232
```
3333

34+
See also: encode`
35+
3436
If the linear code was created by passing in a generator (parity-check) matrix, then this matrix is stored in addition to the standard form. Note that this matrix is potentially over complete (has more rows than its rank). The standard form is returned when the optional parameter `stand_form` is set to true. Some code families are not constructed using these matrices. In these cases, the matrices are initially `missing` and are computed and cached when these functions are called for the first time. Direct access to the underlying structs is not recommended.
3537
```@docs
3638
generator_matrix
@@ -82,6 +84,8 @@ set_distance_lower_bound!
8284
set_minimum_distance!
8385
```
8486

87+
See: `minimum_distance_lower_bound`, `set_distance_upper_bound!`
88+
8589
## Methods
8690

8791
```@docs

docs/src/Classical/new_codes_from_old.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ juxtaposition
5151

5252
## Methods
5353

54-
If `C` is a quasi-cyclic code, `permute_code` returns a `LinearCode` object.
54+
If `C` is a quasi-cyclic code, `permute_code` returns a `LinearCode` object. See: `permute_code`
5555

5656
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.
5757
```@docs

docs/src/LDPC/analysis.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -38,6 +38,8 @@ multiplicative_gap_lower_bound
3838
density_lower_bound
3939
```
4040

41+
See also: `plot_EXIT_chart`, `multiplicative_gap`
42+
4143
## Comments
4244

4345
(these are just temporary notes)

docs/src/LDPC/codes.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -109,7 +109,8 @@ To count or explicitly enumerate the short cycles of the Tanner graph, use
109109
count_short_cycles
110110
```
111111

112-
Various information about the ACE values of cycles in the Tanner graph may be computed with the following functions.
112+
See also: `shortest_cycles`
113113

114+
Various information about the ACE value of cycles in the Tanner graph may be computed with the following functions. See: `ACE_spectrum`, `shortest_cycle_ACE`, `ACE_distribution`, `average_ACE_distribution`, `median_ACE_distribution`, `mode_ACE_distribution`
114115

115116
## Greedy Construction Algorithms

docs/src/LDPC/decoders.md

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

24+
See also: `find_MP_schedule`
25+
2426
## Linear Programming
2527

2628
```@docs
2729
LP_decoder_LDPC
2830
```
2931

3032
## Simulations
33+
34+
See: `decoder_simulation`

0 commit comments

Comments
 (0)