Interface IRule
Enforces a rule for a puzzle, such as "all values must be unique within a row." This is done by tracking possible values for each square specifically as determined by this rule. These possible values are then enforced along with any other rules by an IRuleKeeper.
Namespace: SudokuSpice.RuleBased.Rules
Assembly: SudokuSpice.dll
Syntax
public interface IRule
Methods
| Improve this Doc View SourceCopyWithNewReference(IReadOnlyPuzzle)
Creates a deep copy of this IRule, with any internal IReadOnlyPuzzle
references updated to the given puzzle.
Declaration
IRule CopyWithNewReference(IReadOnlyPuzzle puzzle)
Parameters
Type | Name | Description |
---|---|---|
IReadOnlyPuzzle | puzzle | The new puzzle reference to use. To ensure this rule's internal state is correct, this puzzle should contain the same data as the current puzzle referenced by this rule. |
Returns
Type | Description |
---|---|
IRule |
GetPossibleValues(Coordinate)
Gets the possible values for the given coordinate based on this rule.
Declaration
BitVector GetPossibleValues(in Coordinate c)
Parameters
Type | Name | Description |
---|---|---|
Coordinate | c |
Returns
Type | Description |
---|---|
BitVector | The possible values represented as a BitVector. |
Remarks
When implementing this method, avoid depending on dynamic information in the current puzzle being solved, such as the currently set values. This method must return information that reflects the most recent calls to Update(Coordinate, Int32, CoordinateTracker) or Revert(Coordinate, Int32, CoordinateTracker), as it can be called before or after modifying the underlying puzzle's data.
Revert(Coordinate, Int32)
Undoes an update for the given value at the specified coordinate.
This performs the same internal updates as Revert(Coordinate, Int32, CoordinateTracker), but without passing affected coordinates back to the caller. Therefore this is more efficient in cases where the caller already knows all the possible coordinates that could be affected.
Declaration
void Revert(in Coordinate c, int val)
Parameters
Type | Name | Description |
---|---|---|
Coordinate | c | The coordinate where a value is being unset. |
System.Int32 | val | The value being unset. |
Remarks
This method will always be called before reverting the value on the underlying puzzle.
Revert(Coordinate, Int32, CoordinateTracker)
Undoes an update for the given value at the specified coordinate. Tracks affected coordinates in the given tracker.
Declaration
void Revert(in Coordinate c, int val, CoordinateTracker coordTracker)
Parameters
Type | Name | Description |
---|---|---|
Coordinate | c | The coordinate where a value is being unset. |
System.Int32 | val | The value being unset. |
CoordinateTracker | coordTracker | The coordinates of unset squares impacted by this change will be tracked in this tracker. |
Remarks
This method will always be called before reverting the value on the underlying puzzle.
TryInit(IReadOnlyPuzzle, BitVector)
Tries to initialize this rule to prepare to solve the given puzzle.
Declaration
bool TryInit(IReadOnlyPuzzle puzzle, BitVector uniquePossibleValues)
Parameters
Type | Name | Description |
---|---|---|
IReadOnlyPuzzle | puzzle | The puzzle to be solved. |
BitVector | uniquePossibleValues | All the unique possible values for this puzzle. |
Returns
Type | Description |
---|---|
System.Boolean | False if the puzzle violates this rule and initialization fails, else true. |
Remarks
In general, it doesn't make sense to want to maintain the previous state if this method fails. Therefore, it is not guaranteed that the rule's state is unchanged on failure.
Update(Coordinate, Int32, CoordinateTracker)
Updates possible values based on setting the given coordinate to the given value. Tracks affected coordinates in the given tracker.
Declaration
void Update(in Coordinate c, int val, CoordinateTracker coordTracker)
Parameters
Type | Name | Description |
---|---|---|
Coordinate | c | The coordinate to update. |
System.Int32 | val | The value to set |
CoordinateTracker | coordTracker | The coordinates of unset squares impacted by this change will be tracked in this tracker. |
Remarks
This method will always be called before setting the value on the underlying puzzle.