dummy-link

Readme

+TITLE: BlockMaps.jl

+AUTHOR: Stefanos Carlström

+EMAIL: stefanos.carlstrom@gmail.com

[[https://travis-ci.org/jagot/BlockMaps.jl][https://travis-ci.org/jagot/BlockMaps.jl.svg?branch=master]] [[https://coveralls.io/github/jagot/BlockMaps.jl?branch=master][https://coveralls.io/repos/jagot/BlockMaps.jl/badge.svg?branch=master&service=github]] [[https://codecov.io/github/jagot/BlockMaps.jl?branch=master][https://codecov.io/github/jagot/BlockMaps.jl/coverage.svg?branch=master]]

+PROPERTY: header-args:julia :session julia-README

A simple application of [[https://github.com/Jutho/LinearMaps.jl][LinearMaps.jl]] to block matrices, i.e. matrices which are mostly sparse, but have non-zero blocks which are mostly dense.

  • Usage #+BEGIN_SRC julia :exports code using BlockMaps #+END_SRC

#+RESULTS: : nothing

#+BEGIN_SRC julia :exports none using PyPlot using Jagot.plotting plot_style("ggplot") #+END_SRC

#+RESULTS: : nothing

To construct the block matrix, simply create an empty =BlockMap= and assign dense blocks to the desired locations: #+BEGIN_SRC julia :exports both :results verbatim B = BlockMaps.BlockMap(Float64, 10, 10) a = Float64[-1 2; 2 1] b = Float64[-1 2 3; 2 1 -4] B[1,1] = a B[1,3] = a B[1,9] = a B[4,6] = b B[6,8] = b B[9,9] = a B #+END_SRC

#+RESULTS:

Hinton plot of the resultant matrix: #+BEGIN_SRC julia :exports results :results file figure("matrix") clf() hinton_plot_matrix(full(B)) tight_layout() savefig("figures/matrix.svg") "figures/matrix.svg" #+END_SRC

#+RESULTS: [[file:figures/matrix.svg]]

If the matrix is specified to be symmetric/Hermitian, the block (complex conjugated) transposes will be handled automatically: #+BEGIN_SRC julia :exports both :results verbatim B = BlockMaps.BlockMap(Float64, 10, 10, issymmetric=true) a = Float64[-1 2; 2 1] b = Float64[-1 2 3; 2 1 -4] B[1,1] = a B[1,3] = a B[1,9] = a B[4,6] = b B[6,8] = b B[9,9] = a B #+END_SRC

#+RESULTS: : BlockMaps.BlockMap{Float64}(10, 10, BlockMaps.Block{Float64}[2x2 Float64 block at (1,1), 2x2 Float64 block at (1,3), 2x2 Float64 block at (1,9), 2x3 Float64 block at (4,6), 2x3 Float64 block at (6,8), 2x2 Float64 block at (9,9)], true, true, false, false, 2.220446049250313e-16)

#+BEGIN_SRC julia :exports results :results file figure("symmetric matrix") clf() hinton_plot_matrix(full(B)) tight_layout() savefig("figures/symmetric-matrix.svg") "figures/symmetric-matrix.svg" #+END_SRC

#+RESULTS: [[file:figures/symmetric-matrix.svg]]

** Overlapping blocks Normally, we do not want the blocks to overlap, since then the same “logical” matrix elements would be referenced more than once. However, there are applications (such as FEM Laplacians), where the matrices are almost block diagonal, with one matrix element overlapping between subsequent blocks. This can be accommodated the as follows.

We first define a nice test matrix:

#+BEGIN_SRC julia :exports both function matrix(fun::Function, m, n) M = zeros((m,n)) for i = 1:m for j = 1:m M[i,j] = fun(i,j) end end M end

 a = matrix(5,5) do i,j
     2i*j - 16
 end

#+END_SRC

#+RESULTS: | -14 | -12 | -10 | -8 | -6 | | -12 | -8 | -4 | 0 | 4 | | -10 | -4 | 2 | 8 | 14 | | -8 | 0 | 8 | 16 | 24 | | -6 | 4 | 14 | 24 | 34 |

Trying to create a =BlockMap= with overlapping blocks will result in an error: #+BEGIN_SRC julia :exports both :results verbatim B = BlockMaps.BlockMap(Float64, 9, 9) B[1,1] = a try B[5,5] = a[end:-1:1,end:-1:1] catch e e end #+END_SRC

#+RESULTS: : ErrorException("Cannot insert new 5x5 Float64 block at (5,5) overlapping with old block at 5x5 Float64 block at (1,1)")

If however we state that we wish overlapping regions of previous blocks to be cleared, it works:

#+BEGIN_SRC julia :exports code B = BlockMaps.BlockMap(Float64, 9, 9, clear_overlaps=true) B[1,1] = a B[5,5] = a[end:-1:1,end:-1:1] #+END_SRC

#+RESULTS: | 34 | 24 | 14 | 4 | -6 | | 24 | 16 | 8 | 0 | -8 | | 14 | 8 | 2 | -4 | -10 | | 4 | 0 | -4 | -8 | -12 | | -6 | -8 | -10 | -12 | -14 |

#+BEGIN_SRC julia :exports results :results file figure("overlapping matrix") clf() hinton_plot_matrix(full(B)) tight_layout() savefig("figures/overlapping-matrix.svg") "figures/overlapping-matrix.svg" #+END_SRC

#+RESULTS: [[file:figures/overlapping-matrix.svg]]

Note, however, that the overlapping blocks must agree to within a certain tolerance:

#+BEGIN_SRC julia :exports both :results verbatim B = BlockMaps.BlockMap(Float64, 9, 9, clear_overlaps=true) B[1,1] = a try B[4,4] = a catch e e end #+END_SRC

#+RESULTS: : ErrorException("Overlapping regions of 5x5 Float64 block at (4,4) and 5x5 Float64 block at (1,1) differ by 59.632206063502295 > 2.220446049250313e-16")

  • Known issues
    • [ ] The blocks are processed in the order they where assigned, possibly leading to suboptimal performance. Maybe a =sort!(A::BlockMap)= operation should be implemented.
    • [ ] Parallelization?

First Commit

01/02/2018

Last Touched

11 months ago

Commits

18 commits