merge constructors

Author: lkdvos

.github/workflows/IntegrationTestRequest.yml

@@ -0,0 +1,14 @@
+name: "Integration Test Request"
+
+on:
+  issue_comment:
+    types: [created]
+
+jobs:
+  integrationrequest:
+    if: |
+      github.event.issue.pull_request &&
+      contains(fromJSON('["OWNER", "COLLABORATOR", "MEMBER"]'), github.event.comment.author_association)
+    uses: ITensor/ITensorActions/.github/workflows/IntegrationTestRequest.yml@main
+    with:
+      localregistry: https://github.com/ITensor/ITensorRegistry.git

.github/workflows/Register.yml

@@ -0,0 +1,17 @@
+name: Register Package
+on:
+  workflow_dispatch:
+  pull_request:
+    types:
+      - closed
+    paths:
+      - 'Project.toml'
+    branches:
+      - 'master'
+      - 'main'
+jobs:
+  Register:
+    if: github.event_name == 'workflow_dispatch' || github.event.pull_request.merged == true
+    uses: "ITensor/ITensorActions/.github/workflows/Registrator.yml@main"
+    with:
+      localregistry: ITensor/ITensorRegistry

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2024 ITensor developers
+Copyright (c) 2025 ITensor developers
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

Project.toml

@@ -11,6 +11,7 @@ Dictionaries = "85a47980-9c8c-11e8-2b9f-f7ca1fa99fb4"
 FillArrays = "1a297f60-69ca-5386-bcde-b61e274b549b"
 LinearAlgebra = "37e2e46d-f89d-539d-b4ee-838fcccc9c8e"
 MapBroadcast = "ebd9b9da-f48d-417c-9660-449667d60261"
+Random = "9a3f8284-a2c9-5f02-9a11-845980a1fd5c"
 
 [compat]
 Accessors = "0.1.41"
@@ -21,6 +22,7 @@ Dictionaries = "0.4.3"
 FillArrays = "1.13.0"
 LinearAlgebra = "1.10"
 MapBroadcast = "0.1.5"
+Random = "1.10.0"
 SafeTestsets = "0.1"
 Suppressor = "0.2"
 Test = "1.10"

README.md

@@ -48,7 +48,7 @@ using SparseArraysBase:
   zero!
 using Test: @test, @test_throws
 
-a = SparseArrayDOK{Float64}(2, 2)
+a = SparseArrayDOK{Float64}(undef, 2, 2)
 ````
 
 AbstractArray interface:
@@ -122,32 +122,32 @@ b = a[1:2, 2]
 @test b == [12, 0]
 @test storedlength(b) == 1
 
-a = SparseArrayDOK{Float64}(2, 2)
+a = SparseArrayDOK{Float64}(undef, 2, 2)
 a .= 2
 for I in eachindex(a)
   @test a[I] == 2
 end
 @test storedlength(a) == length(a)
 
-a = SparseArrayDOK{Float64}(2, 2)
+a = SparseArrayDOK{Float64}(undef, 2, 2)
 fill!(a, 2)
 for I in eachindex(a)
   @test a[I] == 2
 end
 @test storedlength(a) == length(a)
 
-a = SparseArrayDOK{Float64}(2, 2)
+a = SparseArrayDOK{Float64}(undef, 2, 2)
 fill!(a, 0)
 @test iszero(a)
 @test iszero(storedlength(a))
 
-a = SparseArrayDOK{Float64}(2, 2)
+a = SparseArrayDOK{Float64}(undef, 2, 2)
 a[1, 2] = 12
 zero!(a)
 @test iszero(a)
 @test iszero(storedlength(a))
 
-a = SparseArrayDOK{Float64}(2, 2)
+a = SparseArrayDOK{Float64}(undef, 2, 2)
 a[1, 2] = 12
 b = zero(a)
 @test iszero(b)

docs/make.jl

@@ -16,7 +16,7 @@ makedocs(;
     edit_link="main",
     assets=String[],
   ),
-  pages=["Home" => "index.md"],
+  pages=["Home" => "index.md", "Reference" => "reference.md"],
 )
 
 deploydocs(;

docs/src/reference.md

@@ -0,0 +1,5 @@
+# Reference
+
+```@autodocs
+Modules = [SparseArraysBase]
+```

examples/README.jl

@@ -53,7 +53,7 @@ using SparseArraysBase:
   zero!
 using Test: @test, @test_throws
 
-a = SparseArrayDOK{Float64}(2, 2)
+a = SparseArrayDOK{Float64}(undef, 2, 2)
 
 # AbstractArray interface:
 
@@ -118,32 +118,32 @@ b = a[1:2, 2]
 @test b == [12, 0]
 @test storedlength(b) == 1
 
-a = SparseArrayDOK{Float64}(2, 2)
+a = SparseArrayDOK{Float64}(undef, 2, 2)
 a .= 2
 for I in eachindex(a)
   @test a[I] == 2
 end
 @test storedlength(a) == length(a)
 
-a = SparseArrayDOK{Float64}(2, 2)
+a = SparseArrayDOK{Float64}(undef, 2, 2)
 fill!(a, 2)
 for I in eachindex(a)
   @test a[I] == 2
 end
 @test storedlength(a) == length(a)
 
-a = SparseArrayDOK{Float64}(2, 2)
+a = SparseArrayDOK{Float64}(undef, 2, 2)
 fill!(a, 0)
 @test iszero(a)
 @test iszero(storedlength(a))
 
-a = SparseArrayDOK{Float64}(2, 2)
+a = SparseArrayDOK{Float64}(undef, 2, 2)
 a[1, 2] = 12
 zero!(a)
 @test iszero(a)
 @test iszero(storedlength(a))
 
-a = SparseArrayDOK{Float64}(2, 2)
+a = SparseArrayDOK{Float64}(undef, 2, 2)
 a[1, 2] = 12
 b = zero(a)
 @test iszero(b)

src/abstractsparsearray.jl

@@ -50,3 +50,62 @@ function Base.replace_in_print_matrix(
 )
   return isstored(A, CartesianIndex(i, j)) ? s : Base.replace_with_centered_mark(s)
 end
+
+# Special-purpose constructors
+# ----------------------------
+using Random: Random, AbstractRNG, default_rng
+@doc """
+    spzeros([T::Type], dims) -> A::SparseArrayDOK{T}
+
+Create an empty size `dims` sparse array.
+The optional `T` argument specifies the element type, which defaults to `Float64`.
+""" spzeros
+
+spzeros(dims::Dims) = spzeros(Float64, dims)
+spzeros(::Type{T}, dims::Dims) where {T} = SparseArrayDOK{T}(undef, dims)
+
+@doc """
+    sprand([rng], [T::Type], dims; density::Real=0.5, rfn::Function=rand) -> A::SparseArrayDOK{T}
+
+Create a random size `dims` sparse array in which the probability of any element being stored is independently given by `density`.
+The optional `rng` argument specifies a random number generator, see also `Random`.
+The optional `T` argument specifies the element type, which defaults to `Float64`.
+The optional `rfn` argument can be used to control the type of random elements.
+
+See also [`sprand!`](@ref).
+""" sprand
+
+function sprand(::Type{T}, dims::Dims; kwargs...) where {T}
+  return sprand(default_rng(), T, dims; kwargs...)
+end
+sprand(dims::Dims; kwargs...) = sprand(default_rng(), Float64, dims; kwargs...)
+function sprand(rng::AbstractRNG, dims::Dims; kwargs...)
+  return sprand(rng, Float64, dims; kwargs...)
+end
+function sprand(rng::AbstractRNG, ::Type{T}, dims::Dims; kwargs...) where {T}
+  A = SparseArrayDOK{T}(undef, dims)
+  sprand!(rng, A; kwargs...)
+  return A
+end
+
+@doc """
+    sprand!([rng], A::AbstractArray; density::Real=0.5, rfn::Function=rand) -> A
+
+Overwrite part of an array with random entries, where the probability of overwriting is independently given by `density`.
+The optional `rng` argument specifies a random number generator, see also `Random`.
+The optional `rfn` argument can be used to control the type of random elements.
+
+See also [`sprand`](@ref).
+""" sprand!
+
+sprand!(A::AbstractArray; kwargs...) = sprand!(default_rng(), A; kwargs...)
+function sprand!(
+  rng::AbstractRNG, A::AbstractArray; density::Real=0.5, rfn::Function=Random.rand
+)
+  ArrayLayouts.zero!(A)
+  rand_inds = Random.randsubseq(rng, eachindex(A), density)
+  rand_entries = rfn(rng, eltype(A), length(rand_inds))
+  for (I, v) in zip(rand_inds, rand_entries)
+    A[I] = v
+  end
+end

src/sparsearraydok.jl

@@ -1,44 +1,69 @@
 using Accessors: @set
-using Dictionaries: Dictionary, IndexError, set!
+using Dictionaries: AbstractDictionary, Dictionary, IndexError, set!
 
 function default_getunstoredindex(a::AbstractArray, I::Int...)
   return zero(eltype(a))
 end
 
+const DOKStorage{T,N} = Dictionary{CartesianIndex{N},T}
+
 struct SparseArrayDOK{T,N,F} <: AbstractSparseArray{T,N}
-  storage::Dictionary{CartesianIndex{N},T}
+  storage::DOKStorage{T,N}
   size::NTuple{N,Int}
   getunstoredindex::F
-end
 
-function set_getunstoredindex(a::SparseArrayDOK, f)
-  @set a.getunstoredindex = f
-  return a
-end
-
-using DerivableInterfaces: DerivableInterfaces
-# This defines the destination type of various operations in DerivableInterfaces.jl.
+  # bare constructor
+  function SparseArrayDOK{T,N,F}(
+    ::UndefInitializer, size::Dims{N}, getunstoredindex::F
+  ) where {T,N,F}
+    storage = DOKStorage{T,N}()
+    return new{T,N,F}(storage, size, getunstoredindex)
+  end
 
-Base.similar(::AbstractSparseArrayInterface, T::Type, ax) = SparseArrayDOK{T}(undef, ax)
+  # unchecked constructor from data
+  function SparseArrayDOK{T,N,F}(
+    storage::DOKStorage{T,N}, size::Dims{N}, getunstoredindex::F
+  ) where {T,N,F}
+    return new{T,N,F}(storage, size, getunstoredindex)
+  end
+end
 
-function SparseArrayDOK{T,N}(size::Vararg{Int,N}) where {T,N}
-  getunstoredindex = default_getunstoredindex
+# undef constructors
+function SparseArrayDOK{T}(
+  ::UndefInitializer, dims::Dims, getunstoredindex=default_getunstoredindex
+) where {T}
+  all(≥(0), dims) || throw(ArgumentError("Invalid dimensions: $dims"))
+  N = length(dims)
   F = typeof(getunstoredindex)
-  return SparseArrayDOK{T,N,F}(Dictionary{CartesianIndex{N},T}(), size, getunstoredindex)
+  return SparseArrayDOK{T,N,F}(undef, dims, getunstoredindex)
 end
-
-function SparseArrayDOK{T}(::UndefInitializer, size::Tuple{Vararg{Int}}) where {T}
-  return SparseArrayDOK{T,length(size)}(size...)
+function SparseArrayDOK{T}(::UndefInitializer, dims::Int...) where {T}
+  return SparseArrayDOK{T}(undef, dims)
 end
 
-function SparseArrayDOK{T}(size::Int...) where {T}
-  return SparseArrayDOK{T,length(size)}(size...)
+# checked constructor from data: use `setindex!` to validate input
+# does not take ownership of `storage`!
+function SparseArrayDOK(
+  storage::Union{AbstractDictionary{I,T},AbstractDict{I,T}}, dims::Dims{N}, unstored...
+) where {N,I<:Union{Int,CartesianIndex{N}},T}
+  A = SparseArrayDOK{T}(undef, dims, unstored...)
+  for (i, v) in pairs(storage)
+    A[i] = v
+  end
+  return A
 end
 
 function SparseArrayDOK{T}(::UndefInitializer, axes::Tuple) where {T}
   return SparseArrayDOK{T}(undef, Base.to_shape(axes))
 end
 
+function set_getunstoredindex(a::SparseArrayDOK, f)
+  @set a.getunstoredindex = f
+  return a
+end
+
+Base.similar(::AbstractSparseArrayInterface, T::Type, ax) = SparseArrayDOK{T}(undef, ax)
+
 using DerivableInterfaces: @array_aliases
 # Define `SparseMatrixDOK`, `AnySparseArrayDOK`, etc.
 @array_aliases SparseArrayDOK

test/runtests.jl

@@ -24,9 +24,11 @@ isexamplefile(fn) =
   # tests in groups based on folder structure
   for testgroup in filter(isdir, readdir(@__DIR__))
     if GROUP == "ALL" || GROUP == uppercase(testgroup)
-      for file in filter(istestfile, readdir(joinpath(@__DIR__, testgroup); join=true))
+      groupdir = joinpath(@__DIR__, testgroup)
+      for file in filter(istestfile, readdir(groupdir))
+        filename = joinpath(groupdir, file)
         @eval @safetestset $file begin
-          include($file)
+          include($filename)
         end
       end
     end

test/test_linalg.jl

@@ -5,17 +5,6 @@ using StableRNGs: StableRNG
 
 const rng = StableRNG(123)
 
-# TODO: add this to main package
-function sprand(rng::Random.AbstractRNG, ::Type{T}, sz::Base.Dims; p::Real=0.5) where {T}
-  A = SparseArrayDOK{T}(undef, sz)
-  for I in eachindex(A)
-    if rand(rng) < p
-      A[I] = rand(rng, T)
-    end
-  end
-  return A
-end
-
 @testset "mul!" begin
   T = Float64
   szA = (2, 2)
@@ -31,7 +20,7 @@ end
     @test mul!(copy(C), A, B) ≈ check1
 
     α = rand(rng, T)
-    β = rand(rng, T)
+    β = rand(rng, T) * false
     check2 = mul!(Array(C), Array(A), Array(B), α, β)
     @test mul!(copy(C), A, B, α, β) ≈ check2
   end