Board

java.lang.Object
- cz.gyarab.util.game.mastermind.Board

```
public class Board
extends java.lang.Object
```
Implementace deskové hry Mastermind - Logik. Deskovou hru hrají dva hráči - jeden hráč tajně umístí barevné kolíčky na hrací pole, druhý se snaží uhodnout nejen zvolené barvy, ale i jejich pořadí. Po každém jeho tipu první hráč ohodnotí pokus umístěním klíčových kolíčků - černý označuje správně zvolenou barvu na správném místě, bílý označuje správnou barvu na špatném místě, kolíček se špatnou barvou se nijak neoznačí.
Varianty:
- Originál (6 barev, 4 sloupce, výchozí), Super/Deluxe (8 barev, 5 sloupců), počet sloupců i barev lze nastavit libovolně
- 8 řad (maximální počet pokusů) místo výchozích 12 (lze zvolit i jiný počet řad)
- neopakující se barva (každý kolíček v tajné kombinaci je v jiné barvě, výchozí je povolení opakujících se barev
- nepovinný kolíček (chybějící kolíček je platná možnost, výchozí je povinný)
- poziční hodnocení (poloha klíčového kolíčku určuje polohu hodnoceného kolíčku tipu, výchozí je bez vztahu k pozici)
- odtajněná kombinace (pouze pro demonstraci funkce, API neposkytuje přístup k tajné barevné kombinace)
Instance se vytváří stavitelem. Hrací panel lze použít jak jako čistou implementaci hry, tak lze také hru vizualizovat. Hra také obsahuje normalizovaný test strategie.
```
 Board mb = Board.builderOriginal().create();
 mb.showWindow();
 mb.newGame();
 mb.uncover();
 for (int i = 0; i < mb.getRows(); i++) {
     if (mb.addGuess(mb.random()).isDone()) {
         System.out.println("Won: " + mb.getCurrent());
         break;
     }
     Utils.sleep(50);
 }
 
```
Since:

1.5

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`Board.Builder` Stavitel (konstruktér) `hrací desky`.
`static interface`	`Board.Display` Zobrazovací API.
`static interface`	`Board.DisplayFactory` Továrna na zobrazovací API.
`static interface`	`Board.Strategy` Strategie (algoritmus) hry.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Verdict`	`addGuess(Peg... guess)` Přidá další tipnutou n-tici do panelu na následující řádek.
`Verdict`	`addGuess(Tuples guess)` Přidá další tipnutou n-tici do panelu na následující řádek.
`static Board.Builder`	`builderCustom(Peg... range)` Vytvoří prázdného stavitele založeného jen na předaných barvách kolíčků.
`static Board.Builder`	`builderOriginal()` Vytvoří stavitele pro originální hru se 6 barevnými kolíčky a 4 sloupci, ve kterých hráč tipuje.
`static Board.Builder`	`builderSuper()` Vytvoří stavitele pro vylepšenou hru s 8 barevnými kolíčky a 5 sloupci, ve kterých hráč tipuje.
`Tuples`	`createTuples()` Vytvoří prázdnou n-tici o šířce počtu sloupců.
`int`	`getColumns()` Vrátí počet sloupců.
`int`	`getCurrent()` Vrátí aktuální číslo řádku, což je řádek, na který se umístí následující tip.
`Tuples`	`getGuess()` Vrátí poslední přidaný tip.
`Tuples`	`getGuess(int row)` Vrátí konkrétní přidaný tip.
`Tuples`	`getGuess(int row, Tuples guess)` Vrátí konkrétní přidaný tip.
`Tuples`	`getRange()` Vrátí kolíčky všech barev jako n-tici.
`Peg[]`	`getRangePegs()` Vrátí kolíčky všech barev jako pole kolíčků.
`java.util.Set<Peg>`	`getRangeSet()` Vrátí kolíčky všech barev jako množinu kolíčků.
`int`	`getRows()` Vrátí počet řádků.
`Verdict`	`getVerdict()` Získá verdikt posledního přidaného tipu.
`Verdict`	`getVerdict(int row)` Vrátí verdikt konkrétního přidaného tipu.
`Verdict`	`getVerdict(Tuples pattern, Tuples guess)` Určí verdikt tipu nanečisto, který by byl vrácen po zavolání `addGuess(cz.gyarab.util.game.mastermind.Tuples)`, pokud by hledanou n-ticí byl `pattern`.
`Tuples[]`	`guessing()` Vrátí všechny možné variace (s opakováním nebo bez podle nastavení možnosti opakování barev).
`void`	`hideWindow()` Skryje vizualizaci.
`boolean`	`isAdvice()` Zjistí, zda má `verdikt` obsahovat také nápovědu.
`boolean`	`isCover()` Zjistí, zda je hledaná n-tice utajená i pro pozorovatele.
`boolean`	`isRetake()` Zjistí, zda se mohou opakovat barvy v hledané n-tici.
`static void`	`main(java.lang.String[] args)` Spustí demonstraci použití této třídy.
`void`	`newGame()` Zahájí novou hru s náhodnou tajnou sekvencí barevných kolíčků.
`void`	`newGame(Peg... pattern)` Zahájí novou hru s konkrétní tajnou sekvencí barevných kolíčků.
`void`	`newGame(Tuples pattern)` Zahájí novou hru s konkrétní tajnou sekvencí barevných kolíčků.
`Tuples`	`random()` Vytvoří n-tici naplněnou náhodnými kolíčky.
`Tuples`	`random(Tuples pattern)` Při opakovaném generování náhodných n-tic může být paměťově neefektivní vytvářet stále nová úložiště.
`Board.Strategy`	`randomStrategy()` Vytvoří triviální strategii řešení náhodnými pokusy.
`void`	`setDisplayFactory(Board.DisplayFactory displayFactory)` Nastaví továrnu na zobrazovací panel.
`void`	`showWindow()` Zobrazí vizualizaci.
`void`	`testStrategy(Board.Strategy strategy)` Spustí a vyhodnotí test strategie hry.
`void`	`uncover()` Při zapnuté vizualizaci se normálně skrytá n-tice odkryje pozorovateli.

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

- Method Detail
  - main
```
public static void main(java.lang.String[] args)
```
    Spustí demonstraci použití této třídy.
    
    Parameters:
    
    args - (ignoruje)
  - builderOriginal
```
public static Board.Builder builderOriginal()
```
    Vytvoří stavitele pro originální hru se 6 barevnými kolíčky a 4 sloupci, ve kterých hráč tipuje.
    
    Returns:
    
    stavitele Original
  - builderSuper
```
public static Board.Builder builderSuper()
```
    Vytvoří stavitele pro vylepšenou hru s 8 barevnými kolíčky a 5 sloupci, ve kterých hráč tipuje.
    
    Returns:
    
    stavitele Super/Deluxe
  - builderCustom
```
public static Board.Builder builderCustom(Peg... range)
```
    Vytvoří prázdného stavitele založeného jen na předaných barvách kolíčků.
    
    Parameters:
    
    range - možnosti pro hru (lze zadat jako jednotlivé objekty i jako pole)
    
    Returns:
    
    stavitele
  - setDisplayFactory
```
public void setDisplayFactory(Board.DisplayFactory displayFactory)
```
    Nastaví továrnu na zobrazovací panel. Pokud je již panel zobrazen, volání nemá žádný efekt.
    
    Parameters:
    
    displayFactory - nová továrna
  - newGame
```
public void newGame()
```
    Zahájí novou hru s náhodnou tajnou sekvencí barevných kolíčků.
  - newGame
```
public void newGame(Peg... pattern)
```
    Zahájí novou hru s konkrétní tajnou sekvencí barevných kolíčků.
    
    Parameters:
    
    pattern - konkrétní hodnota šablony, kterou má hráč uhodnout (jen pro ladící účly)
    
    Throws:
    
    java.lang.IllegalArgumentException - pokud zadaná šablona neobsahuje příslušný počet kolíčků nebo nejsou ze zadaného rozsahu
  - newGame
```
public void newGame(Tuples pattern)
```
    Zahájí novou hru s konkrétní tajnou sekvencí barevných kolíčků.
    
    Parameters:
    
    pattern - konkrétní hodnota šablony, kterou má hráč uhodnout (jen pro ladící účely)
    
    Throws:
    
    java.lang.IllegalArgumentException - pokud zadaná šablona neobsahuje příslušný počet kolíčků nebo nejsou ze zadaného rozsahu
  - createTuples
```
public final Tuples createTuples()
```
    Vytvoří prázdnou n-tici o šířce počtu sloupců.
    
    Returns:
    
    prázdnou n-tici
    
    See Also:
    
    Tuples.setPeg(int, cz.gyarab.util.game.mastermind.Peg)
  - random
```
public Tuples random()
```
    Vytvoří n-tici naplněnou náhodnými kolíčky.
    
    Returns:
    
    náhodnou n-tici
  - random
```
public Tuples random(Tuples pattern)
```
    Při opakovaném generování náhodných n-tic může být paměťově neefektivní vytvářet stále nová úložiště. Tato verze náhodného generátoru n-tic ukládá náhodné kolíčky do předem vytvořeného úložiště.
    
    Parameters:
    
    pattern - znovupoužitelná n-tice, musí být vytvořena ve správném rozměru (shodný počet sloupců)
    
    Returns:
    
    objekt pattern naplněný náhodnými kolíčky
    
    See Also:
    
    createTuples()
  - randomStrategy
```
public Board.Strategy randomStrategy()
```
    Vytvoří triviální strategii řešení náhodnými pokusy. Pro originální hru má tato strategie zhruba 1% úspěšnost (na 100 her v průměru 1 uhodnotí).
    
    Returns:
    
    strategii, která zkouší náhodné pokusy
  - guessing
```
public Tuples[] guessing()
```
    Vrátí všechny možné variace (s opakováním nebo bez podle nastavení možnosti opakování barev).
    
    Returns:
    
    pole všech variací
  - addGuess
```
public Verdict addGuess(Tuples guess)
```
    Přidá další tipnutou n-tici do panelu na následující řádek. Toto je varianta pro tip předaný objektem.
    Při implementaci strategie se nesmí tato metoda volat, ve strategii je tipem návratová hodnota metody Board.Strategy.guess().
    
    Parameters:
    
    guess - tip hráče
    
    Returns:
    
    verdikt
  - addGuess
```
public Verdict addGuess(Peg... guess)
```
    Přidá další tipnutou n-tici do panelu na následující řádek. Toto je varianta pro tip předaný polem nebo čárkami odděleným seznamem kolíčků.
    Při implementaci strategie se nesmí tato metoda volat, ve strategii je tipem návratová hodnota metody Board.Strategy.guess().
    
    Parameters:
    
    guess - tip hráče
    
    Returns:
    
    verdikt
  - getGuess
```
public Tuples getGuess()
```
    Vrátí poslední přidaný tip.
    
    Returns:
    
    poslední přidaný tip
    
    Throws:
    
    java.lang.IllegalStateException - bezprostředně po začátku hry, kdy ještě nebyl žádný tip přidán
  - getGuess
```
public Tuples getGuess(int row)
```
    Vrátí konkrétní přidaný tip. Tipy jsou číslovány od 0. Toto je varianta nešetrná k paměťovému místu, tip se naklonuje v odpovědi, aby nebylo možné zpětně tip měnit.
    
    Parameters:
    
    row - pořadí přidaného tipu: 0 <= row < getCurrent()
    
    Returns:
    
    dříve přidaný tip
  - getGuess
```
public Tuples getGuess(int row,
                       Tuples guess)
```
    Vrátí konkrétní přidaný tip. Tipy jsou číslovány od 0. Toto je varianta s úsporou paměťového místa, tip se zkopíruje do znovupoužitelného úložiště n-tice.
    
    Parameters:
    
    row - pořadí přidaného tipu: 0 <= row < getCurrent()
    
    guess - znovupoužitelná n-tice
    
    Returns:
    
    dříve přidaný tip zkopírovaný do guess
  - getVerdict
```
public Verdict getVerdict()
```
    Získá verdikt posledního přidaného tipu.
    
    Returns:
    
    verdikt posledního přidaného tipu
    
    Throws:
    
    java.lang.IllegalStateException - bezprostředně po začátku hry, kdy ještě nebyl žádný tip přidán
  - getVerdict
```
public Verdict getVerdict(int row)
```
    Vrátí verdikt konkrétního přidaného tipu. Verdikty jsou číslovány od 0.
    
    Parameters:
    
    row - pořadí přidaného tipu: 0 <= row < getCurrent()
    
    Returns:
    
    verdikt konkrétního přidaného tipu
  - getVerdict
```
public Verdict getVerdict(Tuples pattern,
                          Tuples guess)
```
    Určí verdikt tipu nanečisto, který by byl vrácen po zavolání addGuess(cz.gyarab.util.game.mastermind.Tuples), pokud by hledanou n-ticí byl pattern.
    
    Parameters:
    
    pattern - predikovaná hledaná n-tice
    
    guess - testovaný tip
    
    Returns:
    
    stejný verdikt, který by vrátilo volání addGuess(guess), kdyby pattern byla hledaná n-tice
  - getRange
```
public Tuples getRange()
```
    Vrátí kolíčky všech barev jako n-tici. Toto je jediná n-tice odvozená nikoliv od počtu sloupců, ale od počtu barev.
    Poznámka: Vrácená hodnota je kopií originálních dat, takže je možné hodnoty bez vlivu na chod hry měnit. To ale také znamená, že při opakovaném volání se vytvářejí další klony.
    
    Returns:
    
    n-tice kolíčků všech barev
  - getRangePegs
```
public Peg[] getRangePegs()
```
    Vrátí kolíčky všech barev jako pole kolíčků. Toto je jediná n-tice odvozená nikoliv od počtu sloupců, ale od počtu barev.
    Poznámka: Vrácená hodnota je klonem originálních dat, takže je možné hodnoty bez vlivu na chod hry měnit. To ale také znamená, že při opakovaném volání se vytvářejí další klony.
    
    Returns:
    
    n-tice kolíčků všech barev
  - getRangeSet
```
public java.util.Set<Peg> getRangeSet()
```
    Vrátí kolíčky všech barev jako množinu kolíčků. Toto je jediná n-tice odvozená nikoliv od počtu sloupců, ale od počtu barev.
    Poznámka: Vrácená hodnota je neměnitelný obal originálních dat, takže není možné hodnoty měnit. To ale také znamená, že při opakovaném volání se vytvářejí další obaly.
    
    Returns:
    
    n-tice kolíčků všech barev
  - getColumns
```
public int getColumns()
```
    Vrátí počet sloupců.
    
    Returns:
    
    počet sloupců
  - getRows
```
public int getRows()
```
    Vrátí počet řádků.
    
    Returns:
    
    počet řádků
  - getCurrent
```
public int getCurrent()
```
    Vrátí aktuální číslo řádku, což je řádek, na který se umístí následující tip. Platí 0 <= getCurrent() <= getRows(). Nulová hodnota značí, že ještě nepadl v této hře žádný tip, a nejvyšší, že už nelze přidávat další tipy.
    
    Returns:
    
    aktuální číslo řádku
  - isRetake
```
public boolean isRetake()
```
    Zjistí, zda se mohou opakovat barvy v hledané n-tici.
    
    Returns:
    
    true, pokud se barvy mohou opakovat (výchozí hodnota)
    
    See Also:
    
    Board.Builder.setRetake(boolean)
  - isAdvice
```
public boolean isAdvice()
```
    Zjistí, zda má verdikt obsahovat také nápovědu. Ta spočívá v tom, že lze zjistit, který konkrétní kolíček má které hodnocení. Normálně lze z verdiktu poznat jen počet správně umístěných a správně barevných kolíčků.
    
    Returns:
    
    true, pokud je nápověda zapnutá (výchozí je false)
    
    See Also:
    
    Board.Builder.setAdvice(boolean)
  - isCover
```
public boolean isCover()
```
    Zjistí, zda je hledaná n-tice utajená i pro pozorovatele. API neumožňuje přístup k hledané n-tici, avšak je možné při vizualizaci odkrýt jinak skryté kolíčky.
    
    Returns:
    
    true, pokud není hledaná n-tice zobrazena (výchozí)
    
    See Also:
    
    uncover()
  - uncover
```
public void uncover()
```
    Při zapnuté vizualizaci se normálně skrytá n-tice odkryje pozorovateli. Algoritmus nadále nemá přístup k hledané n-tici. Metodu je nutné volat po každém spuštění nové hry.
  - showWindow
```
public void showWindow()
```
    Zobrazí vizualizaci. Výchozím grafickým panelem je Matrix. Implementaci lze změnit před prvním voláním této metody.
  - hideWindow
```
public void hideWindow()
```
    Skryje vizualizaci.
    
    See Also:
    
    showWindow()
  - testStrategy
```
public void testStrategy(Board.Strategy strategy)
```
    Spustí a vyhodnotí test strategie hry. Test v náhodném pořadí nastavuje tajné n-tice a opakovaně se dotazuje strategie na následující tip. Test započítá každé úspěšné řešení a zprůměruje počet nutných pokusů u těchto řešení. Po skončení testu zobrazí statistiku.
    Statistika obsahuje celkový potřebný čas, celkový počet testů (= počet všech variací), celkový počet tipů, počet úspěšných a neúspěšných testů, minimální, maximální a průměrný počet nutných pokusů na úspěšné vyřešení úlohy.
    Při porovnání různých strategií je nutné v první řadě vyhodnotit počet úspěšných řešení. Pouze ty strategie, které ani jednou neminou, je možné dále porovnávat na např. průměrný či maximální počet potřebných pokusů nebo celkový potřebný čas.
    Originální hra obsahuje 6 barev, 4 sloupce a 12 řádků. Pro toto zadání existuje algoritmus, který s jistotou dokáže vyřešit úlohu vždy nejhůře na 5 pokusů. Jednodušší algoritmus dokáže úlohu vždy řešit v průměru na 5 pokusů. Triviální strategie (tipuje náhodně) je úspěšná v cca 1 % případů.
    
    Parameters:
    
    strategy - testovaná strategie

Class Board

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Method Detail

main

builderOriginal

builderSuper

builderCustom

setDisplayFactory

newGame

newGame

newGame

createTuples

random

random

randomStrategy

guessing

addGuess

addGuess

getGuess

getGuess

getGuess

getVerdict

getVerdict

getVerdict

getRange

getRangePegs

getRangeSet

getColumns

getRows

getCurrent

isRetake

isAdvice

isCover

uncover

showWindow

hideWindow

testStrategy