Skip to content

Commit

Permalink
Adjust README to include print_cpp_header_QC
Browse files Browse the repository at this point in the history
  • Loading branch information
Adomas Baliuka authored and Adomas Baliuka committed Apr 9, 2024
1 parent d2ee5b8 commit a3bd4b4
Show file tree
Hide file tree
Showing 3 changed files with 7 additions and 6 deletions.
2 changes: 1 addition & 1 deletion Project.toml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
name = "LDPCStorage"
uuid = "d46d874d-5773-4ce9-8adb-568101dc8882"
authors = ["Adomas Baliuka <[email protected]>"]
version = "0.4.1"
version = "0.5.0"

[deps]
DocStringExtensions = "ffbed154-4ef7-542d-bbb7-c09d3a79fcae"
Expand Down
5 changes: 3 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
6 changes: 3 additions & 3 deletions src/cpp_header_based.jl
Original file line number Diff line number Diff line change
Expand Up @@ -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,
Expand Down Expand Up @@ -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,
Expand Down

3 comments on commit a3bd4b4

@adomasbaliuka
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@adomasbaliuka
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@JuliaRegistrator
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Registration pull request created: JuliaRegistries/General/104560

Tip: Release Notes

Did you know you can add release notes too? Just add markdown formatted text underneath the comment after the text
"Release notes:" and it will be added to the registry PR, and if TagBot is installed it will also be added to the
release that TagBot creates. i.e.

@JuliaRegistrator register

Release notes:

## Breaking changes

- blah

To add them here just re-invoke and the PR will be updated.

Tagging

After the above pull request is merged, it is recommended that a tag is created on this repository for the registered package version.

This will be done automatically if the Julia TagBot GitHub Action is installed, or can be done manually through the github interface, or via:

git tag -a v0.5.0 -m "<description of version>" a3bd4b465248133ad98e73fb685acc5d402f2c6e
git push origin v0.5.0

Please sign in to comment.