ldpc-toolbox 0.12.0

Utilities to aid in LDPC code design
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50

//! 5G NR CLI subcommand.
//!
//! This subcommand can be used to generate the LDPC codes used in 5G NR. It
//! prints the alist of the parity matrix to `stdout`, and optionally computes
//! and prints the girth of the Tanner graph. Se [`crate::codes::nr5g`] for more
//! information about the 5G NR LPDC codes.
//!
//! # Examples
//! The base graph 1 with lifting size 32 can be generate with
//! ```shell
//! $ ldpc-toolbox 5g --base-graph 1 --lifting-size 32
//! ```
//! Its girth is computed with
//! ```shell
//! $ ldpc-toolbox 5g --base-graph 1 --lifting-size 32 --girth
//! ```

use crate::cli::*;
use crate::codes::nr5g::{BaseGraph, LiftingSize};
use clap::Parser;

/// 5G NR arguments.
#[derive(Debug, Parser)]
pub struct Args {
    /// Base graph
    #[arg(long)]
    pub base_graph: BaseGraph,
    /// Lifting size
    #[arg(long)]
    pub lifting_size: LiftingSize,
    /// Performs girth calculation
    #[arg(long)]
    pub girth: bool,
}

impl Run for Args {
    fn run(&self) -> std::result::Result<(), Box<dyn std::error::Error>> {
        let h = self.base_graph.h(self.lifting_size);
        if self.girth {
            if let Some(g) = h.girth() {
                println!("Code girth = {}", g);
            } else {
                println!("Code girth is infinite");
            }
        } else {
            println!("{}", h.alist());
        }
        Ok(())
    }
}