Skip to content

update README #121

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Nov 13, 2019
Merged

update README #121

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 6 additions & 7 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,12 +16,13 @@ Operators behave like matrices (with some exceptions - see below) but are define

## Compatibility

Julia 0.6 and up.
Julia 1.0 and up.

## How to Install

````JULIA
Pkg.add("LinearOperators")
pkg> add LinearOperators
pkg> test LinearOperators
````

## How to use
Expand All @@ -34,6 +35,8 @@ Check the
Operator | Description
-----------------------|------------
`LinearOperator` | Base class. Useful to define operators from functions
`PreallocatedLinearOperator` | Linear operator with preallocated storage for products
`TimedLinearOperator` | Linear operator instrumented with timers from [`TimerOutputs`](https://github.com/KristofferC/TimerOutputs.jl)
`opEye` | Identity operator
`opOnes` | All ones operator
`opZeros` | All zeros operator
Expand Down Expand Up @@ -101,14 +104,10 @@ full(opA[:,1]) # nx1 matrix

## Other Operators

* [LLDL](https://github.com/optimizers/lldl) features a limited-memory
* [LimitedLDLFactorizations](https://github.com/JuliaSmoothOptimizers/LimitedLDLFactorizations.jl) features a limited-memory
LDL<sup>T</sup> factorization operator that may be used as preconditioner
in iterative methods
* [MUMPS.jl](https://github.com/JuliaSmoothOptimizers/MUMPS.jl) features a full
distributed-memory factorization operator that may be used to represent the
preconditioner in, e.g., constraint-preconditioned Krylov methods.

## Testing

````JULIA
julia> Pkg.test("LinearOperators")