Skip to content

Commit

Permalink
docs(docs): add section in getting started
Browse files Browse the repository at this point in the history
  • Loading branch information
AnzhiZhang committed Aug 5, 2024
1 parent f9e400f commit 9e077c9
Showing 1 changed file with 34 additions and 0 deletions.
34 changes: 34 additions & 0 deletions docs/src/manual/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -87,3 +87,37 @@ remove_from_group(Hilbert, :test)
remove_from_all_groups(Matrix)
list_groups()
```

## Finding Matrices

[`list_matrices`](@ref) is very powerful to list matrices, and filter by groups and properties. All arguments are "and" relationship, i.e. listed matrices must satisfy all conditions.

For example, to list all matrices in the `builtin` group, and all matrices with `symmetric` property:

```@repl getting-started
list_matrices(Group(:builtin))
list_matrices(Property(:symmetric))
```

To list all matrices in the `builtin` group with `inverse`, `illcond`, and `eigen` properties:

```@repl getting-started
list_matrices(
[
Group(:builtin),
],
[
Property(:inverse),
Property(:illcond),
Property(:eigen),
]
)
```

To list all matrices with `symmetric`, `eigen`, and `posdef` properties:

```@repl getting-started
list_matrices(:symmetric, :eigen, :posdef)
```

There are many alternative interfaces using `list_matrices`, please check the [`list_matrices`](@ref) or use Julia help system for more information.

0 comments on commit 9e077c9

Please sign in to comment.