From a3bd4b465248133ad98e73fb685acc5d402f2c6e Mon Sep 17 00:00:00 2001 From: Adomas Baliuka Date: Tue, 9 Apr 2024 18:01:05 +0200 Subject: [PATCH] Adjust README to include print_cpp_header_QC --- Project.toml | 2 +- README.md | 5 +++-- src/cpp_header_based.jl | 6 +++--- 3 files changed, 7 insertions(+), 6 deletions(-) diff --git a/Project.toml b/Project.toml index a9af78c..5c03f4e 100644 --- a/Project.toml +++ b/Project.toml @@ -1,7 +1,7 @@ name = "LDPCStorage" uuid = "d46d874d-5773-4ce9-8adb-568101dc8882" authors = ["Adomas Baliuka "] -version = "0.4.1" +version = "0.5.0" [deps] DocStringExtensions = "ffbed154-4ef7-542d-bbb7-c09d3a79fcae" diff --git a/README.md b/README.md index 53f57f5..1ca0b6a 100644 --- a/README.md +++ b/README.md @@ -52,8 +52,9 @@ open("./autogen_ldpc.hpp", "w+") do io end ``` -Also available are versions of the other methods accepting an `IO` object: -`print_alist`, `print_bincscjson`, etc. +There also are methods accepting an `IO` object: `print_alist`, `print_bincscjson`, etc. + +Some methods support outputting quasi-cyclic exponents directly, e.g., `print_cpp_header_QC` outputs a C++ header. ## Contributing Contributions, feature requests and suggestions are welcome. Open an issue or contact us directly. diff --git a/src/cpp_header_based.jl b/src/cpp_header_based.jl index 53201d1..80de0a1 100644 --- a/src/cpp_header_based.jl +++ b/src/cpp_header_based.jl @@ -42,7 +42,7 @@ $(SIGNATURES) Output C++ header storing the sparse binary (containing only zeros and ones) matrix H in compressed sparse column (CSC) format. -Note the conversion from Julia's one-based indices to zero-based indices in C++ (also within CSC format). +Note the conversion from Julia's one-based indices to zero-based indices in C++ (also within CSC format)! """ function print_cpp_header( io::IO, @@ -108,9 +108,9 @@ $(SIGNATURES) Output C++ header storing the quasi-cyclic exponents of an LDPC matrix in compressed sparse column (CSC) format. This implies three arrays, which are called `colptr`, `row_idx` and `values`. -The expansion factor must also be given. +The expansion factor must also be given (it is simply stored as a variable in the header). -Note the conversion from Julia's one-based indices to zero-based indices in C++ (also within CSC format). +Note the conversion from Julia's one-based indices to zero-based indices in C++ (also within CSC format)! """ function print_cpp_header_QC( io::IO,