cwi>> from clingo.symbol import Function >>> from clingo.propagator import Propagator >>> from clingo.control import Control >>> >>> class AIFFB(Propagator): ... # add watches for atoms `a` and `b` ... def init(self, init): ... # get program literals for atoms `a` and `b` ... plit_a = init.symbolic_atoms[Function("a")].literal ... plit_b = init.symbolic_atoms[Function("b")].literal ... # get solver literals for program literals `a` and `b` ... self.slit_a = init.solver_literal(plit_a) ... self.slit_b = init.solver_literal(plit_b) ... # add watches for solver literals `a` and `b` ... init.add_watch(self.slit_a) ... init.add_watch(self.slit_b) ... # propagate solver literals `a` and `b` ... def propagate(self, ctl, changes): ... # if `a` is true imply `b` ... if self.slit_a in changes: ... ctl.add_clause([-self.slit_a, self.slit_b]) ... # if `b` is true imply `a` ... if self.slit_b in changes: ... ctl.add_clause([-self.slit_b, self.slit_a]) ... >>> ctl = Control(["0"]) >>> ctl.register_propagator(AIFFB()) >>> ctl.add("base", [], "1 { a; b }.") >>> ctl.ground([("base", [])]) >>> print(ctl.solve(on_model=print)) a b SAT ``` )ABCMeta)IterableIteratorOptionalSequenceTuple)_c_call_cb_error_handler_ffi _handle_error_lib) OrderedEnum) SymbolicAtoms) TheoryAtom)SliceSlicedSequence) AssignmentPropagateControl PropagateInit PropagatorPropagatorCheckModePropagatorUndoModeTrailcT\rSrSrSrSrSrSrSrS\ S\ 4S jr S\ S\ 4S jr S r g ) r<a Class to access literals assigned by the solver in chronological order. Literals in the trail are ordered by decision levels, where the first literal with a larger level than the previous literals is a decision; the following literals with same level are implied by this decision literal. Each decision level up to and including the current decision level has a valid offset in the trail. cXlgN_repselfreps K/home/james-whalen/.local/lib/python3.13/site-packages/clingo/propagator.py__init__Trail.__init__G cL[S[RUR5$)Nuint32_t)r rclingo_assignment_trail_sizer r"s r$__len__ Trail.__len__Jsz4#D#DdiiPPr(c [U[5(a[U[U55$US:aU[ U5- nUS:dU[ U5:a [ S5e[ S[RURU5$Nrz invalid indexclingo_literal_t) isinstanceslicerrlen IndexErrorr rclingo_assignment_trail_atr r"slcs r$ __getitem__Trail.__getitem__Msr c5 ! !!$c 3 3 7 3t9 C 7cSY&_- -  ? ?C  r(c## [[U55H+n[S[RUR U5v M- g7fNr1)ranger4r rr6r r"is r$__iter__Trail.__iter__Xs9s4y!A"D$C$CTYYPQ "AAlevelreturncN[S[RURU5$)z Returns the offset of the decision literal with the given decision level in the trail. Parameters ---------- level The decision level. r*)r rclingo_assignment_trail_beginr r"rCs r$begin Trail.begin^s z4#E#EtyyRWXXr(cN[S[RURU5$)z Returns the offset following the last literal with the given decision literal in the trail. Parameters ---------- level The decision level. r*)r rclingo_assignment_trail_endr rGs r$end Trail.endjs z4#C#CTYYPUVVr(rN) __name__ __module__ __qualname____firstlineno____doc__r%r-r9r@intrHrL__static_attributes__r(r$rr<sHQ   Y3 Y3 Y W W Wr(rc:\rSrSrSrSrSrSrSrS\ S\ 4S jr S \ S\ 4S jr S \ S\ 4S jr S \ S\ 4S jrS \ S\ 4SjrS \ S\ 4SjrS \ S\ 4SjrS\\ 4Sjr\S\ 4Sj5r\S\ 4Sj5r\S\ 4Sj5r\S\ 4Sj5r\S\4Sj5rSrg)rwaR Class to inspect the (parital) assignment of an associated solver. Assigns truth values to solver literals. Each solver literal is either true, false, or undefined, represented by the Python constants `True`, `False`, or `None`, respectively. This class implements `Sequence[int]` to access the (positive) literals in the assignment. cXlgrrr!s r$r%Assignment.__init__r'r(cB[R"UR5$r)rclingo_assignment_sizer r,s r$r-Assignment.__len__s**49955r(c [U[5(a[U[U55$US:aU[ U5- nUS:dU[ U5:a [ S5e[ S[RURU5$r0) r2r3rrr4r5r rclingo_assignment_atr r7s r$r9Assignment.__getitem__so c5 ! !!$c 3 3 7 3t9 C 7cSY&_- -)4+D+DdiiQTUUr(c## [[U55H+n[S[RUR U5v M- g7fr<)r=r4r rr^r r>s r$r@Assignment.__iter__s5s4y!A,d.G.GTUV V"rBrCrDcN[S[RURU5$)zf Return the decision literal of the given level. Parameters ---------- level The decision level. r1)r rclingo_assignment_decisionr rGs r$decisionAssignment.decisions$  ? ?E  r(literalcD[R"URU5$)zp Determine if the given literal is valid in this solver. Parameters ---------- literal The solver literal. )rclingo_assignment_has_literalr r"rfs r$ has_literalAssignment.has_literals11$))WEEr(cN[S[RURU5$)z[ Determine if the literal is false. Parameters ---------- literal The solver literal. bool)r rclingo_assignment_is_falser ris r$is_falseAssignment.is_falsevt>> 7SSr(cN[S[RURU5$)zo Determine if the literal is assigned on the top level. Parameters ---------- literal The solver literal. rm)r rclingo_assignment_is_fixedr ris r$is_fixedAssignment.is_fixedrqr(cN[S[RURU5$)zZ Determine if the literal is true. Parameters ---------- literal The solver literal. rm)r rclingo_assignment_is_truer ris r$is_trueAssignment.is_truesvt==tyy'RRr(ct[S[RURU5nU[R:H$)zZ Determine if the literal is free. Parameters ---------- literal The solver literal. clingo_truth_value_t)r rclingo_assignment_truth_valuer clingo_truth_value_freer"rfvalues r$is_freeAssignment.is_frees7 "  . . II    4444r(cN[S[RURU5$)z The decision level of the given literal. Parameters ---------- literal The solver literal. Notes ----- Note that the returned value is only meaningful if the literal is assigned - i.e., `value(lit) is not None`. r*)r rclingo_assignment_levelr ris r$rCAssignment.levelsz4#?#?GTTr(c[S[RURU5nU[R:XagU[R :XagU[R :Xdeg)z{ Get the truth value of the given literal or `None` if it has none. Parameters ---------- literal The solver literal. r{TFN)r rr|r clingo_truth_value_trueclingo_truth_value_falser}r~s r$rAssignment.values_ "  . . II    D00 0 D11 144444r(cB[R"UR5$)z The current decision level. )r clingo_assignment_decision_levelr r,s r$decision_levelAssignment.decision_levels 44TYY??r(cB[R"UR5$)z( True if the assignment is conflicting. )rclingo_assignment_has_conflictr r,s r$ has_conflictAssignment.has_conflict s 22499==r(cB[R"UR5$)z" Whether the assignment is total. )rclingo_assignment_is_totalr r,s r$is_totalAssignment.is_totals ..tyy99r(cB[R"UR5$)z The current root level. )rclingo_assignment_root_levelr r,s r$ root_levelAssignment.root_levels 00;;r(c,[UR5$)z! The trail of assigned literals. )rr r,s r$trailAssignment.trail"s TYYr(rN)rNrOrPrQrRr%r-r9r@rSrdrmrjrortrxrrCrrpropertyrrrrrrrTrUr(r$rrwsK 6VW  c  c   F3 F4 F T T T T T T Ss St S5s5t5"USUSU ,@@@ >d>> :$:: >tyy'R S >>IIw r(cUc+[[R"URU55 g[[R"URX55 g)a Remove the watch for the solver literal in the given phase. Parameters ---------- literal The solver literal to remove the watch from. thread_id The id of the thread from which to remove the watch. If the is `None`, then the watch is removed from all active threads. N)r r"clingo_propagate_init_remove_watchr .clingo_propagate_init_remove_watch_from_threadrs r$ remove_watchPropagateInit.remove_watchsB   $AA$))WU V CCIIw r(cX[[R"URU55 g)a Freeze the given solver literal. Any solver literal that is not frozen is subject to simplification and might be removed in a preprocessing step after propagator initialization. A propagator should freeze all literals over which it might add clauses during propagation. Note that any watched literal is automatically frozen and that it does not matter which phase of the literal is frozen. Parameters ---------- literal The solver literal to freeze. N)r r$clingo_propagate_init_freeze_literalr ris r$freeze_literalPropagateInit.freeze_literals d?? 7STr(literalsboundtype_ compare_equalc j[S[RURUU[ U5UUU5 $)a Statically adds a constraint of form literal <=> { l=w | (l, w) in literals } >= bound to the solver. - If `type_ < 0`, then `<=>` is a left implication. - If `type_ > 0`, then `<=>` is a right implication. - Otherwise, `<=>` is an equivalence. Parameters ---------- literal The literal associated with the constraint. literals The weighted literals of the constraint. bound The bound of the constraint. type_ Add a weight constraint of the given type_. compare_equal A Boolean indicating whether to compare equal or less than equal. Returns ------- Returns false if the program became unsatisfiable. Notes ----- If this function returns false, initialization should be stopped and no further functions of the `PropagateInit` and related objects should be called. rm)r r+clingo_propagate_init_add_weight_constraintr r4)r"rfrrrrs r$add_weight_constraint#PropagateInit.add_weight_constraints;R   < < II   M     r(cL[S[RUR5$)a| Propagates consequences of the underlying problem excluding registered propagators. Returns ------- Returns false if the program becomes unsatisfiable. Notes ----- This function has no effect if SAT-preprocessing is enabled. If this function returns false, initialization should be stopped and no further functions of the `PropagateInit` and related objects should be called. rm)r rclingo_propagate_init_propagater r,s r$ propagatePropagateInit.propagates"vtCCTYYOOr(cN[S[RURU5$)z Maps the given program literal or condition id to its solver literal. Parameters ---------- literal A program literal or condition id. Returns ------- A solver literal. r1)r r$clingo_propagate_init_solver_literalr ris r$solver_literalPropagateInit.solver_literal0s'   5 5 II    r(cT[[R"UR55$)z9 `Assignment` object capturing the top level assignment. )rr clingo_propagate_init_assignmentr r,s r$ assignmentPropagateInit.assignmentDs $?? JKKr(cT[[R"UR55$)zD `PropagatorCheckMode` controlling when to call `Propagator.check`. )rr$clingo_propagate_init_get_check_moder r,s r$ check_modePropagateInit.check_modeKs #4#L#LTYY#WXXr(modecZ[R"URUR5 gr)r$clingo_propagate_init_set_check_moder rr"rs r$rrRs 11$))TZZHr(cT[[R"UR55$)zB `PropagatorUndoMode` controlling when to call `Propagator.undo`. )rr#clingo_propagate_init_get_undo_moder r,s r$ undo_modePropagateInit.undo_modeVs "$"J"J499"UVVr(cZ[R"URUR5 gr)r#clingo_propagate_init_set_undo_moder rrs r$rr]s 00DJJGr(cB[R"UR5$)zD The number of solver threads used in the corresponding solve call. )r'clingo_propagate_init_number_of_threadsr r,s r$number_of_threadsPropagateInit.number_of_threadsas ;;DIIFFr(cb[S[RUR5n[ U5$)z: The symbolic atoms captured by a `SymbolicAtoms` object. zclingo_symbolic_atoms_t*)r r$clingo_propagate_init_symbolic_atomsr r)r"atomss r$symbolic_atomsPropagateInit.symbolic_atomshs.  &  5 5 II  U##r(c## [S[RUR5n[S[RU5n[ U5Hn[ X5v M g7f)z$ An iterator over all theory atoms. zclingo_theory_atoms_t*size_tN)r r"clingo_propagate_init_theory_atomsr clingo_theory_atoms_sizer=r)r"rsizeidxs r$ theory_atomsPropagateInit.theory_atomstsQ  $d&M&Mtyy x!>!>F;CU( (sA!A#r)T)rr)rF)#rNrOrPrQrRr%rrSrmrrrrrrrrrrrrrrrrsetterrrrrrrrrrTrUr(r$rrXs. # 4 6 $ # : C   D (#$*CHSMT*UcUdU.# 3 3 5c?+3  3  3  3  3 jP4P& c c (LJLL Y/YY I2ItIIW-WW H0HTHHG3GG  $ $ $ )hz2 ) )r(rc \rSrSrSrSrSS\\S\S\S\4Sjjr S\4S jr SS\ \S\S\S\4S jjr S \SS 4S jr S \S\4SjrS\4SjrS \SS 4Sjr\S\4Sj5r\S\4Sj5rSrg )riz? This object can be used to add clauses and to propagate them. cXlgrrr!s r$r%PropagateControl.__init__r'r(rtaglockrDc SnU(aU[R-nU(aU[R-n[S[RUR U[ U5U5$)ag Add the given clause to the solver. Parameters ---------- clause List of solver literals forming the clause. tag If true, the clause applies only in the current solving step. lock If true, exclude clause from the solver's regular clause deletion policy. Returns ------- This method returns false if the current propagation must be stopped. rrm)rclingo_clause_type_volatileclingo_clause_type_staticr #clingo_propagate_control_add_clauser r4)r"rrrrs r$rPropagateControl.add_clauses\(  T55 5E  T33 3E   4 4 II  K    r(cL[S[RUR5$)a% Adds a new positive volatile literal to the underlying solver thread. The literal is only valid within the current solving step and solver thread. All volatile literals and clauses involving a volatile literal are deleted after the current search. Returns ------- The added solver literal. r1)r r$clingo_propagate_control_add_literalr r,s r$rPropagateControl.add_literals"  I I499  r(cRURUVs/sHoD*PM snX#5$s snf)zG Equivalent to `self.add_clause([-lit for lit in clause], tag, lock)`. )r)r"rrrlits r$ add_nogoodPropagateControl.add_nogoods' 77CC7s $rfNcX[[R"URU55 g)z Add a watch for the solver literal in the given phase. Parameters ---------- literal The target solver literal. Notes ----- Unlike `PropagateInit.add_watch` this does not add a watch to all solver threads but just the current one. N)r r"clingo_propagate_control_add_watchr ris r$rPropagateControl.add_watchs d==diiQRr(cD[R"URU5$)z Check whether a literal is watched in the current solver thread. Parameters ---------- literal The target solver literal. Returns ------- Whether the literal is watched. )r"clingo_propagate_control_has_watchr ris r$ has_watchPropagateControl.has_watchs66tyy'JJr(cL[S[RUR5$)z Propagate literals implied by added clauses. Returns ------- This method returns false if the current propagation must be stopped. rm)r r"clingo_propagate_control_propagater r,s r$rPropagateControl.propagatesvtFF RRr(cF[R"URU5 g)zx Removes the watch (if any) for the given solver literal. Parameters ---------- literal The target solver literal. N)r%clingo_propagate_control_remove_watchr ris r$rPropagateControl.remove_watchs 22499gFr(cT[[R"UR55$)zT `Assignment` object capturing the partial assignment of the current solver thread. )rr#clingo_propagate_control_assignmentr r,s r$rPropagateControl.assignments $BB499MNNr(cB[R"UR5$)z. The numeric id of the current solver thread. )r"clingo_propagate_control_thread_idr r,s r$rPropagateControl.thread_ids 66tyyAAr(r)FF)rNrOrPrQrRr%rrSrmrrrrrrrrrrrrrTrUr(r$rrs FK  sm  *.  >B    D S "FKDsmD*.D>BD DSSS K K KS4S GC GD GOJOO B3BBr(rc\rSrSrSrS\SS4SjrS\S\\ SS4S jr S \ S \ S\\ SS4S jr S\SS4S jr S \ S \ S\ S\ 4SjrSrg)riz Propagator interface for custom constraints. See Also -------- clingo.control.Control.register_propagator Notes ----- Not all functions of the `Propagator` interface have to be implemented and can be omitted if not needed. initrDNcg)a This function is called once before each solving step. It is used to map relevant program literals to solver literals, add watches for solver literals, and initialize the data structures used during propagation. Parameters ---------- init Object to initialize the propagator. Notes ----- This is the last point to access theory atoms. Once the search has started, they are no longer accessible. NrU)r"r(s r$r(Propagator.initr(controlchangescg)a Can be used to propagate solver literals given a partial assignment. Parameters ---------- control Object to control propagation. changes List of watched solver literals assigned to true. Notes ----- Called during propagation with a non-empty list of watched solver literals that have been assigned to true since the last call to either propagate, undo, (or the start of the search) - the change set. Only watched solver literals are contained in the change set. Each literal in the change set is true w.r.t. the current Assignment. `PropagateControl.add_clause` can be used to add clauses. If a clause is unit resulting, it can be propagated using `PropagateControl.propagate`. If either of the two methods returns False, the propagate function must return immediately. c = ... if not control.add_clause(c) or not control.propagate(c): return Note that this function can be called from different solving threads. Each thread has its own assignment and id, which can be obtained using `PropagateControl.thread_id`. NrU)r"r,r-s r$rPropagator.propagate(r+r(rrcg)a Called whenever a solver with the given id undos assignments to watched solver literals. Parameters ---------- thread_id The solver thread id. assignment Object for inspecting the partial assignment of the solver. changes The list of watched solver literals whose assignment is undone. Notes ----- This function is meant to update assignment dependent state in a propagator but not to modify the current state of the solver. Furthermore, errors raised in the function lead to program termination. NrU)r"rrr-s r$undoPropagator.undoHr+r(cg)aZ This function is similar to propagate but is called without a change set on propagation fixpoints. When exactly this function is called, can be configured using the @ref PropagateInit.check_mode property. Parameters ---------- control Object to control propagation. Notes ----- This function is called even if no watches have been added. NrU)r"r,s r$checkPropagator.check_r+r(fallbackcU$)u This function allows a propagator to implement domain-specific heuristics. It is called whenever propagation reaches a fixed point. Parameters ---------- thread_id The solver thread id. assignment Object for inspecting the partial assignment of the solver. fallback The literal choosen by the solver's heuristic. Returns ------- Тhe next solver literal to make true. Notes ----- This function should return a free solver literal that is to be assigned true. In case multiple propagators are registered, this function can return 0 to let a propagator registered later make a decision. If all propagators return 0, then the fallback literal is used. rU)r"rrr6s r$decidePropagator.decideqs :r(rU)rNrOrPrQrRrr(rrrSrrr1r4r8rTrUr(r$rrs   4 & !1 HSM d @  *4 ?G}  . - $ $ssr(r) metaclassdatapyclingo_propagator_init)onerrornamecx[R"U5RnUR[ U55 gNT)r from_handler;r(r)r(r; propagators r$_pyclingo_propagator_initrCs,!!$',,JOOM$'( r(pyclingo_propagator_propagatec[R"U5Rn[U5Vs/sHoQUPM nnUR [ U5U5 gs snfr@)r rAr;r=rr)r,r-rr;rBr? py_changess r$_pyclingo_propagator_propagaterGsR!!$',,J&+Dk2k!*kJ2)'2J? 3sApyclingo_propagator_undoc[R"U5Rn[U5Vs/sHoQUPM nn[ U5nUR UR URU5 gs snfr)r rAr;r=rr1rr)r,r-rr;rBr?rFctls r$_pyclingo_propagator_undorKsY!!$',,J&+Dk2k!*kJ2 7 #COOCMM3>>:>3sA1pyclingo_propagator_checkcx[R"U5RnUR[ U55 gr@)r rAr;r4r)r,r;rBs r$_pyclingo_propagator_checkrNs/!!$',,J%g./ r(pyclingo_propagator_decidec[R"U5RnURU[ U5U5US'g)NrT)r rAr;r8r)rrr6r;rdrBs r$_pyclingo_propagator_deciderQs8!!$',,J##Iz*/ExPHQK r(N)'rRabcrtypingrrrrr _internalr r r r rcorerrrrrutilrr__all__rSrrrrrrr def_externrCrGrKrNrQrUr(r$rYs\%N@@LL)$' 8WHSM8Wvp #p f+6&g)g)T BBBBJG7GT*629STU  f %,K*629ST?U?*629TUV *629UVWr(