Skip to content

Commit eba1513

Browse files
committed
Update readme
1 parent 2f500f4 commit eba1513

File tree

1 file changed

+17
-10
lines changed

1 file changed

+17
-10
lines changed

README.md

Lines changed: 17 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -4,32 +4,31 @@
44
[![codecov.io](http://codecov.io/github/JeffFessler/LinearMapsAA.jl/coverage.svg?branch=master)](http://codecov.io/github/JeffFessler/LinearMapsAA.jl?branch=master)
55
https://github.com/JeffFessler/LinearMapsAA.jl
66

7-
UNDER CONSTRUCTION!
8-
97
This package is an overlay for the
108
[`LinearMaps.jl`](https://github.com/Jutho/LinearMaps.jl)
119
package
1210
that allows one to represent linear operations
1311
(like the FFT)
1412
as a object that appears to the user like a matrix
15-
but internally uses fast computations
13+
but internally uses user-defined fast computations
1614
for operations, especially multiplication.
1715

18-
The extra `AA` in the package name has two meanings.
16+
The extra `AA` in the package name here has two meanings.
1917

2018
- Objects of type `LinearMapAA` are subtypes of `AbstractArray{T,2}`, i.e.,
2119
[conform to the requirements of an `AbstractMatrix`](https://docs.julialang.org/en/latest/manual/interfaces/#man-interface-array-1)
20+
type.
2221

2322
- The package was developed in Ann Arbor, Michigan :)
2423

2524
Any `AbstractArray`
2625
must support a `getindex` operation.
2726
The maintainers of the `LinearMaps.jl` package
28-
[do not wish to add getindex there](https://github.com/Jutho/LinearMaps.jl/issues/38)
27+
[have not wished to add getindex there](https://github.com/Jutho/LinearMaps.jl/issues/38),
2928
so this package adds that feature
3029
(without committing "type piracy").
3130

32-
A bonus feature supported by `LinearMapsAA`
31+
A bonus feature provided by `LinearMapsAA`
3332
is that a user can include a `NamedTuple` of properties
3433
with it, and then retrieve those later
3534
using the `A.key` syntax like one would do with a struct (composite type).
@@ -43,8 +42,9 @@ a wavelet transform arises
4342
from some mother wavelet,
4443
and it can be convenient
4544
to carry those properties with the object itself.
46-
The properties are lost when one combines
47-
two `LinearMapAA` objects by adding, multiplying, concatenating, etc.
45+
Currently
46+
the properties are lost when one combines
47+
two or more `LinearMapAA` objects by adding, multiplying, concatenating, etc.
4848

4949

5050
## Examples
@@ -89,10 +89,11 @@ This software was developed at the
8989
by
9090
[Jeff Fessler](http://web.eecs.umich.edu/~fessler)
9191
and his
92-
[group](http://web.eecs.umich.edu/~fessler/group).
92+
[group](http://web.eecs.umich.edu/~fessler/group),
93+
with substantial inspiration drawn
94+
from the `LinearMaps` package.
9395

9496

95-
todo:
9697
This package is included in the
9798
Michigan Image Reconstruction Toolbox (MIRT.jl)
9899
and is exported there
@@ -105,6 +106,12 @@ such as using the nice
105106
[Kronecker.jl](https://github.com/MichielStock/Kronecker.jl)
106107
package.
107108

109+
This package provides similar functionality
110+
as the `Fatrix` / `fatrix` object in the
111+
[Matlab version of MIRT](https://github.com/JeffFessler/mirt).
112+
113+
## Getting started
114+
108115
For detailed installation instructions, see:
109116
[doc/start.md](https://github.com/JeffFessler/MIRT.jl/blob/master/doc/start.md)
110117

0 commit comments

Comments
 (0)