Skip to content

Commit 3a9f7a6

Browse files
committed
update docs
1 parent 9f53f09 commit 3a9f7a6

File tree

2 files changed

+11
-11
lines changed

2 files changed

+11
-11
lines changed

docs/src/ref.md

Lines changed: 6 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -61,6 +61,10 @@ ConfigsMin
6161
```
6262

6363
## Element Algebras
64+
```@docs
65+
is_commutative_semiring
66+
```
67+
6468
```@docs
6569
TropicalNumbers.Tropical
6670
TropicalNumbers.CountingTropical
@@ -80,7 +84,6 @@ save_configs
8084
load_configs
8185
@bv_str
8286
onehotv
83-
is_commutative_semiring
8487
```
8588

8689
## Tensor Network
@@ -116,13 +119,8 @@ random_square_lattice_graph
116119

117120
One can also use `random_regular_graph` and `smallgraph` in [Graphs](https://github.com/JuliaGraphs/Graphs.jl) to build special graphs.
118121

119-
#### Lower level APIs
122+
#### Shortcuts
120123
```@docs
121-
best_solutions
122-
best2_solutions
123-
solutions
124-
all_solutions
125-
graph_polynomial
126124
max_size
127125
max_size_count
128-
```
126+
```

src/interfaces.jl

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -202,12 +202,14 @@ Positional Arguments
202202
* [`SizeMax`](@ref) for finding maximum set size,
203203
* [`SizeMin`](@ref) for finding minimum set size,
204204
205-
* [`CountingMax`](@ref) for counting configurations with top `K` sizes,
205+
* [`CountingMax`](@ref) for counting configurations with largest-K sizes,
206+
* [`CountingMin`](@ref) for counting configurations with smallest-K sizes,
206207
* [`CountingAll`](@ref) for counting all configurations,
207208
* [`GraphPolynomial`](@ref) for evaluating the graph polynomial,
208209
209210
* [`SingleConfigMax`](@ref) for finding one maximum configuration,
210-
* [`ConfigsMax`](@ref) for enumerating configurations with top `K` sizes,
211+
* [`ConfigsMax`](@ref) for enumerating configurations with largest-K sizes,
212+
* [`ConfigsMin`](@ref) for enumerating configurations with smallest-K sizes,
211213
* [`ConfigsAll`](@ref) for enumerating all configurations,
212214
213215
@@ -383,4 +385,4 @@ end
383385

384386
# convert to Matrix
385387
Base.Matrix(ce::ConfigEnumerator) = plain_matrix(ce)
386-
Base.Vector(ce::StaticElementVector) = collect(ce)
388+
Base.Vector(ce::StaticElementVector) = collect(ce)

0 commit comments

Comments
 (0)