Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

optional sizehint for building matrix #199

Merged
merged 3 commits into from
Mar 30, 2023
Merged
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Update src/Hamiltonians/abstract.jl
Co-authored-by: Joachim Brand <j.brand@massey.ac.nz>
  • Loading branch information
christofbradly and joachimbrand authored Mar 30, 2023
commit 84c331bd6d83504d18e7e3318f2a353a06209b08
6 changes: 3 additions & 3 deletions src/Hamiltonians/abstract.jl
Original file line number Diff line number Diff line change
Expand Up @@ -155,9 +155,9 @@ configurations.
Providing the number `nnzs` of expected calculated matrix elements may improve performance.
The default estimates for `nnzs` is `dimension(ham)`.

Setting a custom `col_hint` may improve performance for cases where `num_offdiagonals` is
not a good estimate of the actual number of nonzero offdiagonal elements in each column.
Defaults to `num_offdiagonals(ham, address)`.
Setting a custom value `col_hint` for the estimated number of nonzero
off-diagonal matrix elements in each matrix column may improve performance.
The default value for `col_hint` is `num_offdiagonals(ham, address)`.

Providing an energy cutoff will skip the columns and rows with diagonal elements greater
than `cutoff`. Alternatively, an arbitrary `filter` function can be used instead. These are
Expand Down