File Coverage

blib/lib/Chess/Rep/Coverage.pm

Criterion	Covered	Total	%
statement	145	183	79.2
branch	38	64	59.3
condition	23	32	71.8
subroutine	11	17	64.7
pod	3	3	100.0
total	220	299	73.5

package Chess::Rep::Coverage;
our $AUTHORITY = 'cpan:GENE';

# ABSTRACT: Expose chess ply potential energy

use strict;
use warnings;

use parent 'Chess::Rep';

use constant SIZE => 7;

our $VERSION = '0.1103';


sub coverage {
    my $self = shift;

    # Get the state of the board
    my $fen = $self->get_fen;

    # Bucket of piece coverages to return
    my $cover = {};

    # Set the numerical id => piece name lookup table
    my %pieces;
    @pieces{values %{+Chess::Rep::PIECE_TO_ID()}} = keys %{+Chess::Rep::PIECE_TO_ID()};

    # Look at each board position.
    for my $row (0 .. SIZE) {
        for my $col (0 .. SIZE) {
            my $p = $self->get_piece_at($row, $col); # decimal of index
            if ($p) {
                my $c = Chess::Rep::piece_color($p); # 0=black, 0x80=white
                my $i = Chess::Rep::get_index($row, $col); # $row << 4 | $col
                my $f = Chess::Rep::get_field_id($i); # A-H, 1-8

                # Set the coverage properties for the piece.
                $cover->{$f}{occupant} = $pieces{$p};
                $cover->{$f}{piece} = $p;
                $cover->{$f}{color} = $c;
                $cover->{$f}{index} = $i;
                $cover->{$f}{protects} = [];
                $cover->{$f}{threatens} = [];

                # Kings are special-cased.
                if ($p & 0x04) {
                    # Collect the moves of the piece.
                    $cover->{$f}{move} = $self->_fetch_new_moves($f, $i, $c);

                    # Inspect the positions surrounding the king.
                    for my $m ([$row, $col + 1], [$row + 1, $col], [$row + 1, $col + 1], [$row + 1, $col - 1],
                               [$row, $col - 1], [$row - 1, $col], [$row - 1, $col - 1], [$row - 1, $col + 1]
                    ) {
                        my $x = Chess::Rep::get_index(@$m);
                        next if $x & 0x88;
                        $self->_set_piece_status($cover, $f, $x, $c);
                    }
                }
                # Attacking pawns are special-cased.
                elsif (($p & 0x01) && $self->to_move != $c) {
                    my $moves = $c == 0
                        ? [ [$row - 1, $col + 1], [$row - 1, $col - 1] ]
                        : [ [$row + 1, $col + 1], [$row + 1, $col - 1] ];
                    # Add diagonal positions unless occupied.
                    for my $m (@$moves) {
                        next if $m->[0] < 0 || $m->[0] > SIZE
                             || $m->[1] < 0 || $m->[1] > SIZE;
                        my $x = Chess::Rep::get_index(@$m);
                        $self->_set_piece_status($cover, $f, $x, $c);
                        # Collect the moves of the piece.
                        push @{ $cover->{$f}{move} }, $x;
                    }
                }
                else {
                    # Invert the FEN to compute all possible moves, threats and protections.
                    my $inverted = _invert_fen($fen, $row, $col, $c);
                    $self->set_from_fen($inverted);

                    # Collect the moves of the piece.
                    $cover->{$f}{move} = $self->_fetch_new_moves($f, $i, $c);

                    # Reset original game FEN.
                    $self->set_from_fen($fen);

                    # Find the threats and protections by the piece.
                    $self->_set_piece_status($cover, $f, $_, $c) for @{$cover->{$f}{move}};
                }
            }
        }
    }

    # Compute piece and position status.
    for my $piece (keys %$cover) {
        $cover->{$piece}{is_threatened_by} ||= [];
        $cover->{$piece}{is_protected_by} ||= [];

        # Compute protection status of a piece.
        for my $index (@{$cover->{$piece}{protects}}) {
            my $f = Chess::Rep::get_field_id($index); # A-H, 1-8
            push @{$cover->{$f}{is_protected_by}}, $cover->{$piece}{index};
        }

        # Compute threat status of a piece.
        for my $index (@{$cover->{$piece}{threatens}}) {
            my $f = Chess::Rep::get_field_id($index); # A-H, 1-8
            push @{$cover->{$f}{is_threatened_by}}, $cover->{$piece}{index};
        }

        # Compute move status of a position.
        for my $index (@{$cover->{$piece}{move}}) {
            my $p = $self->get_piece_at($index);
            if (!$p) {
                my $f = Chess::Rep::get_field_id($index); # A-H, 1-8

                $cover->{$f}{white_can_move_here} ||= [];
                $cover->{$f}{black_can_move_here} ||= [];

                my $color = $cover->{$piece}{color} ? 'white' : 'black';
                push @{$cover->{$f}{$color . '_can_move_here'}}, $cover->{$piece}{index};
            }
        }
    }

    # Set the object coverage attribute.
    $self->_cover($cover);

    return $cover;
}

sub _invert_fen {
    my ($fen, $row, $col, $color) = @_;

    # Grab the board positions only.
    my $suffix = '';
    if ($fen =~ /^(.+?)\s(.*)$/) {
        ($fen, $suffix) = ($1, $2);
    }
    # Convert pieces to all black or all white, given the piece color.
    $fen = $color ? lc $fen : uc $fen;
    # Split the FEN into rows.
    my @fen = split /\//, $fen; # rows: 7..0, cols: 0..7
    # The FEN sections are the rows reversed.
    $row = SIZE - $row;

    my $position = 0;
    my $counter = 0;
    # Inspect each character in the row to find the position of the piece to invert.
    for my $i (split //, $fen[$row]) {
        # Increment the position if we are on a digit.
        if ($i =~ /^\d$/) {
            $position += $i;
        }
        else {
            # Invert the piece character (to its original state) or increment the position.
            if ($position == $col) {
                substr($fen[$row], $counter, 1) = $i ^ "\x20";
                last;
            }
            else {
                # Next!
                $position++;
            }
        }

        # Increment the loop counter.
        $counter++;
    }

    return join('/', @fen) . " $suffix";
}

sub _fetch_new_moves {
    my $self = shift;
    my($field, $index, $color) = @_;
    # Set the "next to move" color to the piece.
    $self->to_move($color);
    # Recompute the move status.
    $self->compute_valid_moves;
    # TODO Pawns can move diagonally to capture. That is a valid move in the abstract.
    # Collect the moves of the piece.
    return [ map { $_->{to} } grep { $_->{from} == $index } @{ $self->status->{moves} } ];
}

sub _set_piece_status {
    my $self = shift;
    my($cover, $field, $index, $color) = @_;
    # Only consider positions with pieces.
    my $p = $self->get_piece_at($index);
    return unless $p;
    # Set the protection or threat status of the piece.
    if (Chess::Rep::piece_color($p) == $color) {
        # Any piece can be protected but a king.
        push @{$cover->{$field}{protects}}, $index
            unless $p == 4 or $p == 132;
    }
    else {
        # Any piece can be threatened.
        push @{$cover->{$field}{threatens}}, $index;
    }
}

sub _cover {
    my $self = shift;
    $self->{cover} = shift if @_;
    return $self->{cover};
}


sub board {
    my $self = shift;
    my %args = @_;

    # Compute coverage if has not been done yet.
    $self->coverage unless $self->_cover;

    # Start rendering the board.
    my $board = _ascii_board('header');
    $board .= _ascii_board('row');

    # Look at each board position.
    for my $row (reverse(1 .. 8)) {
        # Render the beginning of the row.
        $board .= $row . _ascii_board('cell_pad');

        for my $col ('A' .. 'H') {
            # Render a new cell.
            $board .= _ascii_board('new_cell');

            # Inspect the coverage at the column and row position.
            if ($self->_cover->{$col . $row}) {
                if (exists $self->_cover->{$col . $row}->{is_protected_by} and
                    exists $self->_cover->{$col . $row}->{is_threatened_by}
                ) {
                    # Show threat and protection status.
                    my $protects = $self->_cover->{$col . $row}->{is_protected_by};
                    my $threats  = $self->_cover->{$col . $row}->{is_threatened_by};
                    $board .= @$protects . '/' . @$threats;
#                    $board .= $self->_cover->{$col . $row}->{occupant};
                }
                elsif (exists $self->_cover->{$col . $row}->{white_can_move_here} and
                       exists $self->_cover->{$col . $row}->{black_can_move_here}
                ) {
                    # Show player movement status.
                    my $whites = $self->_cover->{$col . $row}->{white_can_move_here};
                    my $blacks = $self->_cover->{$col . $row}->{black_can_move_here};
                    $board .= @$whites . ':' . @$blacks;
#                    $board .= $self->_cover->{$col . $row}->{occupant};
                }
            }
            else {
                # Render an empty cell.
                $board .= _ascii_board('empty_cell');
            }

            # Render the end of a cell.
            $board .= _ascii_board('cell_pad');
            # Render the end of a column if we have reached the last.
            $board .= _ascii_board('col_edge') if $col eq 'H';
        }

        # Render the end of a row.
        $board .= "\n" . _ascii_board('row');
    }

    return $board;
}

sub _ascii_board {
    my $section = shift;

    my ($cells, $size, $empty) = (8, 5, 3);

    my %board = (
        cell_pad => ' ',
        col_edge => '|',
        corner   => '+',
        row_edge => '-',
    );
    $board{edge} = $board{corner} . ($board{row_edge} x $size);
    $board{row} = ($board{cell_pad} x ($empty - 1)) . ($board{edge} x $cells) . $board{corner} . "\n";
    $board{empty_cell} = $board{cell_pad} x $empty;
    $board{new_cell} = $board{col_edge} . $board{cell_pad};
    $board{header} = ($board{cell_pad} x $size) . join($board{cell_pad} x $size, 'A' .. 'H') . "\n";

    return $board{$section};
}


sub move_probability {
    my ($moves, $threat, $threatened, $protect, $protected) = @ARGV;

    # Bail-out unless the number of moves (greater than or equal to 0).
    die _usage() unless $moves and $moves >= 0;

    # Set threat penalty and protection rewards.
    $threat = _set_level('threat', $threat, $moves);
    $protect = _set_level('protect', $protect, $moves);

    # Create a piece that is unprotected, unthreatened and unbounded.
    my $piece = [ map { 1 / $_ } ($moves) x $moves ];

    # Apply threatened and protected states to move probabilities.
    $piece = _influence($threatened, $threat, $piece, 'threat');
    _output_state($piece);
    $piece = _influence($protected, $protect, $piece);
    _output_state($piece);
}

sub _influence {
    my($influenced, $score, $piece, $state) = @_;

    # "Move along. Nothing to compute here."
    return $piece unless $influenced;

    # Convenience variable for "size of piece" == "number of moves."
    my $size = @$piece - 1;

    # Traverse the influenced moves and compute the probabilities.
    for my $move (split ',', $influenced) {
        # Move counter.
        my $n = 0;

        # Re-evaluate each move given the threat value.
        for my $p (@$piece) {
            if ($n + 1 == $move) {
                # We've found an influenced move!
                $p = $state
                    ? $p - $score  # For threats, add the score to the move.
                    : $p + $score; # For protection, subract from the move.
            }
            else {
                # All moves not influenced.
                if ($size != 0) {
                    $p = $state
                        ? $p + $score / $size  # For threats, subtract a fraction of the score.
                        : $p - $score / $size; # For protection, add a fraction of the score.
                }
            }

            # Increment the move number of the piece.
            $n++;
        }
    }

    # Make sure all elements sum to 1.
    _cross_check($piece);

    return $piece;
}

sub _output_state {
    my $piece = shift;
    my $i = 0;
    print 'P: ', join(' ', map { sprintf '%d:%.4f', ++$i, $_ } @$piece), "\n";
}

sub _set_level {
    my ($level, $value, $moves) = @_;

    # Unless given, default value is zero.
    $value = defined $value ? $value : 0;
    # Bail out unless the value is either zero or greater than moves.
    die ucfirst($level) . "level must be zero or more.\n" if $value < 0;

    # Set a non-zero value in relation to the number of moves.
    $value = $moves + $value - 1 if $value > 0;

    # Make value something that can be used in probability equations.
    $value = 1 / $value if $value != 0;

    return $value;
}

sub _cross_check {
    my $vector = shift;
    my $sum = 0;
    # Make sure all elements sum to unity.
    $sum += $_ for @$vector;
    # TODO Make == work, instead of eq.
    warn "Sum: $sum\n" if $sum ne '1';
}

sub _usage {
    return <

Compute probabilites of chess moves in a protective, threatening environment.

Usage: perl $0 [0-9...] [0-9...] [t1,t2...] [0-9...] [p1,p2...]

Ordered arguments:
 'moves' is the number of moves of a piece.
    For example, a unobstructed knight can make eight moves.
 'threat' is the value or score of a single threat.
 'threatened moves' is a CSV list of threatened move numbers.
    This means that you can be captured by your enemy if you move there.
 'protect' is the value or score of a single protection.
 'protected moves' is a CSV list of protected move numbers.
    This means that you will be protected by an ally if you move there.

Examples:
 perl move-probability 8              # An unobstructed, unprotected knight
 perl move-probability 8 1            # Same
 perl move-probability 8 1 0          # Ditto
 perl move-probability 8 1 0 1        # "
 perl move-probability 8 1 0 1 0      # Right. Gotchya. 10-4 Good buddy.
 perl move-probability 8 1 1,8        # Threaten the 1st & 8th moves.
 perl move-probability 8 0 0 1 1,2    # Protect the 1st & 2nd moves.
 perl move-probability 8 1 1,8 1 1,2  # Protect & threaten
 perl move-probability 8 10 1,8       # Threaten with a penalty of 10.

* This logic does not treat "not making a move" as a value, at the moment...
USAGE
}

1;

__END__