Tensor tools

ElemCo.TensorToolsModule

tensor tools, e.g., access to integrals, load/save intermediates...

I/O functions

ElemCo.TensorTools.save!Function
save!(EC::ECInfo, fname::String, a::AbstractArray...; description="tmp", overwrite=true)

Save array or tuple of arrays a to file fname in EC.scr directory. Add file to EC.files with description.

ElemCo.TensorTools.loadFunction
load(EC::ECInfo, fname::String)

Load array from file fname in EC.scr directory.

load(EC::ECInfo, fname::String, ::Val{N}, T::Type=Float64; skip_error=false) where {N}

Type-stable load array from file fname in EC.scr directory.

The type T and number of dimensions N are given explicitly. If skip_error is true, return empty Array{T,N} if the dimension/type is wrong.

ElemCo.TensorTools.mmapFunction
mmap(EC::ECInfo, fname::String)

Memory-map an existing file for reading. Return a pointer to the file and the mmaped array.

ElemCo.TensorTools.newmmapFunction
newmmap(EC::ECInfo, fname::String, dims::Tuple{Vararg{Int}}, Type=Float64; description="tmp")

Create a new memory-map file for writing (overwrites existing file). Add file to EC.files with description. Return a pointer to the file and the mmaped array.

Integral extraction

ElemCo.TensorTools.ints1Function
ints1(EC::ECInfo, spaces::String, spincase = nothing)

Return subset of 1e⁻ integrals according to spaces.

The spincase∈{,} can explicitly be given, or will be deduced from upper/lower case of spaces specification.

ElemCo.TensorTools.ints2Function
ints2(EC::ECInfo, spaces::String, spincase = nothing)

Return subset of 2e⁻ integrals according to spaces.

The spincase∈{,} can explicitly be given, or will be deduced from upper/lower case of spaces specification. If the last two indices are stored as triangular - make them full.

Tensor manipulation

ElemCo.TensorTools.sqrtinvcholFunction
sqrtinvchol(A::AbstractMatrix; tol = 1e-8, verbose = false)

Return NON-SYMMETRIC (pseudo)sqrt-inverse of a hermitian matrix using Cholesky decomposition.

Starting from $A^{-1} = A^{-1} L (A^{-1} L)^† = M M^†$ with $A = L L^†$. By solving the equation $L^† M = 1$ (for low-rank: using QR decomposition). Return M.

ElemCo.TensorTools.invcholFunction
invchol(A::AbstractMatrix; tol = 1e-8, verbose = false)

Return (pseudo)inverse of a hermitian matrix using Cholesky decomposition .

The inverse is calculated as $A^{-1} = A^{-1} L (A^{-1} L)^† = M M^†$ with $A = L L^†$. By solving the equation $L^† M = 1$ (for low-rank: using QR decomposition)

ElemCo.TensorTools.rotate_eigenvectors_to_realFunction
rotate_eigenvectors_to_real(evecs::AbstractMatrix, evals::AbstractVector)

Transform complex eigenvectors of a real matrix to a real space such that they block-diagonalize the matrix.

Return the eigenvectors and "eigenvalues" (the diagonal of the matrix) in the real space.

Other exported functions

ElemCo.TensorTools.detri_int2Method
detri_int2(allint2, norb, sp1, sp2, sp3, sp4)

Return full 2e⁻ integrals <sp1 sp2 | sp3 sp4> from allint2 with last two indices as a triangular index.

ElemCo.TensorTools.get_spaceblocksFunction
get_spaceblocks(space, maxblocksize=100, strict=false)

Generate ranges for block indices for space (for loop over blocks).

space is a range or an array of indices. Even if space is non-contiguous, the blocks will be contiguous. If strict is true, the blocks will be of size maxblocksize (except for the last block and non-contiguous index-ranges). Otherwise the actual block size will be as close as possible to blocksize such that the resulting blocks are of similar size.

ElemCo.TensorTools.load_allMethod
load_all(EC::ECInfo, fname::String, ::Val{N}, T::Type=Float64; skip_error=false) where {N}

Type-stable load arrays from file fname in EC.scr directory.

The type T and number of dimensions N are given explicitly (have to be the same for all arrays). Return an array of arrays. If skip_error is true, return empty Array{T,N}[Array{T,N}()] if the dimension/type is wrong.

ElemCo.TensorTools.print_nonzerosMethod
print_nonzeros(tensor::AbstractArray; ϵ=1.e-12, fname::String="")

Print cartesian index alongside value of array for elements with absolute value greater or equal than ϵ either to stdout or to a file.

ElemCo.TensorTools.svd_thrFunction
svd_thr(Amat::AbstractMatrix, thr=1.e-12)

Return SVD of a matrix with singular values below thr set to zero.

Internal functions

ElemCo.TensorTools.triindsFunction
triinds(norb, sp1::AbstractArray{Int}, sp2::AbstractArray{Int}, reverseCartInd = false)

Generate set of CartesianIndex for addressing the lhs and a bitmask for the rhs for transforming a triangular index from 1:norb to two original indices in spaces sp1 and sp2. If reverse: the cartesian indices are reversed.