Skip to content

Commit

Permalink
Improved the docs
Browse files Browse the repository at this point in the history
  • Loading branch information
programarivm committed Dec 19, 2024
1 parent 77ac51c commit 80f536b
Show file tree
Hide file tree
Showing 2 changed files with 23 additions and 3 deletions.
20 changes: 20 additions & 0 deletions src/FenHeuristics.php
Original file line number Diff line number Diff line change
Expand Up @@ -7,12 +7,32 @@
use Chess\Variant\AbstractBoard;
use Chess\Variant\Classical\PGN\AN\Color;

/**
* FEN Heuristics
*
* Discrete ternary oscillations of a game in terms of heuristic evaluation
* features.
*/
class FenHeuristics
{
/**
* Discrete oscillations of a game.
*
* @var array
*/
public array $result = [];

/**
* The ternarized result.
*
* @var array
*/
public array $balance = [];

/**
* @param \Chess\Function\AbstractFunction $function
* @param \Chess\Variant\AbstractBoard $board
*/
public function __construct(AbstractFunction $function, AbstractBoard $board)
{
foreach ($function->getEval() as $val) {
Expand Down
6 changes: 3 additions & 3 deletions src/Media/BoardToFenSignal.php
Original file line number Diff line number Diff line change
Expand Up @@ -13,8 +13,8 @@
/**
* FEN Signal
*
* Discrete ternary oscillations of a game in terms of heuristic evaluation
* features are encoded in a one-dimensional array of integer values.
* Discrete ternary oscillations of a game are encoded in a one-dimensional
* array of integer values.
*/
class BoardToFenSignal
{
Expand All @@ -28,7 +28,7 @@ class BoardToFenSignal
/**
* One-dimensional array of integer values.
*
* @var string
* @var array
*/
public array $signal;

Expand Down

0 comments on commit 80f536b

Please sign in to comment.