org.mariuszgromada.math.janetsudoku

Class SudokuGenerator

java.lang.Object

org.mariuszgromada.math.janetsudoku.SudokuGenerator

public class SudokuGenerator
extends Object

Sudoku generator.

Version:

1.0.0

Author:

Mariusz Gromada
mariuszgromada.org@gmail.com
Janet Sudoku - project web page
MathSpace.pl
MathParser.org - mXparser project page
Janet Sudoku on GitHub
Janet Sudoku on CodePlex
Janet Sudoku on SourceForge
Janet Sudoku on BitBucket
mXparser-MathParser.org on GitHub

Field Summary

Fields

Modifier and Type	Field and Description
static int	GENERATOR_GEN_FAILED Generation process failed.
static int	GENERATOR_GEN_FINISHED Generation process finished.
static int	GENERATOR_GEN_NOT_STARTED Generation process not started.
static int	GENERATOR_GEN_STARTED Generation process started.
static int	GENERATOR_INIT_FAILED Generator init failed.
static int	GENERATOR_INIT_FINISHED Generator init finished.
static int	GENERATOR_INIT_STARTED Generator init started
static char	PARAM_DO_NOT_SOLVE Indicator showing that initial board should be solved before generation process will be started.
static char	PARAM_DO_NOT_TRANSFORM Indicator showing that initial board should not be randomly transformed before generation process will be started.
static char	PARAM_GEN_RND_BOARD Indicator if generation should start from randomly generated board.

Constructor Summary

Constructors

Constructor and Description
SudokuGenerator(ArrayList<String> boardDefinition, char... parameters) Constructor based on the sudoku board provided list of strings.
SudokuGenerator(char... parameters) Default constructor based on random Sudoku puzzle example.
SudokuGenerator(int[][] initialBoard, char... parameters) Default constructor based on provided initial board.
SudokuGenerator(int example, char... parameters) Default constructor based on puzzle example.
SudokuGenerator(String[] boardDefinition, char... parameters) Constructor based on the sudoku board provided array of strings.
SudokuGenerator(String boardFilePath, char... parameters) Constructor based on the sudoku board provided in text file.

Method Summary

Methods

Modifier and Type	Method and Description
void	clearMessages() Clears list of recorded messages.
void	disableRndSeedOnFilledCells() By default random seed on filled cells is enabled.
void	enableRndSeedOnFilledCells() By default random seed on filled cells is enabled.
int[][]	generate() Sudoku puzzle generator.
double	getComputingTime() Return solving time in seconds..
int	getGeneratorState() Return current state of the generator
String	getLastErrorMessage() Gets last recorded error message.
String	getLastMessage() Gets last recorded message.
String	getMessages() Returns list of recorded messages.
boolean	saveBoard(String filePath) Saves board to the text file.
boolean	saveBoard(String filePath, String headComment) Saves board to the text file.
boolean	saveBoard(String filePath, String headComment, String tailComment) Saves board to the text file.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

PARAM_GEN_RND_BOARD

public static final char PARAM_GEN_RND_BOARD

Indicator if generation should start from randomly generated board.

See Also:

Constant Field Values

PARAM_DO_NOT_SOLVE

public static final char PARAM_DO_NOT_SOLVE

Indicator showing that initial board should be solved before generation process will be started.

See Also:

Constant Field Values

PARAM_DO_NOT_TRANSFORM

public static final char PARAM_DO_NOT_TRANSFORM

Indicator showing that initial board should not be randomly transformed before generation process will be started.

See Also:

Constant Field Values

GENERATOR_INIT_STARTED

public static final int GENERATOR_INIT_STARTED

Generator init started

See Also:

getGeneratorState(), Constant Field Values

GENERATOR_INIT_FINISHED

public static final int GENERATOR_INIT_FINISHED

Generator init finished.

See Also:

getGeneratorState(), Constant Field Values

GENERATOR_INIT_FAILED

public static final int GENERATOR_INIT_FAILED

Generator init failed.

See Also:

getGeneratorState(), Constant Field Values

GENERATOR_GEN_NOT_STARTED

public static final int GENERATOR_GEN_NOT_STARTED

Generation process not started.

See Also:

getGeneratorState(), Constant Field Values

GENERATOR_GEN_STARTED

public static final int GENERATOR_GEN_STARTED

Generation process started.

See Also:

getGeneratorState(), Constant Field Values

GENERATOR_GEN_FINISHED

public static final int GENERATOR_GEN_FINISHED

Generation process finished.

See Also:

getGeneratorState(), Constant Field Values

GENERATOR_GEN_FAILED

public static final int GENERATOR_GEN_FAILED

Generation process failed.

See Also:

getGeneratorState(), Constant Field Values

Constructor Detail

SudokuGenerator

public SudokuGenerator(char... parameters)

Default constructor based on random Sudoku puzzle example.

Parameters:

parameters - Optional parameters.

See Also:

PARAM_DO_NOT_SOLVE, PARAM_DO_NOT_TRANSFORM, PARAM_GEN_RND_BOARD

SudokuGenerator

public SudokuGenerator(int example,
               char... parameters)

Default constructor based on puzzle example.

Parameters:

example - Example number between 0 and SudokuPuzzles.NUMBER_OF_PUZZLE_EXAMPLES.

parameters - Optional parameters.

See Also:

PARAM_DO_NOT_SOLVE, PARAM_DO_NOT_TRANSFORM, PARAM_GEN_RND_BOARD

SudokuGenerator

public SudokuGenerator(int[][] initialBoard,
               char... parameters)

Default constructor based on provided initial board.

Parameters:

initialBoard - Array with the board definition.

parameters - Optional parameters

See Also:

PARAM_DO_NOT_SOLVE, PARAM_DO_NOT_TRANSFORM, PARAM_GEN_RND_BOARD

SudokuGenerator

public SudokuGenerator(String boardFilePath,
               char... parameters)

Constructor based on the sudoku board provided in text file.

Parameters:

boardFilePath - Path to the board definition.

parameters - Optional parameters

See Also:

PARAM_DO_NOT_SOLVE, PARAM_DO_NOT_TRANSFORM, PARAM_GEN_RND_BOARD

SudokuGenerator

public SudokuGenerator(String[] boardDefinition,
               char... parameters)

Constructor based on the sudoku board provided array of strings.

Parameters:

boardDefinition - Board definition as array of strings (each array entry as separate row).

parameters - Optional parameters

See Also:

PARAM_DO_NOT_SOLVE, PARAM_DO_NOT_TRANSFORM, PARAM_GEN_RND_BOARD

SudokuGenerator

public SudokuGenerator(ArrayList<String> boardDefinition,
               char... parameters)

Constructor based on the sudoku board provided list of strings.

Parameters:

boardDefinition - Board definition as list of strings (each list entry as separate row).

parameters - Optional parameters

See Also:

PARAM_DO_NOT_SOLVE, PARAM_DO_NOT_TRANSFORM, PARAM_GEN_RND_BOARD

Method Detail

generate

public int[][] generate()

Sudoku puzzle generator.

Returns:

Sudoku puzzle if process finished correctly, otherwise null.

saveBoard

public boolean saveBoard(String filePath)

Saves board to the text file.

Parameters:

filePath - Path to the file.

Returns:

True if saving was successful, otherwise false.

See Also:

SudokuStore.saveBoard(int[][], String), SudokuStore.boardToString(int[][])

saveBoard

public boolean saveBoard(String filePath,
                String headComment)

Saves board to the text file.

Parameters:

filePath - Path to the file.

headComment - Comment to be added at the head.

Returns:

True if saving was successful, otherwise false.

See Also:

SudokuStore.saveBoard(int[][], String, String), SudokuStore.boardToString(int[][], String)

saveBoard

public boolean saveBoard(String filePath,
                String headComment,
                String tailComment)

Saves board to the text file.

Parameters:

filePath - Path to the file.

headComment - Comment to be added at the head.

tailComment - Comment to be added at the tail.

Returns:

True if saving was successful, otherwise false.

See Also:

SudokuStore.saveBoard(int[][], String, String, String), SudokuStore.boardToString(int[][], String, String)

enableRndSeedOnFilledCells

public void enableRndSeedOnFilledCells()

By default random seed on filled cells is enabled. This parameter affects generating process only. Random seed on filled cells causes randomization on filled cells within the same impact.

disableRndSeedOnFilledCells

public void disableRndSeedOnFilledCells()

By default random seed on filled cells is enabled. This parameter affects generating process only. Lack of random seed on filled cells causes no randomization on filled cells within the same impact.

getMessages

public String getMessages()

Returns list of recorded messages.

Returns:

List of recorded messages.

clearMessages

public void clearMessages()

Clears list of recorded messages.

getLastMessage

public String getLastMessage()

Gets last recorded message.

Returns:

Last recorded message.

getLastErrorMessage

public String getLastErrorMessage()

Gets last recorded error message.

Returns:

Last recorded message.

getComputingTime

public double getComputingTime()

Return solving time in seconds..

Returns:

Solving time in seconds.

getGeneratorState

public int getGeneratorState()

Return current state of the generator

Returns:

GENERATOR_INIT_STARTED or GENERATOR_INIT_FINISHED or GENERATOR_INIT_FAILED or GENERATOR_GEN_NOT_STARTED or GENERATOR_GEN_STARTED or GENERATOR_GEN_FINISHED or GENERATOR_GEN_FAILED.