Skip to content

Commit 2b1a0c1

Browse files
authored
Update README.md
1 parent 536d63f commit 2b1a0c1

File tree

1 file changed

+7
-4
lines changed

1 file changed

+7
-4
lines changed

README.md

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,20 @@
11
# BlockArrays.jl
22

3-
[![Build Status](https://travis-ci.org/KristofferC/BlockArrays.jl.svg?branch=master)](https://travis-ci.org/KristofferC/BlockArrays.jl) [![codecov](https://codecov.io/gh/KristofferC/BlockArrays.jl/branch/master/graph/badge.svg)](https://codecov.io/gh/KristofferC/BlockArrays.jl)
3+
[![Build Status](https://travis-ci.org/KristofferC/BlockArrays.jl.svg?branch=master)](https://travis-ci.org/KristofferC/BlockArrays.jl) [![codecov](https://codecov.io/gh/KristofferC/BlockArrays.jl/branch/master/graph/badge.svg)](https://codecov.io/gh/KristofferC/BlockArrays.jl) [![](https://img.shields.io/badge/docs-stable-blue.svg)](https://KristofferC.github.io/BlockArrays.jl/stable) [![](https://img.shields.io/badge/docs-latest-blue.svg)](https://KristofferC.github.io/BlockArrays.jl/latest)
4+
45

56
A block array is a partition of an array into blocks or subarrays, see [wikipedia](https://en.wikipedia.org/wiki/Block_matrix) for a more extensive description. This package has two purposes. Firstly, it defines an interface for an `AbstractBlockArray` block arrays that can be shared among types representing different types of block arrays. The advantage to this is that it provides a consistent API for block arrays.
67

78
Secondly, it also implements two different type of block arrays that follow the `AbstractBlockArray` interface. The type `BlockArray` stores each block contiguously while the type `PseudoBlockArray` stores the full matrix contiguously. This means that `BlockArray` supports fast non copying extraction and insertion of blocks while `PseudoBlockArray` supports fast access to the full matrix to use in in for example a linear solver.
89

910
## Documentation
1011

11-
Documentation is built automatically with help from MkDocs on Travis CI and hosted by GitHub Pages.
12-
13-
[![](https://img.shields.io/badge/docs-stable-blue.svg)](https://KristofferC.github.io/BlockArrays.jl/stable) [![](https://img.shields.io/badge/docs-latest-blue.svg)](https://KristofferC.github.io/BlockArrays.jl/latest)
12+
- [**STABLE**][docs-stable-url] — **most recently tagged version of the documentation.**
13+
- [**LATEST**][docs-latest-url] — *in-development version of the documentation.*
1414

1515
## Author
1616

1717
Kristoffer Carlsson - [@KristofferC](https://github.com/KristofferC)
18+
19+
[docs-latest-url]: https://kristofferc.github.io/BlockArrays.jl/latest/
20+
[docs-stable-url]: https://kristofferc.github.io/BlockArrays.jl/stable

0 commit comments

Comments
 (0)