ITensor / ITensor/ITensorMPS.jl

[ITensorMPS] DMRG eigsolve keyword argument names

Open
#49 1 comment 0 reactions 1 assignee View on GitHub

@mtfishman is already working on this.

Since Oct 7, 2020.

Dominant language
Julia
Stars
85
Forks
27
Avg merge
22m
Merged PRs (30d)
1

Description

Right now, the convention for setting eigsolve keyword arguments through DMRG is the following:

dmrg(H, psi0, sweeps;
     eigsolve_tol = 1e-14,
     eigsolve_krylovdim = 3,
     eigsolve_maxiter = 1,
     eigsolve_verbosity = 0)

Instead, we could pack them all into a single keyword argument eigsolve, and pass them as a NamedTuple:

dmrg(H, psi0, sweeps; eigsolve = (tol = 1e-14, krylovdim = 3, maxiter = 1, verbosity = 0))

This could be a commonly used code pattern for keyword arguments that are passed through a high level function to some lower level function (for example, it could be used in factorize for passing keyword arguments to svd about what kind of SVD algorithm to use).

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.