-
Notifications
You must be signed in to change notification settings - Fork 123
/
cache.jl
213 lines (177 loc) · 6.29 KB
/
cache.jl
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
export CacheFragment, CachedBlock, update_cache
export cache, pull, update!, update_cache, clearall!, iscached, iscacheable
"""
CacheFragment{BT, K, MT}
A fragment that will be stored for each cached block (of type `BT`) on a cache server.
"""
struct CacheFragment{BT,K,MT}
ref::BT
storage::Dict{K,MT}
function CacheFragment{BT,K,MT}(x::BT) where {BT,K,MT}
new{BT,K,MT}(x, Dict{K,MT}())
end
function CacheFragment{BT,K}(x::BT) where {BT} where {K}
new{BT,K,cache_type(BT)}(x, Dict{K,cache_type(BT)}())
end
function CacheFragment(x::BT) where {BT}
CacheFragment{BT,typeof(cache_key(x))}(x)
end
end
# default update rule
function CacheServers.update!(frag::CacheFragment, val)
if !iscached(frag)
frag.storage[cache_key(frag.ref)] = val
end
frag
end
CacheServers.iscached(frag::CacheFragment) = cache_key(frag.ref) in keys(frag.storage)
CacheServers.pull(frag::CacheFragment) = frag.storage[cache_key(frag.ref)]
CacheServers.clear!(frag::CacheFragment) = (empty!(frag.storage); frag)
"""
CachedBlock{ST, BT, D} <: TagBlock{BT, D}
A label type that tags an instance of type `BT`. It forwards
every methods of the block it contains, except [`mat`](@ref)
and [`apply!`](@ref), it will cache the matrix form whenever
the program has.
"""
struct CachedBlock{ST,BT,D} <: TagBlock{BT,D}
server::ST
content::BT
level::Int
function CachedBlock(server::ST, x::BT, level::Int) where {ST,D,BT<:AbstractBlock{D}}
alloc!(server, x, CacheFragment(x))
new{ST,BT,D}(server, x, level)
end
end
CacheServers.iscached(c::CachedBlock) = iscached(c.server, c.content)
iscacheable(c::CachedBlock) = iscacheable(c.server, c.content)
chsubblocks(cb::CachedBlock, blk::AbstractBlock) = CachedBlock(cb.server, blk, cb.level)
occupied_locs(x::CachedBlock) = occupied_locs(content(x))
PropertyTrait(::CachedBlock) = PreserveAll()
function update_cache(::Type{T}, c::CachedBlock) where {T}
if !iscached(c.server, c.content)
m = mat(T, c.content)
push!(c.server, m, c.content)
end
return c
end
CacheServers.clear!(x::AbstractBlock) = x
CacheServers.clear!(c::CachedBlock) = (clear!(c.server, c.content); c)
function mat(::Type{T}, c::CachedBlock) where {T}
if !iscached(c.server, c.content)
m = mat(T, c.content)
push!(c.server, m, c.content)
return m
end
return pull(c)
end
function CacheServers.pull(c::CachedBlock)
return pull(c.server, c.content)
end
YaoAPI.unsafe_apply!(r::AbstractRegister, c::CachedBlock) = YaoAPI.unsafe_apply!(r, c.content)
YaoAPI.unsafe_apply!(r::AbstractArrayReg{D,T}, c::CachedBlock) where {D,T} = (r.state .= mat(T, c) * r.state; r)
YaoAPI.unsafe_apply!(r::DensityMatrix{D,T}, c::CachedBlock) where {D,T} = (m = mat(T, c); r.state .= m * r.state * m'; r)
Base.similar(c::CachedBlock, level::Int) = CachedBlock(c.server, c.content, level)
Base.copy(c::CachedBlock) = CachedBlock(c.server, copy(c.content), c.level)
Base.length(x::CachedBlock) = length(content(x))
Base.getindex(c::CachedBlock, index...) = getindex(content(c), index...)
Base.setindex!(c::CachedBlock, val, index...) = setindex!(content(c), val, index...)
Base.iterate(c::CachedBlock) = iterate(content(c))
Base.iterate(c::CachedBlock, st) = iterate(content(c), st)
Base.eltype(x::CachedBlock) = eltype(content(x))
const DefaultCacheServer = get_server(AbstractBlock, CacheFragment)
cache(x::Function, level::Int = 1; recursive = false) =
n -> cache(x(n), level; recursive = recursive)
"""
cache(x[, level=1; recursive=false])
Create a [`CachedBlock`](@ref) with given block `x`, which will cache the matrix of `x` for the first time
it calls [`mat`](@ref), and use the cached matrix in the following calculations.
### Examples
```jldoctest; setup=:(using YaoBlocks)
julia> cache(control(3, 1, 2=>X))
nqubits: 3
[cached] control(1)
└─ (2,) X
julia> chain(cache(control(3, 1, 2=>X)), repeat(H))
nqubits: 3
chain
└─ [cached] control(1)
└─ (2,) X
```
"""
function cache(x::AbstractBlock, level::Int = 1; recursive = false)
return cache(DefaultCacheServer, x, level, recursive = recursive)
end
function clearall!(x::CachedBlock)
return clear!(x)
end
function clearall!(x::CachedBlock{ST,BT}) where {ST,BT<:CompositeBlock}
for each in subblocks(x.content)
clearall!(each)
end
clear!(x)
return x
end
function cache(
server::AbstractCacheServer,
x::AbstractBlock,
level::Int;
recursive::Bool = false,
)
return CachedBlock(server, x, level)
end
function cache(
server::AbstractCacheServer,
x::ChainBlock,
level::Int;
recursive::Bool = false,
)
if recursive
chain = similar(x)
for (i, each) in enumerate(block)
chain[i] = cache(server, each, level, recursive)
end
else
chain = x
end
return CachedBlock(server, chain, level)
end
function cache(
server::AbstractCacheServer,
block::KronBlock,
level::Int;
recursive::Bool = false,
)
if recursive
x = similar(block)
for (k, v) in block
x[k] = cache(server, v, level, recursive = recursive)
end
else
x = block
end
return CachedBlock(server, x, level)
end
function unsafe_getindex(::Type{T}, c::CachedBlock, i::Integer, j::Integer) where T
@inbounds mat(T, c)[i+1, j+1]
end
function unsafe_getcol(::Type{T}, c::CachedBlock, j::DitStr) where {T}
@inbounds getcol(mat(T, c), j)
end
function Base.getindex(b::CachedBlock{ST, BT, D}, i::DitStr{D,N}, j::DitStr{D,N}) where {ST,BT,D,N}
invoke(Base.getindex, Tuple{AbstractBlock{D}, DitStr{D,N}, DitStr{D,N}} where {D,N}, b, i, j)
end
function Base.getindex(b::CachedBlock{ST, BT, D}, ::Colon, j::DitStr{D,N}) where {D,N,ST,BT}
T = promote_type(ComplexF64, parameters_eltype(b))
return cleanup(_getindex(T, b, :, j))
end
function Base.getindex(b::CachedBlock{ST, BT, D}, i::DitStr{D,N}, ::Colon) where {D,N,ST,BT}
T = promote_type(ComplexF64, parameters_eltype(b))
return cleanup(_getindex(T, b, i, :))
end
function Base.getindex(b::CachedBlock{ST, BT, D}, ::Colon, j::EntryTable{DitStr{D,N,TI},T}) where {D,N,TI,T,ST,BT}
return cleanup(_getindex(b, :, j))
end
function Base.getindex(b::CachedBlock{ST, BT, D}, i::EntryTable{DitStr{D,N,TI},T}, ::Colon) where {D,N,TI,T,ST,BT}
return cleanup(_getindex(b, i, :))
end