Skip to content

remove issame from constrainta tutorial #198

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

Open
dekelzeldov wants to merge 2 commits into
base: master
Choose a base branch
from
Open

remove issame from constrainta tutorial #198

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5ecdbf9
remove issame from constrainta tutorial
dekelzeldov Mar 20, 2026
33f4c41
check constraint duplication
dekelzeldov Mar 20, 2026
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
34 changes: 13 additions & 21 deletions docs/src/tutorials/getting_started_with_constraints.jl
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
### A Pluto.jl notebook ###
# v0.20.13
# v0.20.23

using Markdown
using InteractiveUtils
Expand Down Expand Up @@ -244,11 +244,10 @@ Each time a new AST node is added to a tree, the `on_new_node` function is calle

# ╔═╡ a2f8378f-b798-418b-84e5-4754c990f1b2
md"""
To be able to add our custom constraint to the grammar, we need to implement two more functions that are required for all grammar constraints:
To be able to add our custom constraint to the grammar, we need to implement the following functions that is required for all grammar constraints:
- `HerbCore.is_domain_valid()`
- `HerbCore.issame()`

Let's look at `is_domain_valid` first. For a `ForbidConsecutive` constraint the domain is valid if its `rule` is a valid rule index, i.e. it does not exceed the number of rules in the given grammar.
For a `ForbidConsecutive` constraint the domain is valid if its `rule` is a valid rule index, i.e. it does not exceed the number of rules in the given grammar.

The docs for tell us that there is two interfaces for `is_domain` and we will implement both.
"""
Expand All @@ -263,15 +262,9 @@ We implement both interfaces:

# ╔═╡ 3d4cd754-6e08-435d-9f5e-9e293f425c56
md"""
`issame` is used by `addconstraint!` to avoid duplicate constraints, i.e. a constraint is only added to the grammar if it doesn't already exist. If not implemented for a specific type, `issame` defaults to `false`.
"""

# ╔═╡ 5065a0a1-78f6-4713-8f1e-cc1c1ff8c521
@doc HerbCore.issame
Additionally, to avoid duplicate constraints, a constraint is only added to the grammar if it doesn't already exist. If the constraint is a complex struct, make sure `==` is well defined for it.

# ╔═╡ 5611665e-3269-4140-aa42-dbdaaf6dc967
md"""
We consider two `ForbidConsecutive` constraints to be the same if their `rule`s are equal.
We consider two `ForbidConsecutive` constraints to be the same if their `rule`s are equal. We can explicitly define the equality as follows (though in this case, the default comparison would have worked the same):
"""

# ╔═╡ bacc917b-2706-412d-9b85-deb4b6685323
Expand Down Expand Up @@ -396,7 +389,7 @@ function HerbCore.is_domain_valid(c::ForbidConsecutive, grammar::AbstractGrammar
end

# ╔═╡ ae811b8c-672b-428c-9c14-a2595c15f0b4
function HerbCore.issame(c1::ForbidConsecutive, c2::ForbidConsecutive)
function HerbCore.Base.:(==)(c1::ForbidConsecutive, c2::ForbidConsecutive)
c1.rule == c2.rule
end

Expand Down Expand Up @@ -424,7 +417,7 @@ end

# ╔═╡ ce9ae2a2-f3e3-4693-9e6d-60e91128de34
md"""
With all the components implemented, we can do a constrained enumeration using our custom constraint. Firt, we clear the grammar and add some of our new `ForbidConsecutive` constraints.
With all the components implemented, we can do a constrained enumeration using our custom constraint. First, we clear the grammar and add some of our new `ForbidConsecutive` constraints.
"""

# ╔═╡ 89c165c6-3e04-4887-924f-364b25b21bcd
Expand All @@ -435,11 +428,12 @@ begin
addconstraint!(grammar, ForbidConsecutive(plus))
addconstraint!(grammar, ForbidConsecutive(times))
addconstraint!(grammar, ForbidConsecutive(plus))
println("There are $(length(grammar.constraints)) constraints in the grammar now.")
end

# ╔═╡ 2d2440a6-aeba-42dc-92b2-4325b51b4262
md"""
The last constraint we try to add is ignored - it already exists.
Note that the last constraint we try to add is ignored as it already exists.

Finally we enumerate the programs that satisfy the constraints.
"""
Expand Down Expand Up @@ -477,20 +471,18 @@ end
# ╟─2bea7a99-c46a-4200-9ba8-1227a5806f2f
# ╟─f4c15b60-5d45-4b75-9100-a7be2969d7ca
# ╠═b00b039b-63ee-40d0-8f4b-d25539e596d5
# ╟─a2f8378f-b798-418b-84e5-4754c990f1b2
# ╠═a2f8378f-b798-418b-84e5-4754c990f1b2
# ╠═713e4732-79c9-47cd-bac8-9295d4cc327e
# ╟─a1e75d1b-3caa-4f80-b044-88e33d7de809
# ╠═50c86953-0326-4122-8b01-5fa5e68785ff
# ╠═17d818d2-d6f5-4eb3-8be1-5af78cb099e9
# ╟─3d4cd754-6e08-435d-9f5e-9e293f425c56
# ╠═5065a0a1-78f6-4713-8f1e-cc1c1ff8c521
# ╟─5611665e-3269-4140-aa42-dbdaaf6dc967
# ╠═3d4cd754-6e08-435d-9f5e-9e293f425c56
# ╠═ae811b8c-672b-428c-9c14-a2595c15f0b4
# ╟─bacc917b-2706-412d-9b85-deb4b6685323
# ╠═fef62621-716a-4f8a-85b4-d92e48b30bc6
# ╟─e40e09fc-c697-4c83-90eb-2b758254128e
# ╠═4e0989a8-7e63-45eb-80c9-a3a2f97c357c
# ╟─ce9ae2a2-f3e3-4693-9e6d-60e91128de34
# ╠═ce9ae2a2-f3e3-4693-9e6d-60e91128de34
# ╠═89c165c6-3e04-4887-924f-364b25b21bcd
# ╟─2d2440a6-aeba-42dc-92b2-4325b51b4262
# ╠═2d2440a6-aeba-42dc-92b2-4325b51b4262
# ╠═8bc33f0c-8c72-4a19-bb93-ddc49ad2247a
Loading