Skip to content

Commit

Permalink
Adjust readme
Browse files Browse the repository at this point in the history
  • Loading branch information
@projekter
projekter committed Nov 29, 2023
1 parent f888499 commit 5f7ed75
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
[![Build status (Github Actions)](https://github.com/projekter/StandardPacked.jl/workflows/CI/badge.svg)](https://github.com/projekter/StandardPacked.jl/actions)
[![codecov.io](http://codecov.io/github/projekter/StandardPacked.jl/coverage.svg?branch=main)](http://codecov.io/github/projekter/StandardPacked.jl?branch=main)

`StandardPacked` is a Julia package that wraps functions for storing symmetric matrices in their packed form, i.e.,
`StandardPacked` is a Julia package that wraps functions for storing symmetric matrices in their standard packed form, i.e.,
column-wise stacked upper or lower triangles. It also provides bindings for the corresponding LAPACK functions, which allow
things such as eigendecompositions. Note that typically, the packed form requires a bit longer calculation times and is
slightly more imprecise than the dense form; however, it requires less storage.
Expand All @@ -17,6 +17,6 @@ between the actual matrices.

Note that neither of those formats correspond to the rectangular full packed format. The latter has the same favorable scaling
with respect to memory, but additionally a better layout for some linear algebra routines, making it almost as fast as the
dense format. However, index access is a bit weird there and it is not in wide use. Currently, this package does _not_ provide
the RFP format (though it certainly could at some later time). Consider
dense format. However, index access is a bit weird there and it is not in wide use; furthermore, there are far fewer LAPACK
functions working with RFP. Consider
[`RectangularFullPacked.jl`](https://github.com/JuliaLinearAlgebra/RectangularFullPacked.jl) instead.

2 comments on commit 5f7ed75

@projekter
Copy link
Owner Author

Choose a reason for hiding this comment

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

@JuliaRegistrator register

@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/96159

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 v1.0.0 -m "<description of version>" 5f7ed75bbac0e4a21548380cf067791373347101
git push origin v1.0.0

Please sign in to comment.