Skip to content

Commit

Permalink
typos + Some doc
Browse files Browse the repository at this point in the history
  • Loading branch information
pauleve committed Dec 30, 2024
1 parent d4c154b commit 051f659
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 7 deletions.
8 changes: 5 additions & 3 deletions language.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,9 +43,11 @@ maps each component to a Boolean value

<table class="language">
<tr>
<td><code><span class="some">S</span> = Some(max_size=k)</code></td>
<td>Represents a mutation of at most <code>k</code> components.<br/>
Use <code><span class="some">S</span>.assignments()</code> to get satisfying valuations.</td>
<td><code><span class="some">S</span> = Some(max_size=k, exclude=(), domain=())</code></td>
<td>Represents a mutation of at most <code>k</code> (default: <code>1</code>) components.<br>
Use <code><span class="some">S</span>.assignments()</code> to get satisfying valuations.<br>
Options <code>exclude</code> and <code>domain</code> can be used to restrict the components to consider.
</td>
</tr>
</table>

Expand Down
8 changes: 4 additions & 4 deletions overview.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Overview
# Inputs / Outputs

BoNesis takes two inputs:
1. a *domain* of Boolean networks (BNs),
Expand All @@ -20,7 +20,7 @@ partial) mappings from network components to Boolean values.
Dynamical properties are then specified using a specific [declarative language](language.md), whose predicate are available as `BoNesis` methods.


## Input
## Inputs

(bn-domain)=
### Domain of Boolean networks
Expand Down Expand Up @@ -190,7 +190,7 @@ tied with partial observations.

BoNeis gives access to the solutions with *views*. A view specifies which
objects are to be enumarated from the solution space, and returns an iterator
other them.
over them.
Views support a number of options, including:
- `solutions` with value either `"all"`{l=py} (default), `"subset-minimal"`{l=py}, or `"subset-maximal"`{l=py}: enable to focus only on most sparse/dense solutions. Precise meaning depend on the object being enumerated.
- `limit` (default `0`{l=py}): maximum number of solutions to extract; `0`{l=py} means all.
Expand Down Expand Up @@ -242,7 +242,7 @@ The projected solutions can be accessed from the following object:
projs = bo.local_functions()
```

The `projs` object as `as_dict` method which offers direct access to all the projected solutions. By default, it will enumerate the Boolean functions for each node. The method "count" instead returns the number of solutions per node. There is also a `keys` parameter to specify a subset of nodes for the computation.
The `projs` object has an `as_dict` method which offers direct access to all the projected solutions. By default, it will enumerate the Boolean functions for each node. The method "count" instead returns the number of solutions per node. There is also a `keys` parameter to specify a subset of nodes for the computation.

```py
counts = projs.as_dict(method="count")
Expand Down

0 comments on commit 051f659

Please sign in to comment.