Ryuk/Sudoku
3
1
Fork 0
Code Issues 8 Pull Requests Actions Projects Releases 1 Wiki Activity

fix : doc
All checks were successful
Linux arm64 / Build (push) Successful in 42s
Details

Browse Source
This commit is contained in:
Melvyn
2025-02-02 23:54:56 +01:00
parent 78537be4e9
commit 6a54635c59
8 changed files with 33 additions and 37 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
app/src/main/java/sudoku/constraint/Constraint.java
View File

@@ -37,8 +37,4 @@ public enum Constraint {
} }
} }
public static String[] getConstraintNames() {
return constraintNames;
}
} }

28
app/src/main/java/sudoku/io/ConsoleInterface.java
View File

@@ -88,7 +88,7 @@ public class ConsoleInterface {
* et le laisse jouer. * et le laisse jouer.
* *
* @param doku MultiDoku, MultiDoku vide à remplir * @param doku MultiDoku, MultiDoku vide à remplir
* @param listSymbols List<String>, liste des symboles à utiliser * @param listSymbols List~String~, liste des symboles à utiliser
* @param width int, largeur d'un bloc du sudoku * @param width int, largeur d'un bloc du sudoku
* @param height int, hauteur d'un bloc du sudoku * @param height int, hauteur d'un bloc du sudoku
*/ */
@@ -119,7 +119,7 @@ public class ConsoleInterface {
* quand souhaité. * quand souhaité.
* *
* @param doku MultiDoku, MultiDoku vide à remplir * @param doku MultiDoku, MultiDoku vide à remplir
* @param listSymbols List<String>, liste des symboles à utiliser * @param listSymbols List~String~, liste des symboles à utiliser
* @param width int, largeur d'un bloc du sudoku * @param width int, largeur d'un bloc du sudoku
* @param height int, hauteur d'un bloc du sudoku * @param height int, hauteur d'un bloc du sudoku
*/ */
@@ -214,7 +214,7 @@ public class ConsoleInterface {
* l'affichage. * l'affichage.
* *
* @param numberOfSymbols int, nombre de symboles à choisir * @param numberOfSymbols int, nombre de symboles à choisir
* @return LIst<String>, liste des symboles à utiliser * @return LIst~String~, liste des symboles à utiliser
*/ */
private List<String> pickSymbols(int numberOfSymbols) { private List<String> pickSymbols(int numberOfSymbols) {
System.out.println("Would you like to pick the " + numberOfSymbols System.out.println("Would you like to pick the " + numberOfSymbols
@@ -248,7 +248,7 @@ public class ConsoleInterface {
* Permet à l'utilisateur de choisir les contraintes qu'il souhaite utiliser * Permet à l'utilisateur de choisir les contraintes qu'il souhaite utiliser
* pour son sudoku. * pour son sudoku.
* *
* @return List<IConstraint>, liste des contraintes à utiliser * @return List~IConstraint~, liste des contraintes à utiliser
*/ */
private List<IConstraint> getListConstraints() { private List<IConstraint> getListConstraints() {
List<IConstraint> listConstraints = SudokuFactory.DEFAULT_CONSTRAINTS; List<IConstraint> listConstraints = SudokuFactory.DEFAULT_CONSTRAINTS;
@@ -298,7 +298,7 @@ public class ConsoleInterface {
* Affiche le doku passé en paramètre. * Affiche le doku passé en paramètre.
* *
* @param doku MultiDoku, MultiDoku à afficher * @param doku MultiDoku, MultiDoku à afficher
* @param listSymbols List<String>, liste des symboles à utiliser * @param listSymbols List~String~, liste des symboles à utiliser
* @param width int, largeur d'un bloc du sudoku * @param width int, largeur d'un bloc du sudoku
* @param height int, hauteur d'un bloc du sudoku * @param height int, hauteur d'un bloc du sudoku
*/ */
@@ -310,7 +310,7 @@ public class ConsoleInterface {
* Affiche le doku passé en paramètre. * Affiche le doku passé en paramètre.
* *
* @param doku RenderableMultiDoku, MultiDoku à afficher * @param doku RenderableMultiDoku, MultiDoku à afficher
* @param listSymbols List<String>, liste des symboles à utiliser * @param listSymbols List~String~, liste des symboles à utiliser
* @param width int, largeur d'un bloc du sudoku * @param width int, largeur d'un bloc du sudoku
* @param height int, hauteur d'un bloc du sudoku * @param height int, hauteur d'un bloc du sudoku
*/ */
@@ -340,7 +340,7 @@ public class ConsoleInterface {
* ou de quitter l'application. * ou de quitter l'application.
* *
* @param doku MultiDoku, MultiDoku actuel * @param doku MultiDoku, MultiDoku actuel
* @param listSymbols List<String>, liste des symboles à utiliser * @param listSymbols List~String~, liste des symboles à utiliser
* @param width int, largeur d'un bloc du sudoku * @param width int, largeur d'un bloc du sudoku
* @param height int, hauteur d'un bloc du sudoku * @param height int, hauteur d'un bloc du sudoku
*/ */
@@ -377,7 +377,7 @@ public class ConsoleInterface {
* Permet d'afficher une étape de résolution du doku complété. * Permet d'afficher une étape de résolution du doku complété.
* *
* @param doku MultiDoku, MultiDoku actuel * @param doku MultiDoku, MultiDoku actuel
* @param listSymbols List<String>, liste des symboles à utiliser * @param listSymbols List~String~, liste des symboles à utiliser
* @param width int, largeur d'un bloc du sudoku * @param width int, largeur d'un bloc du sudoku
* @param height int, hauteur d'un bloc du sudoku * @param height int, hauteur d'un bloc du sudoku
* @param step SolverStep, étape de résolution à afficher * @param step SolverStep, étape de résolution à afficher
@@ -399,10 +399,10 @@ public class ConsoleInterface {
* le souhaite. * le souhaite.
* *
* @param doku MultiDoku, MultiDoku actuel * @param doku MultiDoku, MultiDoku actuel
* @param listSymbols List<String>, liste des symboles à utiliser * @param listSymbols List~String~, liste des symboles à utiliser
* @param width int, largeur d'un bloc du sudoku * @param width int, largeur d'un bloc du sudoku
* @param height int, hauteur d'un bloc du sudoku * @param height int, hauteur d'un bloc du sudoku
* @param steps List<SolverStep>, liste des étapes de résolution * @param steps List~SolverStep~, liste des étapes de résolution
*/ */
private void showSolveSteps(MultiDoku doku, List<String> listSymbols, int width, int height, private void showSolveSteps(MultiDoku doku, List<String> listSymbols, int width, int height,
List<SolverStep> steps) { List<SolverStep> steps) {
@@ -420,7 +420,7 @@ public class ConsoleInterface {
* Résout le doku en fonction du solver que choisit l'utilisateur. * Résout le doku en fonction du solver que choisit l'utilisateur.
* *
* @param doku MultiDoku, MultiDoku actuel * @param doku MultiDoku, MultiDoku actuel
* @param listSymbols List<String>, liste des symboles à utiliser * @param listSymbols List~String~, liste des symboles à utiliser
* @param width int, largeur d'un bloc du sudoku * @param width int, largeur d'un bloc du sudoku
* @param height int, hauteur d'un bloc du sudoku * @param height int, hauteur d'un bloc du sudoku
*/ */
@@ -449,7 +449,7 @@ public class ConsoleInterface {
* l'utilisateur choisit. * l'utilisateur choisit.
* *
* @param doku MultiDoku, MultiDoku actuel * @param doku MultiDoku, MultiDoku actuel
* @param listSymbols List<String>, liste des symboles à utiliser * @param listSymbols List~String~, liste des symboles à utiliser
* @param width int, largeur d'un bloc du sudoku * @param width int, largeur d'un bloc du sudoku
* @param height int, hauteur d'un bloc du sudoku * @param height int, hauteur d'un bloc du sudoku
*/ */
@@ -495,7 +495,7 @@ public class ConsoleInterface {
* Renvoie l'index du symbole passé en paramètre. * Renvoie l'index du symbole passé en paramètre.
* *
* @param symbol String, symbole dont on veut l'index * @param symbol String, symbole dont on veut l'index
* @param listSymbols List<String>, liste des symboles possibles * @param listSymbols List~String~, liste des symboles possibles
* @param nbSymbols int, nombre de symboles possibles * @param nbSymbols int, nombre de symboles possibles
* @return int, index du symbole si celui-ci est valide, Cell.NOSYMBOL sinon. * @return int, index du symbole si celui-ci est valide, Cell.NOSYMBOL sinon.
*/ */
@@ -512,7 +512,7 @@ public class ConsoleInterface {
* Vérifie que le symbol passé en paramètre est valide. * Vérifie que le symbol passé en paramètre est valide.
* *
* @param symbol String, symbole dont on vérifie la validité * @param symbol String, symbole dont on vérifie la validité
* @param listSymbols List<String>, liste des symboles possibles * @param listSymbols List~String~, liste des symboles possibles
* @param size int, nombre de symboles possibles * @param size int, nombre de symboles possibles
* @return boolean, valant true si le symbole est valide, false sinon. * @return boolean, valant true si le symbole est valide, false sinon.
*/ */

2
app/src/main/java/sudoku/structure/Block.java
View File

@@ -29,7 +29,7 @@ public class Block {
/** /**
* Crée un Block avec une liste de Cell donnée. * Crée un Block avec une liste de Cell donnée.
* @param cells List<Cell> * @param cells List~Cell~
*/ */
public Block(List<Cell> cells) { public Block(List<Cell> cells) {
this.cells = cells; this.cells = cells;

2
app/src/main/java/sudoku/structure/Cell.java
View File

@@ -131,7 +131,7 @@ public class Cell {
/** /**
* Renvoie les symboles que peut prendre cette Cell par rapport aux contraintes de ses Sudokus. * Renvoie les symboles que peut prendre cette Cell par rapport aux contraintes de ses Sudokus.
* @return List<Integer>, la liste des symboles possibles. * @return List~Integer~, la liste des symboles possibles.
*/ */
public List<Integer> getPossibleSymbols() { public List<Integer> getPossibleSymbols() {
List<Integer> result = new ArrayList<>(); List<Integer> result = new ArrayList<>();

12
app/src/main/java/sudoku/structure/MultiDoku.java
View File

@@ -8,8 +8,8 @@ import java.util.List;
import java.util.Set; import java.util.Set;
/** /**
* @class MultiDoku * Class : MultiDoku
* @brief Représente une grille de Multidoku. * Brief : Représente une grille de Multidoku.
* Une grille de sudoku est un multidoku avec un seul sous-sudoku. * Une grille de sudoku est un multidoku avec un seul sous-sudoku.
*/ */
public class MultiDoku { public class MultiDoku {
@@ -52,7 +52,7 @@ public class MultiDoku {
/** /**
* Renvoie la liste des Cells préalablement remplies du MultiDoku. * Renvoie la liste des Cells préalablement remplies du MultiDoku.
* *
* @return List<Cell>, vide si aucune Cell n'est remplie. * @return List~Cell~, vide si aucune Cell n'est remplie.
*/ */
public List<Cell> getFilledCells() { public List<Cell> getFilledCells() {
List<Cell> result = new ArrayList<>(); List<Cell> result = new ArrayList<>();
@@ -67,7 +67,7 @@ public class MultiDoku {
/** /**
* Renvoie la liste des Cells vides du MultiDoku. * Renvoie la liste des Cells vides du MultiDoku.
* *
* @return List<Cell>, vide si aucune Cell ne l'est. * @return List~Cell~, vide si aucune Cell ne l'est.
*/ */
public List<Cell> getEmptyCells() { public List<Cell> getEmptyCells() {
List<Cell> result = new ArrayList<>(); List<Cell> result = new ArrayList<>();
@@ -117,7 +117,7 @@ public class MultiDoku {
* Renvoie la liste des Cells contenue dans ce MultiDoku, * Renvoie la liste des Cells contenue dans ce MultiDoku,
* soit les Cells contenues de chaques sous-Sudoku. * soit les Cells contenues de chaques sous-Sudoku.
* *
* @return List<Cell> * @return List~Cell~
*/ */
public List<Cell> getCells() { public List<Cell> getCells() {
Set<Cell> cellsSet = new HashSet<>(); Set<Cell> cellsSet = new HashSet<>();
@@ -160,7 +160,7 @@ public class MultiDoku {
/** /**
* Renvoie les sous-Sudoku * Renvoie les sous-Sudoku
* *
* @return List<Sudoku> * @return List~Sudoku~
*/ */
public List<Sudoku> getSubGrids() { public List<Sudoku> getSubGrids() {
return this.subGrids; return this.subGrids;

8
app/src/main/java/sudoku/structure/Sudoku.java
View File

@@ -6,8 +6,8 @@ import sudoku.constraint.IConstraint;
import java.util.List; import java.util.List;
/** /**
* @class Sudoku * Class : Sudoku
* @brief Représent un Sudoku * Brief : Représent un Sudoku
*/ */
public class Sudoku { public class Sudoku {
@@ -203,7 +203,7 @@ public class Sudoku {
/** /**
* Place les symboles d'index contenus dans values dans les cases du Sudoku. * Place les symboles d'index contenus dans values dans les cases du Sudoku.
* *
* @param values List<Integer>, liste des index des symboles à placer. * @param values List~Integer~, liste des index des symboles à placer.
* @return boolean, vaut true si les symboles ont été placés, false sinon. * @return boolean, vaut true si les symboles ont été placés, false sinon.
*/ */
public boolean setCellsSymbol(List<Integer> values) { public boolean setCellsSymbol(List<Integer> values) {
@@ -223,7 +223,7 @@ public class Sudoku {
* Place les symboles d'index contenus dans values dans les cases du Sudoku et * Place les symboles d'index contenus dans values dans les cases du Sudoku et
* rend ces cases immuables. * rend ces cases immuables.
* *
* @param values List<Integer>, liste des index des symboles à placer. * @param values List~Integer~, liste des index des symboles à placer.
* @return boolean, vaut true si les symboles ont été placés, false sinon. * @return boolean, vaut true si les symboles ont été placés, false sinon.
*/ */
public boolean setImmutableCellsSymbol(List<Integer> values) { public boolean setImmutableCellsSymbol(List<Integer> values) {

12
app/src/main/java/sudoku/structure/SudokuFactory.java
View File

@@ -36,7 +36,7 @@ public class SudokuFactory {
* Créée des Cells et les met dans une liste de taille size. * Créée des Cells et les met dans une liste de taille size.
* *
* @param size int, nombre de Cells à initialiser. * @param size int, nombre de Cells à initialiser.
* @return List<Cell>, liste des Cells initialisées. * @return List~Cell~, liste des Cells initialisées.
*/ */
private static List<Cell> initCells(int size) { private static List<Cell> initCells(int size) {
List<Cell> cells = new ArrayList<>(size * size); List<Cell> cells = new ArrayList<>(size * size);
@@ -50,10 +50,10 @@ public class SudokuFactory {
* Créée des Blocks de taille width par height à partir des cellules données, et * Créée des Blocks de taille width par height à partir des cellules données, et
* les met dans une liste. * les met dans une liste.
* *
* @param cells List<Cell>, liste des Cells à découper en Blocks. * @param cells List~Cell~, liste des Cells à découper en Blocks.
* @param width int, largeur des Blocks à créer. * @param width int, largeur des Blocks à créer.
* @param height int, hauteur des Blocks à créer. * @param height int, hauteur des Blocks à créer.
* @return List<Block>, liste des Blocks créés. * @return List~Block~, liste des Blocks créés.
*/ */
private static List<Block> initRectangleBlocs(List<Cell> cells, int width, int height) { private static List<Block> initRectangleBlocs(List<Cell> cells, int width, int height) {
List<Block> blocs = new ArrayList<>(); List<Block> blocs = new ArrayList<>();
@@ -265,7 +265,7 @@ public class SudokuFactory {
* Crée un Sudoku vide avec les Blocks aléatoires. * Crée un Sudoku vide avec les Blocks aléatoires.
* *
* @param blockSize int, la taille des Block. * @param blockSize int, la taille des Block.
* @param constraints List<IConstraint>, la liste des contraintes. * @param constraints List~IConstraint~, la liste des contraintes.
* @return MultiDoku, avec un seul Sudoku. * @return MultiDoku, avec un seul Sudoku.
*/ */
public static MultiDoku createBasicEmptyRandomBlockDoku(int blockSize, List<IConstraint> constraints) { public static MultiDoku createBasicEmptyRandomBlockDoku(int blockSize, List<IConstraint> constraints) {
@@ -358,8 +358,8 @@ public class SudokuFactory {
/** /**
* Transforme des Constraints en IConstraints correspondants. * Transforme des Constraints en IConstraints correspondants.
* @param constraints List<Constraints> * @param constraints List~Constraints~
* @return List<IConstraints> * @return List~IConstraints~
*/ */
public static List<IConstraint> fromConstraints(List<Constraint> constraints) { public static List<IConstraint> fromConstraints(List<Constraint> constraints) {
List<IConstraint> iconstraints = new ArrayList<>(); List<IConstraint> iconstraints = new ArrayList<>();

2
app/src/test/java/sudoku/solver/SolverTest.java
View File

@@ -18,7 +18,7 @@ import sudoku.structure.Sudoku;
import sudoku.structure.SudokuFactory; import sudoku.structure.SudokuFactory;
class SolverTest { class SolverTest {
private int ns = Cell.NOSYMBOL; private final int ns = Cell.NOSYMBOL;
protected static HumanSolver h; protected static HumanSolver h;
private static RandomSolver r; private static RandomSolver r;
private static MixedSolver m; private static MixedSolver m;