Sudoku Test

Table of Contents

• Description
• Task
• Technologies Used
• Getting Started
• Usage
• Function Descriptions
• Project Structure
• License
• Acknowledgements

Description

A Node.js application for validating Sudoku solutions by ensuring each row, column, and 3x3 block contains unique values and no zeros.

Key Features:

• Validates Sudoku solutions for unique values in rows, columns, and blocks.
• Ensures no zeros are present in the final Sudoku grid.
• Modular and easily extendable for additional functionality.
• Simple and intuitive API for checking Sudoku grids.

Task

You can find the task details here.

Technologies Used

• Node.js
• JavaScript (ES6 Modules)

Getting Started

To get started with this project, follow these steps:

Prerequisites

• Node.js installed on your machine.

Installation

1. Clone the repository:

   git clone https://github.com/your-username/sudokutest.git.

2. Navigate to the project directory:

   cd sudokutest

Usage

To validate Sudoku solutions, run the following command:

npm test

This will execute the script to check the Sudoku grids defined in the validArray.js and invalidArray.js files.

Function Descriptions

getUniqueValues(): Returns an array of unique values from the input array.

   function getUniqueValues(arr) {
       return [...new Set(arr)];
   }

findZeros(): Checks if there are any zeros in the Sudoku grid.

function findZeros(array) {
    let isNoZero = true;

    for (let row = 0; row < array.length; row++) {
        for (let col = 0; col < array[row].length; col++) {
            if (array[row][col] === 0) {
                isNoZero = false;
                break;
            }
        }
        if (!isNoZero) break;
    }
    return isNoZero;
};

hasUniqueRows(): Checks if each row in the Sudoku grid contains unique values.

function hasUniqueRows(array) {
    for (let i = 0; i < array.length; i++) {
        let row = array[i];
        if (row.length !== getUniqueValues(row).length) {
            return false;
        }
    }
    return true;
};

hasUniqueColumns(): Checks if each 3x3 block in the Sudoku grid contains unique values.

function hasUniqueColumns(array) {
    for (let i = 0; i < array.length; i++) {
        let column = array.map(row => row[i]);
        if (column.length !== getUniqueValues(column).length) {
            return false;
        }
    }
    return true;
};

hasUniqueBlocks(): Checks if each 3x3 block in the Sudoku grid contains unique values.

function hasUniqueBlocks(array) {
    const blockArray = [];
    for (let rowStart = 0; rowStart < array.length; rowStart += array.length / 3) {
        for (let colStart = 0; colStart < array.length; colStart += array.length / 3) {
            const block = [];
            for (let i = 0; i < array.length / 3; i++) {
                for (let j = 0; j < array.length / 3; j++) {
                    block.push(array[rowStart + i][colStart + j]);
                }
            }
            blockArray.push(block);
        }
    }
    return hasUniqueRows(blockArray);
};

validSolution(): Combines all checks (rows, columns, blocks, and zeros) to validate the Sudoku solution.

function validateSudoku(array) { 
    if (!findZeros(array)) { 
        return false; 
    } 
    if (!hasUniqueRows(array)) { 
        return false; 
    } 
    if (!hasUniqueColumns(array)) { 
        return false; 
    } 
    if (!hasUniqueBlocks(array)) { 
        return false; 
    } 
    return true; 
}; 

Project Structure

sudokutest/
├── invalidArray.js                   -- Contains the invalid Sudoku grid for testing
├── index.js                          -- Main script for validating Sudoku solutions
├── validArray.js                     -- Contains the valid Sudoku grid for testing
├── .gitignore                        -- Git ignore file
├── package.json                      -- Project dependencies and scripts
├── TASK.md                           -- Task documentation
└── README.md                         -- Project documentation

License

This project is licensed under the MIT License. You are free to use, modify, and distribute this project. See the LICENSE file for more details. MIT License

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Acknowledgements

• Inspired by the classic Sudoku puzzle game.
• This project was developed as part of a personal learning exercise.
• Special thanks to the open-source community for their invaluable resources and tools. 😊