Class MaxCountRule
Simplifies the logic needed to implement a "max-count" rule, such as "each row must contain n copies of value m." In this case, the count n can vary for each value m.
Implements
Inherited Members
Namespace: SudokuSpice.RuleBased.Rules
Assembly: SudokuSpice.dll
Syntax
public abstract class MaxCountRule : IRule
Constructors
| Improve this Doc View SourceMaxCountRule()
Declaration
protected MaxCountRule()
MaxCountRule(MaxCountRule)
Declaration
protected MaxCountRule(MaxCountRule existing)
Parameters
Type | Name | Description |
---|---|---|
MaxCountRule | existing |
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
public abstract 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 |
GetDimension(Coordinate)
Gets the dimension for a coordinate.
Declaration
protected abstract int GetDimension(in Coordinate c)
Parameters
Type | Name | Description |
---|---|---|
Coordinate | c |
Returns
Type | Description |
---|---|
System.Int32 |
GetNumDimensions(IReadOnlyPuzzle)
Returns the number of dimensions that will be enforced to contain unique values.
Declaration
protected abstract int GetNumDimensions(IReadOnlyPuzzle puzzle)
Parameters
Type | Name | Description |
---|---|---|
IReadOnlyPuzzle | puzzle | The puzzle for which to determine the number of dimensions. |
Returns
Type | Description |
---|---|
System.Int32 |
GetPossibleValues(Coordinate)
Gets the possible values for the given coordinate based on this rule.
Declaration
public 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.
GetPossibleValues(Int32)
Declaration
protected BitVector GetPossibleValues(int dimension)
Parameters
Type | Name | Description |
---|---|---|
System.Int32 | dimension |
Returns
Type | Description |
---|---|
BitVector |
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
public 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
public 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.
TrackUnsetCoordinatesOnSameDimension(Int32, Coordinate, CoordinateTracker)
Adds the coordinates of unset values on the given dimension to the given tracker.
Declaration
protected abstract void TrackUnsetCoordinatesOnSameDimension(int dimension, in Coordinate source, CoordinateTracker tracker)
Parameters
Type | Name | Description |
---|---|---|
System.Int32 | dimension | The dimension to search. |
Coordinate | source | The source coordinate for the change; should be skipped. |
CoordinateTracker | tracker | The tracker to add coordiantes to. |
TryInit(IReadOnlyPuzzle, BitVector)
Tries to initialize this rule to prepare to solve the given puzzle.
Declaration
public virtual 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
public 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.