de.sfuhrm.sudoku

Class GameMatrix

java.lang.Object

de.sfuhrm.sudoku.GameMatrix

All Implemented Interfaces:

Cloneable

Direct Known Subclasses:

Riddle

public class GameMatrix
extends Object
implements Cloneable

The quadratic matrix.

Author:

Stephan Fuhrmann

Field Summary

Fields

Modifier and Type	Field and Description
protected static int	BLOCK_SIZE The edge dimension of a 3x3 block.
static int	SIZE The size in one dimension.
static byte	UNSET The value that is assigned to unset fields.

Constructor Summary

Constructors

Constructor and Description
GameMatrix() Creates an empty riddle.

Method Summary

Modifier and Type	Method and Description
protected void	block(int row, int column, byte[] target) Gets a stream of the given block.
boolean	canSet(int row, int column, byte value) Checks if the effect of one set operation is valid.
void	clear() Clear the cells.
Object	clone()
protected void	column(int index, byte[] target) Gets a stream of the given column.
boolean	equals(Object obj)
byte	get(int row, int column) Get the value of a field.
byte[][]	getArray() Gets a copy of the underlying array.
int	getSetCount() Get the number of set cells.
int	hashCode()
boolean	isValid() Checks if the whole play field is valid.
static byte[][]	parse(String... rows) Parses a string based field descriptor.
protected void	row(int index, byte[] target) Gets a stream of the given row.
void	set(int row, int column, byte value) Set the value of a field.
void	setAll(byte[][] initializationData) Sets all cells to the given values.
String	toString()

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

UNSET

public static final byte UNSET

The value that is assigned to unset fields.

See Also:

Constant Field Values

SIZE

public static final int SIZE

The size in one dimension.

See Also:

Constant Field Values

BLOCK_SIZE

protected static final int BLOCK_SIZE

The edge dimension of a 3x3 block.

See Also:

Constant Field Values

Constructor Detail

GameMatrix

public GameMatrix()

Creates an empty riddle.

See Also:

setAll(byte[][])

Method Detail

setAll

public final void setAll(byte[][] initializationData)

Sets all cells to the given values.

Parameters:

initializationData - initialization data with the first dimension being the rows and the second dimension being the columns.

row

protected void row(int index,
                   byte[] target)

Gets a stream of the given row.

Parameters:

index - the row index to get the stream for.

target - a 9-element array to receive the row data.

column

protected void column(int index,
                      byte[] target)

Gets a stream of the given column.

Parameters:

index - the column index to get the stream for.

target - a 9-element array to receive the column data.

block

protected void block(int row,
                     int column,
                     byte[] target)

Gets a stream of the given block.

Parameters:

row - start row of the block (0..6).

column - start column of the block (0..6).

target - a 9-element array to receive the block data.

parse

public static final byte[][] parse(String... rows)

Parses a string based field descriptor.

Parameters:

rows - array of strings with each string describing a row. Digits get converted to the element values, everything else gets converted to UNSET.

Returns:

the parsed array.

Throws:

IllegalArgumentException - if one of the rows has a wrong size.

clear

public void clear()

Clear the cells.

get

public final byte get(int row,
                      int column)

Get the value of a field.

Parameters:

row - the row of the cell to get the value for.

column - the column of the cell to get the value for.

Returns:

the cell value ranging from 0 to 9.

set

public void set(int row,
                int column,
                byte value)

Set the value of a field.

Parameters:

column - the column of the field.

row - the row of the field.

value - the value of the field.

getSetCount

public int getSetCount()

Get the number of set cells.

Returns:

the number of fields with a number in. Can be in the range between 0 and 81.

getArray

public byte[][] getArray()

Gets a copy of the underlying array.

Returns:

the data array containing numbers between 0 and 9. The first index is the row index, the second index is the column index.

toString

public String toString()

Overrides:

toString in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

clone

public Object clone()

Overrides:

clone in class Object

isValid

public final boolean isValid()

Checks if the whole play field is valid.

Returns:

true if the filled rows, columns and blocks contain no duplicate numbers.

canSet

public final boolean canSet(int row,
                            int column,
                            byte value)

Checks if the effect of one set operation is valid. This is much quicker than isValid().

Parameters:

row - the row of the cell to test validity for.

column - the column of the cell to test validity for.

value - the value to simulate setting for.

Returns:

true if the given cell can be set to value without violating the game rules.