SudokuStore (Janet Sudoku - Sudoku Generator and Sudoku Solver library for Java Android .NET MONO (C#) CLS compliant (C++/CLI, F#, VB) 1.1.1 API)

java.lang.Object
- org.mariuszgromada.math.janetsudoku.SudokuStore

```
public final class SudokuStore
extends Object
```
Storehouse for various things used in library, i.e. sudoku board examples.

Version:

1.1.1

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`	`AVAILABLE_RND_BOARD_TRANSF` Number of available random board transformations.
`static int`	`DEFAULT_RND_TRANSF_SEQ_LENGTH` Default sequence length of random board transformations.
`static String`	`JANET_SUDOKU_NAME` Sudoku solver name.
`static String`	`JANET_SUDOKU_VERSION` Sudoku solver version.
`static String`	`NEW_LINE_SEPARATOR` System specific new line separator
`static int`	`NUMBER_OF_PUZZLE_EXAMPLES` Number of Sudoku puzzles examples.
`static int`	`THREADS_NUMBER` Threads number.

Constructor Summary

Constructors
Constructor and Description

SudokuStore()

Constructors
Constructor and Description
`SudokuStore()`

Method Summary

Methods
Modifier and Type	Method and Description
`static String`	`boardAndEmptyCellsToString(int[][] sudokuBoard, int[][] emptyCells)` Returns string representation of the board and empty cells.
`static int[][]`	`boardCopy(int[][] sudokuBoard)` Exact (1 to 1) copy of Sudoku board array.
`static boolean`	`boardsAreEqual(int[][] board1, int[][] board2)` Checks whether boards are equal.
`static int`	`boardSegmentStartIndex(int segId)` 9x9 Sudoku board consist either 3 row segments (3x9 each one) or 3 column segments (9x3 each one).
`static String`	`boardToString(int[][] sudokuBoard)` Returns string representation of the board.
`static String`	`boardToString(int[][] sudokuBoard, String headComment)` Returns string representation of the board + provided comment.
`static String`	`boardToString(int[][] sudokuBoard, String headComment, String tailComment)` Returns string representation of the board + provided comment.
`static int`	`calculatePuzzleRating(int[][] sudokuPuzzle)` Calculates difficulty of Sudoku puzzle.
`static boolean`	`checkPuzzle(int[][] sudokuBoard)` Checks whether Sudoku puzzle contains an obvious error.
`static boolean`	`checkSolvedBoard(int[][] solvedBoard)` Checks whether solved board is correct.
`static void`	`consolePrintBoard(int[][] sudokuBoard)` Prints Sudoku board to the console.
`static void`	`consolePrintln(Object o)` Prints object to the console.
`static String`	`emptyCellsToString(int[][] emptyCells)` Returns string representation of empty cells (only).
`static int[]`	`generatePermutation(int n)` Permutation generator assuming permuting 0, 1, ..., n-1 for n-length permutation.
`static int[][]`	`getPuzzleExample()` Gets Sudoku example for the Sudoku Store.
`static int[][]`	`getPuzzleExample(int exampleNumber)` Gets Sudoku example for the Sudoku Store.
`static double`	`getPuzzleExampleRating(int exampleNumber)` Returns pre-calculated puzzle example difficulty rating based on the average number of steps-back performed while recursive solving sudoku board.
`static boolean`	`isValidPermutation(int[] permutation)` Checks whether given array of length n is representing valid permutation of 0, 1, ..., n-1
`static boolean`	`isValidPermutation(int[] permutation, int n)` Checks whether given array is representing valid permutation of length n and form of 0, 1, ..., n-1
`static int[][]`	`loadBoard(ArrayList<String> boardDefinition)` Loads Sudoku board from list of strings (each string as a one row) Format: Any character different than '1-9' and '.' is being removed.
`static int[][]`	`loadBoard(String filePath)` Loads Sudoku board from text file.
`static int[][]`	`loadBoard(String[] boardDefinition)` Loads Sudoku board from array of strings (each string as a one row) Format: Any character different than '1-9' and '.' is being removed.
`static int[][]`	`loadBoardFromStringLine(String boardDefinition)` Loads Sudoku board from one string line ('0' and' '.' treated as empty cell).
`static int[][]`	`loadBoardFromStrings(String... boardDefinition)` Loads Sudoku board from variadic list of strings (each string as a one row) Format: Any character different than '1-9' and '.' is being removed.
`static int[][]`	`permuteBoard(int[][] sudokuBoard)` Random permutation of sudoku board.
`static int[][]`	`permuteBoard(int[][] sudokuBoard, int[] permutation)` Sudoku board permutation.
`static int[][]`	`permuteColSegments(int[][] sudokuBoard)` Method applies randomly generated permutation of length 3 (permutation of 0, 1, 2) to the 3 column segments (9x3 each one) of Sudoku array.
`static int[][]`	`permuteColSegments(int[][] sudokuBoard, int[] permutation)` Method applies given permutation of length 3 (permutation of 0, 1, 2) to the 3 column segments (9x3 each one) of Sudoku array.
`static int[][]`	`permuteColsInAllSegments(int[][] sudokuBoard)` Method applies randomly generated permutations of length 3 (permutation of 0, 1, 2) to the 3 columns in a all column segments (9x3 each one) of Sudoku array.
`static int[][]`	`permuteColsInSegment(int[][] sudokuBoard)` Method applies randomly generated permutation of length 3 (permutation of 0, 1, 2) to the 3 columns in a randomly selected column segment (3x9 each one) of Sudoku array.
`static int[][]`	`permuteColsInSegment(int[][] sudokuBoard, int colSeg)` Method applies randomly generated permutation of length 3 (permutation of 0, 1, 2) to the 3 columns in a given column segment (3x9 each one) of Sudoku array.
`static int[][]`	`permuteColsInSegment(int[][] sudokuBoard, int colSeg, int[] permutation)` Method applies given permutation of length 3 (permutation of 0, 1, 2) to the 3 columns in a given column segment (3x9 each one) of Sudoku array.
`static int[][]`	`permuteRowSegments(int[][] sudokuBoard)` Method applies randomly generated permutation of length 3 (permutation of 0, 1, 2) to the 3 row segments (3x9 each one) of Sudoku array.
`static int[][]`	`permuteRowSegments(int[][] sudokuBoard, int[] permutation)` Method applies given permutation of length 3 (permutation of 0, 1, 2) to the 3 row segments (3x9 each one) of Sudoku array.
`static int[][]`	`permuteRowsInAllSegments(int[][] sudokuBoard)` Method applies randomly generated permutations of length 3 (permutation of 0, 1, 2) to the 3 rows in a all row segments (9x3 each one) of Sudoku array.
`static int[][]`	`permuteRowsInSegment(int[][] sudokuBoard)` Method applies randomly generated permutation of length 3 (permutation of 0, 1, 2) to the 3 rows in a randomly selected row segment (9x3 each one) of Sudoku array.
`static int[][]`	`permuteRowsInSegment(int[][] sudokuBoard, int rowSeg)` Method applies randomly generated permutation of length 3 (permutation of 0, 1, 2) to the 3 rows in a given row segment (9x3 each one) of Sudoku array.
`static int[][]`	`permuteRowsInSegment(int[][] sudokuBoard, int rowSeg, int[] permutation)` Method applies given permutation of length 3 (permutation of 0, 1, 2) to the 3 rows in a given row segment (9x3 each one) of Sudoku array.
`static int[][]`	`randomBoardTransf(int[][] sudokuBoard)` Random board transformation of type selected randomly (typed randomly selected between 0 and `AVAILABLE_RND_BOARD_TRANSF`).
`static int[][]`	`randomBoardTransf(int[][] sudokuBoard, int transfId)` Based on the parameter value method applies one of the following board transformation: 0 - `rotateClockWise(int[][])` 1 - `rotateCounterclockWise(int[][])` 2 - `reflectHorizontally(int[][])` 3 - `reflectVertically(int[][])` 4 - `transposeTlBr(int[][])` 5 - `transposeTrBl(int[][])` 6 - `swapRowSegmentsRandomly(int[][])` 7 - `swapColSegmentsRandomly(int[][])` 8 - `swapRowsInSegmentRandomly(int[][])` 9 - `swapColsInSegmentRandomly(int[][])` 10 - `permuteBoard(int[][])` 11 - `permuteRowSegments(int[][])` 12 - `permuteColSegments(int[][])` 13 - `permuteRowsInSegment(int[][])` 14 - `permuteRowsInAllSegments(int[][])` 15 - `permuteColsInSegment(int[][])` 16 - `permuteColsInAllSegments(int[][])`
`static int`	`randomIndex(int n)` Random number generator for n returning random number between 0, 1, ... n-1.
`static int`	`randomNumber(int n)` Random number generator for n returning random number between 1, 2, ... n.
`static int[][]`	`reflectHorizontally(int[][] sudokuBoard)` Horizontal reflection of the Sudoku board.
`static int[][]`	`reflectVertically(int[][] sudokuBoard)` Vertical reflection of the Sudoku board.
`static int[][]`	`rotateClockWise(int[][] sudokuBoard)` Clockwise rotation of Sudoku board.
`static int[][]`	`rotateCounterclockWise(int[][] sudokuBoard)` Counterclockwise rotation of Sudoku board.
`static boolean`	`saveBoard(int[][] sudokuBoard, String filePath)` Saves board to the text file.
`static boolean`	`saveBoard(int[][] sudokuBoard, String filePath, String headComment)` Saves board to the text file.
`static boolean`	`saveBoard(int[][] sudokuBoard, String filePath, String headComment, String tailComment)` Saves board to the text file.
`static int[][]`	`seqOfRandomBoardTransf(int[][] sudokuBoard)` Applies to the Sudoku board sequence (of default length) of transformations selected randomly (each transformation selected randomly between 0 and `AVAILABLE_RND_BOARD_TRANSF`).
`static int[][]`	`seqOfRandomBoardTransf(int[][] sudokuBoard, int seqLength)` Applies to the Sudoku board sequence (of a given length) of transformations selected randomly (each transformation selected randomly between 0 and `AVAILABLE_RND_BOARD_TRANSF`).
`static String`	`solutionPathToString(BoardCell[] solutionBoardCells)` Returns string representation of the 'path' leading to the solution.
`static int[][]`	`swapColSegments(int[][] sudokuBoard, int colSeg1, int colSeg2)` Swapping 2 column segments (9x3 each one) of Sudoku board.
`static int[][]`	`swapColSegmentsRandomly(int[][] sudokuBoard)` Swapping randomly selected 2 column segments (9x3 each one) of Sudoku board.
`static int[][]`	`swapColsInSegment(int[][] sudokuBoard, int colSeg, int col1, int col2)` Swapping 2 columns within a given column segment.
`static int[][]`	`swapColsInSegmentRandomly(int[][] sudokuBoard)` Swapping randomly selected 2 columns within randomly select column segment.
`static int[][]`	`swapRowSegments(int[][] sudokuBoard, int rowSeg1, int rowSeg2)` Swapping 2 row segments (3x9 each one) of Sudoku board.
`static int[][]`	`swapRowSegmentsRandomly(int[][] sudokuBoard)` Swapping randomly selected 2 row segments (3x9 each one) of Sudoku board.
`static int[][]`	`swapRowsInSegment(int[][] sudokuBoard, int rowSeg, int row1, int row2)` Swapping 2 rows within a given row segment.
`static int[][]`	`swapRowsInSegmentRandomly(int[][] sudokuBoard)` Swapping randomly selected 2 rows within randomly select row segment.
`static int[][]`	`transposeTlBr(int[][] sudokuBoard)` Diagonal (Top-Left -> Bottom-Right) reflection of the Sudoku board.
`static int[][]`	`transposeTrBl(int[][] sudokuBoard)` Diagonal (Top-Right -> Bottom-Left) reflection of the Sudoku board.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - JANET_SUDOKU_VERSION
```
public static final String JANET_SUDOKU_VERSION
```
    Sudoku solver version.
    
    See Also:
    Constant Field Values
  - JANET_SUDOKU_NAME
```
public static final String JANET_SUDOKU_NAME
```
    Sudoku solver name.
    
    See Also:
    Constant Field Values
  - NUMBER_OF_PUZZLE_EXAMPLES
```
public static final int NUMBER_OF_PUZZLE_EXAMPLES
```
    Number of Sudoku puzzles examples.
    
    See Also:
    SudokuPuzzles, SudokuPuzzles.NUMBER_OF_PUZZLE_EXAMPLES, Constant Field Values
  - AVAILABLE_RND_BOARD_TRANSF
```
public static final int AVAILABLE_RND_BOARD_TRANSF
```
    Number of available random board transformations.
    
    See Also:
    randomBoardTransf(int[][]), seqOfRandomBoardTransf(int[][]), seqOfRandomBoardTransf(int[][], int), Constant Field Values
  - DEFAULT_RND_TRANSF_SEQ_LENGTH
```
public static final int DEFAULT_RND_TRANSF_SEQ_LENGTH
```
    Default sequence length of random board transformations.
    
    See Also:
    randomBoardTransf(int[][]), seqOfRandomBoardTransf(int[][]), seqOfRandomBoardTransf(int[][], int), Constant Field Values
  - NEW_LINE_SEPARATOR
```
public static final String NEW_LINE_SEPARATOR
```
    System specific new line separator
  - THREADS_NUMBER
```
public static final int THREADS_NUMBER
```
    Threads number.
- Constructor Detail
  - SudokuStore
```
public SudokuStore()
```
- Method Detail
  - getPuzzleExample
```
public static final int[][] getPuzzleExample(int exampleNumber)
```
    Gets Sudoku example for the Sudoku Store.
    
    Parameters:
    exampleNumber - Example number.
    
    Returns:
    Sudoku example is exists, otherwise null.
    See Also:
    SudokuPuzzles.NUMBER_OF_PUZZLE_EXAMPLES, SudokuPuzzles.getPuzzleExample(int)
  - getPuzzleExample
```
public static final int[][] getPuzzleExample()
```
    Gets Sudoku example for the Sudoku Store.
    
    Returns:
    Sudoku example is exists, otherwise null.
    See Also:
    SudokuPuzzles.NUMBER_OF_PUZZLE_EXAMPLES, SudokuPuzzles.getPuzzleExample(int)
  - getPuzzleExampleRating
```
public static final double getPuzzleExampleRating(int exampleNumber)
```
    Returns pre-calculated puzzle example difficulty rating based on the average number of steps-back performed while recursive solving sudoku board.
    
    Parameters:
    exampleNumber - The example number SudokuPuzzles.NUMBER_OF_PUZZLE_EXAMPLES
    
    Returns:
    Puzzle example difficulty rating if example exists, otherwise -1.
  - calculatePuzzleRating
```
public static final int calculatePuzzleRating(int[][] sudokuPuzzle)
```
    Calculates difficulty of Sudoku puzzle. Returned difficulty level is an average of number of closed routes while performing recursive steps in order to find solution. This is multi-threading procedure.
    
    Parameters:
    sudokuPuzzle - Sudoku puzzle to be rated.
    
    Returns:
    If puzzle does not contain an error then difficulty rating is returned. If puzzle contains obvious error then ErrorCodes.SUDOKUSTORE_CALCULATEPUZZLERATING_PUZZLE_ERROR. If puzzle has no solutions then ErrorCodes.SUDOKUSTORE_CALCULATEPUZZLERATING_NO_SOLUTION. If solution is non-unique then ErrorCodes.SUDOKUSTORE_CALCULATEPUZZLERATING_NON_UNIQUE_SOLUTION.
  - loadBoard
```
public static final int[][] loadBoard(String filePath)
```
    Loads Sudoku board from text file. Format: Any character different than '1-9' and '.' is being removed. Any line starting with '#' is being removed. Any empty line is being removed. Any final line having less than 9 characters is being removed. If number of final lines is less then 9 then null is returned. Finally 9 starting characters for first 9 lines is the loaded board definition.
    
    Parameters:
    filePath - Path to the file with Sudoku board definition.
    
    Returns:
    Array representing loaded Sudoku board, null - if problem occurred while loading.
  - loadBoard
```
public static final int[][] loadBoard(ArrayList<String> boardDefinition)
```
    Loads Sudoku board from list of strings (each string as a one row) Format: Any character different than '1-9' and '.' is being removed. Any line starting with '#' is being removed. Any empty line is being removed. Any final line having less than 9 characters is being removed. If number of final lines is less then 9 then null is returned. Finally 9 starting characters for first 9 lines is the loaded board definition.
    
    Parameters:
    boardDefinition - Board definition (list of strings).
    
    Returns:
    Array representing loaded Sudoku board, null - if problem occurred while loading.
  - loadBoard
```
public static final int[][] loadBoard(String[] boardDefinition)
```
    Loads Sudoku board from array of strings (each string as a one row) Format: Any character different than '1-9' and '.' is being removed. Any line starting with '#' is being removed. Any empty line is being removed. Any final line having less than 9 characters is being removed. If number of final lines is less then 9 then null is returned. Finally 9 starting characters for first 9 lines is the loaded board definition.
    
    Parameters:
    boardDefinition - Board definition (array of strings).
    
    Returns:
    Array representing loaded Sudoku board, null - if problem occurred while loading.
  - loadBoardFromStringLine
```
public static final int[][] loadBoardFromStringLine(String boardDefinition)
```
    Loads Sudoku board from one string line ('0' and' '.' treated as empty cell). Any other char than '0', '1', '2', '3', '4', '5', '6', '7', '8', '9', '.' is being filtered out.
    
    Parameters:
    boardDefinition - Board definition in one string line containing row after row.
    
    Returns:
    Loaded board if data is sufficient to fill 81 cells (including empty cells), otherwise null.
  - loadBoardFromStrings
```
public static final int[][] loadBoardFromStrings(String... boardDefinition)
```
    Loads Sudoku board from variadic list of strings (each string as a one row) Format: Any character different than '1-9' and '.' is being removed. Any line starting with '#' is being removed. Any empty line is being removed. Any final line having less than 9 characters is being removed. If number of final lines is less then 9 then null is returned. Finally 9 starting characters for first 9 lines is the loaded board definition.
    
    Parameters:
    boardDefinition - Board definition (variadic list of strings).
    
    Returns:
    Array representing loaded Sudoku board, null - if problem occurred while loading.
  - saveBoard
```
public static final boolean saveBoard(int[][] sudokuBoard,
                String filePath)
```
    Saves board to the text file.
    
    Parameters:
    sudokuBoard - Sudoku board to be saved.
    filePath - Path to the file.
    
    Returns:
    True if saving was successful, otherwise false.
    See Also:
    boardToString(int[][])
  - saveBoard
```
public static final boolean saveBoard(int[][] sudokuBoard,
                String filePath,
                String headComment)
```
    Saves board to the text file.
    
    Parameters:
    sudokuBoard - Sudoku board to be saved.
    filePath - Path to the file.
    headComment - Comment to be added at the head.
    
    Returns:
    True if saving was successful, otherwise false.
    See Also:
    boardToString(int[][], String)
  - saveBoard
```
public static final boolean saveBoard(int[][] sudokuBoard,
                String filePath,
                String headComment,
                String tailComment)
```
    Saves board to the text file.
    
    Parameters:
    sudokuBoard - Sudoku board to be saved.
    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:
    boardToString(int[][], String, String)
  - checkSolvedBoard
```
public static boolean checkSolvedBoard(int[][] solvedBoard)
```
    Checks whether solved board is correct.
    
    Parameters:
    solvedBoard - The solved board to be verified.
    
    Returns:
    True if solved board is correct, otherwise false.
  - checkPuzzle
```
public static boolean checkPuzzle(int[][] sudokuBoard)
```
    Checks whether Sudoku puzzle contains an obvious error.
    
    Parameters:
    sudokuBoard - The board to be verified.
    
    Returns:
    True if no obvious error, otherwise false.
  - rotateClockWise
```
public static final int[][] rotateClockWise(int[][] sudokuBoard)
```
    Clockwise rotation of Sudoku board.
    
    Parameters:
    sudokuBoard - Array representing Sudoku board.
    
    Returns:
    Clockwise rotated sudoku board.
  - rotateCounterclockWise
```
public static final int[][] rotateCounterclockWise(int[][] sudokuBoard)
```
    Counterclockwise rotation of Sudoku board.
    
    Parameters:
    sudokuBoard - Array representing Sudoku board.
    
    Returns:
    Clockwise rotated Sudoku board.
  - reflectHorizontally
```
public static final int[][] reflectHorizontally(int[][] sudokuBoard)
```
    Horizontal reflection of the Sudoku board.
    
    Parameters:
    sudokuBoard - Array representing Sudoku board.
    
    Returns:
    Horizontally reflected Sudoku board.
  - reflectVertically
```
public static final int[][] reflectVertically(int[][] sudokuBoard)
```
    Vertical reflection of the Sudoku board.
    
    Parameters:
    sudokuBoard - Array representing Sudoku board.
    
    Returns:
    Vertically reflected Sudoku board.
  - transposeTlBr
```
public static final int[][] transposeTlBr(int[][] sudokuBoard)
```
    Diagonal (Top-Left -> Bottom-Right) reflection of the Sudoku board.
    
    Parameters:
    sudokuBoard - Array representing Sudoku board.
    
    Returns:
    Diagonally (Top-Left -> Bottom-Right) reflection of the Sudoku board. reflected Sudoku board.
  - transposeTrBl
```
public static final int[][] transposeTrBl(int[][] sudokuBoard)
```
    Diagonal (Top-Right -> Bottom-Left) reflection of the Sudoku board.
    
    Parameters:
    sudokuBoard - Array representing Sudoku board.
    
    Returns:
    Diagonally Top-Right -> Bottom-Left) reflection of the Sudoku board. reflected Sudoku board.
  - swapRowSegments
```
public static final int[][] swapRowSegments(int[][] sudokuBoard,
                      int rowSeg1,
                      int rowSeg2)
```
    Swapping 2 row segments (3x9 each one) of Sudoku board.
    
    Parameters:
    sudokuBoard - Array representing Sudoku board.
    rowSeg1 - First row segment id: 0, 1, 2.
    rowSeg2 - Second row segment id: 0, 1, 2.
    
    Returns:
    New array containing values resulted form swapping row segments procedure. If both segments are equal or one of the segments id is not 0, 1, or 2, then exact copy of original board is returned.
  - swapRowSegmentsRandomly
```
public static final int[][] swapRowSegmentsRandomly(int[][] sudokuBoard)
```
    Swapping randomly selected 2 row segments (3x9 each one) of Sudoku board.
    
    Parameters:
    sudokuBoard - Array representing Sudoku board.
    
    Returns:
    New array containing values resulted form swapping column segments procedure.
  - swapColSegments
```
public static final int[][] swapColSegments(int[][] sudokuBoard,
                      int colSeg1,
                      int colSeg2)
```
    Swapping 2 column segments (9x3 each one) of Sudoku board.
    
    Parameters:
    sudokuBoard - Array representing Sudoku board.
    colSeg1 - First column segment id: 0, 1, 2.
    colSeg2 - Second column segment id: 0, 1, 2.
    
    Returns:
    New array containing values resulted form swapping column segments procedure. If both segments are equal or one of the segments id is not 0, 1, or 2, then exact copy of original board is returned.
  - swapColSegmentsRandomly
```
public static final int[][] swapColSegmentsRandomly(int[][] sudokuBoard)
```
    Swapping randomly selected 2 column segments (9x3 each one) of Sudoku board.
    
    Parameters:
    sudokuBoard - Array representing Sudoku board.
    
    Returns:
    New array containing values resulted form swapping column segments procedure.
  - swapRowsInSegment
```
public static final int[][] swapRowsInSegment(int[][] sudokuBoard,
                        int rowSeg,
                        int row1,
                        int row2)
```
    Swapping 2 rows within a given row segment.
    
    Parameters:
    sudokuBoard - Array representing Sudoku board.
    rowSeg - Row segment id: 0, 1, 2.
    row1 - First row id within a segment: 0, 1, 2.
    row2 - Second row id within a segment: 0, 1, 2.
    
    Returns:
    New array containing values resulted form swapping rows procedure. If both rows are equal or one of the row id is not 0, 1, or 2, then exact copy of original board is returned.
  - swapRowsInSegmentRandomly
```
public static final int[][] swapRowsInSegmentRandomly(int[][] sudokuBoard)
```
    Swapping randomly selected 2 rows within randomly select row segment.
    
    Parameters:
    sudokuBoard - Array representing Sudoku board.
    
    Returns:
    New array containing values resulted form swapping column segments procedure.
  - swapColsInSegment
```
public static final int[][] swapColsInSegment(int[][] sudokuBoard,
                        int colSeg,
                        int col1,
                        int col2)
```
    Swapping 2 columns within a given column segment.
    
    Parameters:
    sudokuBoard - Array representing Sudoku board.
    colSeg - Column segment id: 0, 1, 2.
    col1 - First column id within a segment: 0, 1, 2.
    col2 - Second column id within a segment: 0, 1, 2.
    
    Returns:
    New array containing values resulted form swapping columns procedure. If both columns are equal or one of the id is not 0, 1, or 2, then exact copy of original board is returned.
  - swapColsInSegmentRandomly
```
public static final int[][] swapColsInSegmentRandomly(int[][] sudokuBoard)
```
    Swapping randomly selected 2 columns within randomly select column segment.
    
    Parameters:
    sudokuBoard - Array representing Sudoku board.
    
    Returns:
    New array containing values resulted form swapping column segments procedure.
  - permuteBoard
```
public static final int[][] permuteBoard(int[][] sudokuBoard,
                   int[] permutation)
```
    Sudoku board permutation.
    
    Parameters:
    sudokuBoard - Sudoku board to be permuted.
    permutation - Permutation (ie. 5, 2, 8, 9, 1, 3, 6, 4, 7)
    
    Returns:
    If board is null then null, If permutation is not valid the original board. Otherwise permuted board.
  - permuteBoard
```
public static final int[][] permuteBoard(int[][] sudokuBoard)
```
    Random permutation of sudoku board.
    
    Parameters:
    sudokuBoard - Sudoku board to be permuted.
    
    Returns:
    If sudoku board is ot null then permuted board, otherwise null.
  - permuteRowSegments
```
public static final int[][] permuteRowSegments(int[][] sudokuBoard,
                         int[] permutation)
```
    Method applies given permutation of length 3 (permutation of 0, 1, 2) to the 3 row segments (3x9 each one) of Sudoku array.
    
    Parameters:
    sudokuBoard - Array representing Sudoku board.
    permutation - Array representing permutation of length 3 (permuting: 0, 1, 2).
    
    Returns:
    New array resulting from permutation of given sudokuBoard. If sudokuBoard is null the null is returned. If permutation is not valid copy of original Sudoku board is returned.
  - permuteRowSegments
```
public static final int[][] permuteRowSegments(int[][] sudokuBoard)
```
    Method applies randomly generated permutation of length 3 (permutation of 0, 1, 2) to the 3 row segments (3x9 each one) of Sudoku array.
    
    Parameters:
    sudokuBoard - Array representing Sudoku board.
    
    Returns:
    New array resulting from permutation of given sudokuBoard. If sudokuBoard is null the null is returned.
  - permuteColSegments
```
public static final int[][] permuteColSegments(int[][] sudokuBoard,
                         int[] permutation)
```
    Method applies given permutation of length 3 (permutation of 0, 1, 2) to the 3 column segments (9x3 each one) of Sudoku array.
    
    Parameters:
    sudokuBoard - Array representing Sudoku board.
    permutation - Array representing permutation of length 3 (permuting: 0, 1, 2).
    
    Returns:
    New array resulting from permutation of given sudokuBoard. If sudokuBoard is null the null is returned. If permutation is not valid copy of original Sudoku board is returned.
  - permuteColSegments
```
public static final int[][] permuteColSegments(int[][] sudokuBoard)
```
    Method applies randomly generated permutation of length 3 (permutation of 0, 1, 2) to the 3 column segments (9x3 each one) of Sudoku array.
    
    Parameters:
    sudokuBoard - Array representing Sudoku board.
    
    Returns:
    New array resulting from permutation of given sudokuBoard. If sudokuBoard is null the null is returned.
  - permuteRowsInSegment
```
public static final int[][] permuteRowsInSegment(int[][] sudokuBoard,
                           int rowSeg,
                           int[] permutation)
```
    Method applies given permutation of length 3 (permutation of 0, 1, 2) to the 3 rows in a given row segment (9x3 each one) of Sudoku array.
    
    Parameters:
    sudokuBoard - Array representing Sudoku board.
    rowSeg - Row segment id: 0, 1, 2.
    permutation - Permutation of length 3 (0, 1, 2)
    
    Returns:
    New array resulting from permutation of given sudokuBoard. If sudokuBoard is null the null is returned. If permutation is not valid exact copy of Sudoku board is returned.
    See Also:
    isValidPermutation(int[]), generatePermutation(int)
  - permuteRowsInSegment
```
public static final int[][] permuteRowsInSegment(int[][] sudokuBoard,
                           int rowSeg)
```
    Method applies randomly generated permutation of length 3 (permutation of 0, 1, 2) to the 3 rows in a given row segment (9x3 each one) of Sudoku array.
    
    Parameters:
    sudokuBoard - Array representing Sudoku board.
    rowSeg - Row segment id: 0, 1, 2.
    
    Returns:
    New array resulting from permutation of given sudokuBoard. If sudokuBoard is null the null is returned.
    See Also:
    generatePermutation(int)
  - permuteRowsInSegment
```
public static final int[][] permuteRowsInSegment(int[][] sudokuBoard)
```
    Method applies randomly generated permutation of length 3 (permutation of 0, 1, 2) to the 3 rows in a randomly selected row segment (9x3 each one) of Sudoku array.
    
    Parameters:
    sudokuBoard - Array representing Sudoku board.
    
    Returns:
    New array resulting from permutation of given sudokuBoard. If sudokuBoard is null the null is returned.
    See Also:
    generatePermutation(int)
  - permuteRowsInAllSegments
```
public static final int[][] permuteRowsInAllSegments(int[][] sudokuBoard)
```
    Method applies randomly generated permutations of length 3 (permutation of 0, 1, 2) to the 3 rows in a all row segments (9x3 each one) of Sudoku array. New permutation is generated separately for each row segment.
    
    Parameters:
    sudokuBoard - Array representing Sudoku board.
    
    Returns:
    New array resulting from permutation of given sudokuBoard. If sudokuBoard is null the null is returned.
    See Also:
    generatePermutation(int)
  - permuteColsInSegment
```
public static final int[][] permuteColsInSegment(int[][] sudokuBoard,
                           int colSeg,
                           int[] permutation)
```
    Method applies given permutation of length 3 (permutation of 0, 1, 2) to the 3 columns in a given column segment (3x9 each one) of Sudoku array.
    
    Parameters:
    sudokuBoard - Array representing Sudoku board.
    colSeg - Column segment id: 0, 1, 2.
    permutation - Permutation of length 3 (0, 1, 2)
    
    Returns:
    New array resulting from permutation of given sudokuBoard. If sudokuBoard is null the null is returned. If permutation is not valid exact copy of Sudoku board is returned.
    See Also:
    isValidPermutation(int[]), generatePermutation(int)
  - permuteColsInSegment
```
public static final int[][] permuteColsInSegment(int[][] sudokuBoard,
                           int colSeg)
```
    Method applies randomly generated permutation of length 3 (permutation of 0, 1, 2) to the 3 columns in a given column segment (3x9 each one) of Sudoku array.
    
    Parameters:
    sudokuBoard - Array representing Sudoku board.
    colSeg - Column segment id: 0, 1, 2.
    
    Returns:
    New array resulting from permutation of given sudokuBoard. If sudokuBoard is null the null is returned.
    See Also:
    generatePermutation(int)
  - permuteColsInSegment
```
public static final int[][] permuteColsInSegment(int[][] sudokuBoard)
```
    Method applies randomly generated permutation of length 3 (permutation of 0, 1, 2) to the 3 columns in a randomly selected column segment (3x9 each one) of Sudoku array.
    
    Parameters:
    sudokuBoard - Array representing Sudoku board.
    
    Returns:
    New array resulting from permutation of given sudokuBoard. If sudokuBoard is null the null is returned.
    See Also:
    generatePermutation(int)
  - permuteColsInAllSegments
```
public static final int[][] permuteColsInAllSegments(int[][] sudokuBoard)
```
    Method applies randomly generated permutations of length 3 (permutation of 0, 1, 2) to the 3 columns in a all column segments (9x3 each one) of Sudoku array. New permutation is generated separately for each columns segment.
    
    Parameters:
    sudokuBoard - Array representing Sudoku board.
    
    Returns:
    New array resulting from permutation of given sudokuBoard. If sudokuBoard is null the null is returned.
    See Also:
    generatePermutation(int)
  - randomBoardTransf
```
public static final int[][] randomBoardTransf(int[][] sudokuBoard,
                        int transfId)
```
    Based on the parameter value method applies one of the following board transformation:
    Parameters:
    sudokuBoard - Sudoku board to be transformed
    transfId - Random operation id between 0 and AVAILABLE_RND_BOARD_TRANSF.
    
    Returns:
    Sudoku board resulting from transformation.
  - randomBoardTransf
```
public static final int[][] randomBoardTransf(int[][] sudokuBoard)
```
    Random board transformation of type selected randomly (typed randomly selected between 0 and AVAILABLE_RND_BOARD_TRANSF).
    
    Parameters:
    sudokuBoard - Sudoku board to be transformed.
    
    Returns:
    Sudoku board resulting from transformation.
    See Also:
    randomBoardTransf(int[][], int)
  - seqOfRandomBoardTransf
```
public static final int[][] seqOfRandomBoardTransf(int[][] sudokuBoard,
                             int seqLength)
```
    Applies to the Sudoku board sequence (of a given length) of transformations selected randomly (each transformation selected randomly between 0 and AVAILABLE_RND_BOARD_TRANSF).
    
    Parameters:
    sudokuBoard - Sudoku board to be transformed.
    seqLength - Length of sequence (positive)
    
    Returns:
    Sudoku board resulting from transformations. If seqLengh is lower than 1 then exact copy of Sudoku board is returned.
    See Also:
    randomBoardTransf(int[][], int)
  - seqOfRandomBoardTransf
```
public static final int[][] seqOfRandomBoardTransf(int[][] sudokuBoard)
```
    Applies to the Sudoku board sequence (of default length) of transformations selected randomly (each transformation selected randomly between 0 and AVAILABLE_RND_BOARD_TRANSF). Invocation of seqOfRandomBoardTransf(int[][], int) with sequence length equal to DEFAULT_RND_TRANSF_SEQ_LENGTH.
    
    Parameters:
    sudokuBoard - Sudoku board to be transformed.
    
    Returns:
    Sudoku board resulting from transformations. If seqLengh is lower than 1 then exact copy of Sudoku board is returned.
    See Also:
    randomBoardTransf(int[][], int)
  - randomIndex
```
public static final int randomIndex(int n)
```
    Random number generator for n returning random number between 0, 1, ... n-1.
    
    Parameters:
    n - The parameter influencing random number generation process.
    
    Returns:
    Random number between 0, 1, ... n-1 if n is 1 or above, otherwise error ErrorCodes.SUDOKUSTORE_RANDOMINDEX_INCORRECT_PARAMETER is returned.
  - randomNumber
```
public static final int randomNumber(int n)
```
    Random number generator for n returning random number between 1, 2, ... n.
    
    Parameters:
    n - The parameter influencing random number generation process.
    
    Returns:
    Random number between 1, 2, ... n if n is 1 or above, otherwise error ErrorCodes.SUDOKUSTORE_RANDOMINDEX_INCORRECT_PARAMETER is returned.
  - boardSegmentStartIndex
```
public static final int boardSegmentStartIndex(int segId)
```
    9x9 Sudoku board consist either 3 row segments (3x9 each one) or 3 column segments (9x3 each one). Each segment has its own starting index in Sudoku array representing Sudoku board. For row segments starting index will be giving information on first column, and for column segments starting index shall be interpreted as first row in that segment. All parameters and values start form 0, because they are designed specifically for arrays.
    
    Parameters:
    segId - The segment id: 0, 1, 2
    
    Returns:
    0 for segment 0, 3 for segment 1, 6 for segment 2, otherwise ErrorCodes.SUDOKUSTORE_BOARDSEGMENTSTARTINDEX_INCORRECT_SEGMENT.
  - generatePermutation
```
public static final int[] generatePermutation(int n)
```
    Permutation generator assuming permuting 0, 1, ..., n-1 for n-length permutation.
    
    Parameters:
    n - The permutation length.
    
    Returns:
    If n > 0 permutation array is returned containing n randomly distributed elements with values: 0, 1, ..., n-1. If n is zero or negative null is returned.
  - isValidPermutation
```
public static final boolean isValidPermutation(int[] permutation)
```
    Checks whether given array of length n is representing valid permutation of 0, 1, ..., n-1
    
    Parameters:
    permutation - Array representing permutation
    
    Returns:
    True if permutation is valid, false otherwise.
  - isValidPermutation
```
public static final boolean isValidPermutation(int[] permutation,
                         int n)
```
    Checks whether given array is representing valid permutation of length n and form of 0, 1, ..., n-1
    
    Parameters:
    permutation - Array representing permutation.
    n - Assumed permutation length.
    
    Returns:
    True if permutation is valid, false otherwise.
  - boardCopy
```
public static final int[][] boardCopy(int[][] sudokuBoard)
```
    Exact (1 to 1) copy of Sudoku board array.
    
    Parameters:
    sudokuBoard - The board that will be copied.
    
    Returns:
    New array containing exact copy of given Sudoku board.
  - boardsAreEqual
```
public static final boolean boardsAreEqual(int[][] board1,
                     int[][] board2)
```
    Checks whether boards are equal.
    
    Parameters:
    board1 - First board.
    board2 - Second board.
    
    Returns:
    True if boards are equal, otherwise false (false also for null boards or board having different sizes).
  - boardToString
```
public static final String boardToString(int[][] sudokuBoard)
```
    Returns string representation of the board.
    
    Parameters:
    sudokuBoard - Array representing Sudoku puzzles.
    
    Returns:
    Board (only) representation.
  - boardToString
```
public static final String boardToString(int[][] sudokuBoard,
                   String headComment)
```
    Returns string representation of the board + provided comment.
    
    Parameters:
    sudokuBoard - Sudoku board.
    headComment - Comment to be added at the head.
    
    Returns:
    String representation of the sudoku board.
  - boardToString
```
public static final String boardToString(int[][] sudokuBoard,
                   String headComment,
                   String tailComment)
```
    Returns string representation of the board + provided comment.
    
    Parameters:
    sudokuBoard - Sudoku board.
    headComment - Comment to be added at the head.
    tailComment - Comment to be added at the tail.
    
    Returns:
    String representation of the sudoku board.
  - emptyCellsToString
```
public static final String emptyCellsToString(int[][] emptyCells)
```
    Returns string representation of empty cells (only).
    
    Parameters:
    emptyCells - Array representing empty cells of Sudoku puzzles.
    
    Returns:
    Empty cells (only) string representation.
  - boardAndEmptyCellsToString
```
public static final String boardAndEmptyCellsToString(int[][] sudokuBoard,
                                int[][] emptyCells)
```
    Returns string representation of the board and empty cells.
    
    Parameters:
    sudokuBoard - Array representing Sudoku puzzles.
    emptyCells - Array representing empty cells of Sudoku puzzles.
    
    Returns:
    Board and empty cells representation.
  - solutionPathToString
```
public static final String solutionPathToString(BoardCell[] solutionBoardCells)
```
    Returns string representation of the 'path' leading to the solution.
    
    Parameters:
    solutionBoardCells - Array representing sequence of board cells.
    
    Returns:
    String representation of sequence of board cells.
  - consolePrintBoard
```
public static final void consolePrintBoard(int[][] sudokuBoard)
```
    Prints Sudoku board to the console.
    
    Parameters:
    sudokuBoard - Sudoku board to be printed
  - consolePrintln
```
public static final void consolePrintln(Object o)
```
    Prints object to the console.
    
    Parameters:
    o - Object to be printed.

Class SudokuStore

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

JANET_SUDOKU_VERSION

JANET_SUDOKU_NAME

NUMBER_OF_PUZZLE_EXAMPLES

AVAILABLE_RND_BOARD_TRANSF

DEFAULT_RND_TRANSF_SEQ_LENGTH

NEW_LINE_SEPARATOR

THREADS_NUMBER

Constructor Detail

SudokuStore

Method Detail

getPuzzleExample

getPuzzleExample

getPuzzleExampleRating

calculatePuzzleRating

loadBoard

loadBoard

loadBoard

loadBoardFromStringLine

loadBoardFromStrings

saveBoard

saveBoard

saveBoard

checkSolvedBoard

checkPuzzle

rotateClockWise

rotateCounterclockWise

reflectHorizontally

reflectVertically

transposeTlBr

transposeTrBl

swapRowSegments

swapRowSegmentsRandomly

swapColSegments

swapColSegmentsRandomly

swapRowsInSegment

swapRowsInSegmentRandomly

swapColsInSegment

swapColsInSegmentRandomly

permuteBoard

permuteBoard

permuteRowSegments

permuteRowSegments

permuteColSegments

permuteColSegments

permuteRowsInSegment

permuteRowsInSegment

permuteRowsInSegment

permuteRowsInAllSegments

permuteColsInSegment

permuteColsInSegment

permuteColsInSegment

permuteColsInAllSegments

randomBoardTransf

randomBoardTransf

seqOfRandomBoardTransf

seqOfRandomBoardTransf

randomIndex

randomNumber

boardSegmentStartIndex

generatePermutation

isValidPermutation

isValidPermutation

boardCopy

boardsAreEqual

boardToString

boardToString

boardToString

emptyCellsToString

boardAndEmptyCellsToString

solutionPathToString

consolePrintBoard

consolePrintln