Skip to content

Commit

Permalink
update readme to include circulant (#39)
Browse files Browse the repository at this point in the history
  • Loading branch information
JeffFessler authored and dlfivefifty committed Oct 29, 2018
1 parent 7edd357 commit cbe29c3
Showing 1 changed file with 22 additions and 0 deletions.
22 changes: 22 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -72,3 +72,25 @@ where uplo is either `:L` or `:U` and `ve` are the rows or columns, respectively
2.0 3.0 4.0
3.0 4.0 5.0 ]
```


# Circulant

A circulant matrix is a special case of a Toeplitz matrix with periodic end conditions.
It can be constructed using

```julia
Circulant(vc)
```
where `vc` is a vector with the entries for the first column.
For example:
```julia
Circulant(1:3)
```
is a sparse representation of the matrix

```julia
[ 1.0 3.0 2.0
2.0 1.0 3.0
3.0 2.0 1.0 ]
```

0 comments on commit cbe29c3

Please sign in to comment.