Simple overloads of bdd_restrict, zdd_offset, and zdd_onset (and add bdd_topvar(f)/zdd_topvar(A) for later)

[SSoelvsten]

Adds overloads for Restrict

• Adds bdd_restrict(f, var, val) (Generalise API to use Assignment Functions / Generators #452) and redoes all unit tests to make the iterator-based tests have more than one restriction.
• Adds bdd_topvar(f) and zdd_topvar(f) to prepare for dynamic variable reordering ( closes Add bdd_topvar(...) and zdd_topvar(...) #563 ) and not add a hard to track down bug later.
• Adds bdd_low(f) and bdd_high(f) ( closes Add bdd_then/bdd_else #557 )
• Adds zdd_offset(A, var) and bdd_onset(A, var)
• Adds zdd_offset(A) and bdd_onset(A) ( closes Add bdd_then/bdd_else #557 )

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (3952968) 96.653% compared to head (d801bcf) 96.891%.

Additional details and impacted files

@@              Coverage Diff              @@
##              main      #564       +/-   ##
=============================================
+ Coverage   96.653%   96.891%   +0.238%     
=============================================
  Files           83        83               
  Lines         5767      5822       +55     
=============================================
+ Hits          5574      5641       +67     
+ Misses         193       181       -12     

Files	Coverage Δ
src/adiar/bdd.h	100.000% <ø> (ø)
src/adiar/bdd/bdd.cpp	88.421% <100.000%> (+2.400%)	⬆️
src/adiar/bdd/restrict.cpp	100.000% <100.000%> (ø)
src/adiar/internal/dd_func.h	100.000% <100.000%> (+9.524%)	⬆️
src/adiar/zdd.h	100.000% <ø> (ø)
src/adiar/zdd/subset.cpp	100.000% <100.000%> (ø)
src/adiar/zdd/zdd.cpp	80.556% <100.000%> (+4.140%)	⬆️

... and 1 file with indirect coverage changes

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[github-actions]

Benchmark Report 🟢

origin/bdd/restrict_overloads is an improvement of 0.40% (compared to origin/main).

Minimum running time (s) for 14-Queens:

origin/main	origin/bdd/restrict_overloads
268.43	267.37

Raw Data

Running times (s) for 14-Queens:

origin/main	origin/bdd/restrict_overloads
369.85	267.86
269.44	267.37
271.23	268.98
268.43	268.47

[github-actions]

Benchmark Report 🟢

origin/bdd/restrict_overloads is an improvement of 0.18% (compared to origin/main).

Minimum running time (s) for 9-Queens:

origin/main	origin/bdd/restrict_overloads
0.25	0.25

Raw Data

Running times (s) for 9-Queens:

origin/main	origin/bdd/restrict_overloads
0.25	0.25
0.26	0.25
0.25	0.25
0.25	0.26
0.25	0.25
0.25	0.25
0.25	0.25
0.25	0.26
0.25	0.25
0.25	0.25
0.27	0.25
0.25	0.25
0.25	0.25
0.25	0.25
0.25	0.26
0.25	0.25

[github-actions]

Benchmark Report 🟡

origin/bdd/restrict_overloads is a regression of 1.88% (compared to origin/main).

Minimum running time (s) for 12-Queens:

origin/main	origin/bdd/restrict_overloads
14.64	14.92

Raw Data

Running times (s) for 12-Queens:

origin/main	origin/bdd/restrict_overloads
14.86	14.92
14.64	14.97
14.68	14.93
14.68	14.99
14.69	14.95
14.65	14.99
14.84	15.04
14.71	15.04
14.69	15.03
14.73	14.99
14.69	14.97
14.69	15.03
14.74	15.02
14.71	15.03
14.71	15.01
14.73	15.02

[SSoelvsten]

2000 Unit Tests 🎉

[github-actions]

Benchmark Report 🟢

origin/bdd/restrict_overloads is an improvement of 0.32% (compared to origin/main).

Minimum running time (s) for 14-Queens:

origin/main	origin/bdd/restrict_overloads
269.06	268.20

Raw Data

Running times (s) for 14-Queens:

origin/main	origin/bdd/restrict_overloads
371.38	268.83
269.06	269.67
270.03	268.20
269.92	270.24

[github-actions]

Benchmark Report 🟡

origin/bdd/restrict_overloads is a regression of 1.74% (compared to origin/main).

Minimum running time (s) for 9-Queens:

origin/main	origin/bdd/restrict_overloads
0.24	0.25

Raw Data

Running times (s) for 9-Queens:

origin/main	origin/bdd/restrict_overloads
0.24	0.25
0.25	0.26
0.25	0.25
0.25	0.25
0.25	0.28
0.25	0.25
0.25	0.26
0.25	0.25
0.25	0.25
0.25	0.25
0.25	0.29
0.25	0.25
0.25	0.25
0.25	0.25
0.25	0.30
0.25	0.30

[github-actions]

Benchmark Report 🟡

origin/bdd/restrict_overloads is a regression of 1.97% (compared to origin/main).

Minimum running time (s) for 12-Queens:

origin/main	origin/bdd/restrict_overloads
17.09	17.43

Raw Data

Running times (s) for 12-Queens:

origin/main	origin/bdd/restrict_overloads
17.70	17.90
17.46	17.75
17.42	17.58
17.28	17.92
17.39	17.76
17.71	17.75
17.34	17.84
17.46	17.94
17.92	17.43
17.57	17.82
17.39	17.72
17.40	18.34
17.29	17.68
17.09	17.55
17.58	17.84
17.63	17.64