Skip to content

Commit 9e077c9

Browse files
committed
docs(docs): add section in getting started
1 parent f9e400f commit 9e077c9

File tree

1 file changed

+34
-0
lines changed

1 file changed

+34
-0
lines changed

Diff for: docs/src/manual/getting-started.md

+34
Original file line numberDiff line numberDiff line change
@@ -87,3 +87,37 @@ remove_from_group(Hilbert, :test)
8787
remove_from_all_groups(Matrix)
8888
list_groups()
8989
```
90+
91+
## Finding Matrices
92+
93+
[`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.
94+
95+
For example, to list all matrices in the `builtin` group, and all matrices with `symmetric` property:
96+
97+
```@repl getting-started
98+
list_matrices(Group(:builtin))
99+
list_matrices(Property(:symmetric))
100+
```
101+
102+
To list all matrices in the `builtin` group with `inverse`, `illcond`, and `eigen` properties:
103+
104+
```@repl getting-started
105+
list_matrices(
106+
[
107+
Group(:builtin),
108+
],
109+
[
110+
Property(:inverse),
111+
Property(:illcond),
112+
Property(:eigen),
113+
]
114+
)
115+
```
116+
117+
To list all matrices with `symmetric`, `eigen`, and `posdef` properties:
118+
119+
```@repl getting-started
120+
list_matrices(:symmetric, :eigen, :posdef)
121+
```
122+
123+
There are many alternative interfaces using `list_matrices`, please check the [`list_matrices`](@ref) or use Julia help system for more information.

0 commit comments

Comments
 (0)