moved case study from javascript to python

CHANGELOG.md

@@ -3,6 +3,11 @@ All notable changes to this project will be documented in this file.
 This project adheres to [Semantic Versioning](http://semver.org/).
 
 ## [Unreleased][unreleased]
+### Added
+- Case study Tic Tac Toe
+
+### Changed
+- License
 
 ## [v0.2.0] - 2015-10-27
 ### Added

README.md

@@ -68,6 +68,6 @@ checking [my contact details](https://gitlab.science.ru.nl/u/mvolpato).
 
 ## License
 
-[This license](./LICENSE) applies to most of the files. Some files may have a different license. If so, the license can be faound at the top of the source code.
+[This license](./LICENSE) applies to most of the files. Some files may have a different license. If so, the license can be found at the top of the source code.
 
 If no license is found at the top of the source, [this license](./LICENSE) is applied.

examples/tictactoe/tictactoe.java

+/* Copyright Stephen Ostermiller 2002-2014
+
+This program is free software; you can redistribute it and/or modify it under
+the terms of the GNU General Public License as published by the
+Free Software Foundation; either version 2 of the License, or (at your option)
+any later version.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
+or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
+for more details. */
+
+var turn = -1;
+var xWon = 0;
+var oWon = 0;
+var catsGame = 0;
+var cells;
+function makeCells(){
+    var b = document.board;
+    cells = new Array(b.c1,b.c2,b.c3,b.c4,b.c5,b.c6,b.c7,b.c8,b.c9)
+}
+
+function loadStats(){
+    var cookie = getCookie('tictactoeStats');
+    if (cookie != null && cookie.length > 1){
+        var stats = cookie.substring(1,cookie.length);
+        if (stats != null){
+            var statsSplit = stats.split(':');
+            var temp;
+            if (statsSplit.length == 3){
+                var re = new RegExp("^([0-9]*)$");
+                if (re.test(statsSplit[0])) xWon = eval(statsSplit[0]);
+                if (re.test(statsSplit[1])) oWon = eval(statsSplit[1]);
+                if (re.test(statsSplit[2])) catsGame = eval(statsSplit[2]);
+                drawStats();
+            }
+        }
+    }
+}
+
+function nextTurn(){
+    turn = -turn;
+    if (turn == 1){
+        if(document.board.p1.selectedIndex == 1) beginnerMove();
+        if(document.board.p1.selectedIndex == 2) intermediateMove();
+        if(document.board.p1.selectedIndex == 3) experiencedMove();
+        if(document.board.p1.selectedIndex == 4) perfectMove();
+    } else {
+        if(document.board.p2.selectedIndex == 1) beginnerMove();
+        if(document.board.p2.selectedIndex == 2) intermediateMove();
+        if(document.board.p2.selectedIndex == 3) experiencedMove();
+        if(document.board.p2.selectedIndex == 4) perfectMove();
+    }
+}
+
+function getLegalMoves(state){
+    var moves = 0;
+    for (var i=0; i<9; i++){
+        if ((state & (1<<(i*2+1))) == 0){
+            moves |= 1 << i;
+        }
+    }
+    return moves;
+}
+
+function moveRandom(moves){
+    var numMoves = 0;
+    for (var i=0; i<9; i++){
+        if ((moves & (1<<i)) != 0) numMoves++;
+    }
+    if (numMoves > 0){
+        var moveNum = Math.ceil(Math.random()*numMoves);
+        numMoves = 0;
+        for (var j=0; j<9; j++){
+            if ((moves & (1<<j)) != 0) numMoves++;
+            if (numMoves == moveNum){
+                move(cells[j]);
+                return;
+            }
+        }
+    }
+}
+
+function openingBook(state){
+    var mask = state & 0x2AAAA;
+    if (mask == 0x00000) return 0x1FF;
+	if (mask == 0x00200) return 0x145;
+    if (mask == 0x00002 ||
+        mask == 0x00020 ||
+        mask == 0x02000 ||
+        mask == 0x20000) return 0x010;
+    if (mask == 0x00008) return 0x095;
+    if (mask == 0x00080) return 0x071;
+    if (mask == 0x00800) return 0x11C;
+    if (mask == 0x08000) return 0x152;
+    return 0;
+}
+
+function perfectMove(){
+    var state = getState();
+    var winner = detectWin(state);
+    if (winner == 0){
+        var moves = getLegalMoves(state);
+        var hope = -999;
+        var goodMoves = openingBook(state);
+        if (goodMoves == 0){
+            for (var i=0; i<9; i++){
+                if ((moves & (1<<i)) != 0) {
+                    var value = moveValue(state, i, turn, turn, 15, 1);
+                    if (value > hope){
+                        hope = value;
+                        goodMoves = 0;
+                    }
+                    if (hope == value){
+                        goodMoves |= (1<<i);
+                    }
+                }
+            }
+        }
+        moveRandom(goodMoves);
+    }
+}
+
+function moveValue(istate, move, moveFor, nextTurn, limit, depth){
+    var state = stateMove(istate, move, nextTurn);
+    var winner = detectWin(state);
+    if ((winner & 0x300000) == 0x300000){
+        return 0;
+    } else if (winner != 0){
+        if (moveFor == nextTurn) return 10 - depth;
+        else return depth - 10;
+    }
+    var hope = 999;
+    if (moveFor != nextTurn) hope = -999;
+    if(depth == limit) return hope;
+    var moves = getLegalMoves(state);
+    for (var i=0; i<9; i++){
+        if ((moves & (1<<i)) != 0) {
+            var value = moveValue(state, i, moveFor, -nextTurn, 10-Math.abs(hope), depth+1);
+            if (Math.abs(value) != 999){
+                if (moveFor == nextTurn && value < hope){
+                    hope = value;
+                } else if (moveFor != nextTurn && value > hope){
+                    hope = value;
+                }
+            }
+        }
+    }
+    return hope;
+}
+
+function detectWinMove(state, cellNum, nextTurn){
+    var value = 0x3;
+    if (nextTurn == -1) value = 0x2;
+    var newState = state | (value << cellNum*2);
+    return detectWin(newState);
+}
+
+function beginnerMove(){
+    var state = getState();
+    var winner = detectWin(state);
+    if (winner == 0) moveRandom(getLegalMoves(state));
+}
+
+function getGoodMove(state){
+	var moves = getLegalMoves(state);
+    for (var i=0; i<9; i++){
+        if ((moves & (1<<i)) != 0) {
+            if (detectWinMove(state, i, turn)){
+                move(cells[i]);
+                return 0;
+            }
+        }
+    }
+    for (var j=0; j<9; j++){
+        if ((moves & (1<<j)) != 0) {
+            if (detectWinMove(state, j, -turn)){
+                move(cells[j]);
+                return 0;
+            }
+        }
+    }
+    return moves;
+}
+
+
+function intermediateMove(){
+    var state = getState();
+    var winner = detectWin(state);
+    if (winner == 0) {
+        moveRandom(getGoodMove(state));
+    }
+}
+
+function experiencedMove(){
+    var state = getState();
+    var winner = detectWin(state);
+    if (winner == 0) {
+        var moves = openingBook(state);
+        if (state == 0) moves = 0x145;
+        if (moves == 0) moves = getGoodMove(state);
+        moveRandom(moves);
+    }
+}
+
+function getState(){
+    var state = 0;
+    for (var i=0; i<9; i++){
+        var cell = cells[i];
+        var value = 0;
+        if (cell.value.indexOf('X') != -1) value = 0x3;
+        if (cell.value.indexOf('O') != -1) value = 0x2;
+        state |= value << (i*2);
+    }
+    return state;
+}
+
+function detectWin(state){
+    if ((state & 0x3F000) == 0x3F000) return 0x13F000;
+    if ((state & 0x3F000) == 0x2A000) return 0x22A000;
+    if ((state & 0x00FC0) == 0x00FC0) return 0x100FC0;
+    if ((state & 0x00FC0) == 0x00A80) return 0x200A80;
+    if ((state & 0x0003F) == 0x0003F) return 0x10003F;
+    if ((state & 0x0003F) == 0x0002A) return 0x20002A;
+    if ((state & 0x030C3) == 0x030C3) return 0x1030C3;
+    if ((state & 0x030C3) == 0x02082) return 0x202082;
+    if ((state & 0x0C30C) == 0x0C30C) return 0x10C30C;
+    if ((state & 0x0C30C) == 0x08208) return 0x208208;
+    if ((state & 0x30C30) == 0x30C30) return 0x130C30;
+    if ((state & 0x30C30) == 0x20820) return 0x220820;
+    if ((state & 0x03330) == 0x03330) return 0x103330;
+    if ((state & 0x03330) == 0x02220) return 0x202220;
+    if ((state & 0x30303) == 0x30303) return 0x130303;
+    if ((state & 0x30303) == 0x20202) return 0x220202;
+    if ((state & 0x2AAAA) == 0x2AAAA) return 0x300000;
+    return 0;
+}
+
+function recordWin(winner){
+    if ((winner & 0x300000) == 0x100000){
+        xWon++;
+    } else if ((winner & 0x300000) == 0x200000){
+        oWon++;
+    } else if ((winner & 0x300000) == 0x300000){
+        catsGame++;
+    }
+    drawStats();
+}
+
+function drawStats(){
+    var b = document.board;
+	var totalGames = xWon + oWon + catsGame;
+    b.xWon.value = xWon;
+    b.oWon.value = oWon;
+    b.catsGame.value = catsGame;
+	b.xWonPer.value = ((xWon==0)?0:(Math.round(xWon * 1000 / totalGames) / 10)) + '%';
+    b.oWonPer.value = ((oWon==0)?0:(Math.round(oWon * 1000 / totalGames) / 10)) + '%';
+    b.catsGamePer.value = ((catsGame==0)?0:(Math.round(catsGame * 1000 / totalGames) / 10)) + '%';
+    var cookie = ':' + xWon + ':' + oWon + ':' + catsGame;
+    var expires = new Date();
+    // cookie expires in one year
+    expires.setTime(expires.getTime() + 365 * 24 * 60 * 60 * 1000);
+    document.cookie = (
+        'tictactoeStats' + '=' +
+        escape(cookie) +
+        '; expires=' + expires.toGMTString()
+    );
+}
+
+function clearStats(){
+	xWon = 0;
+    oWon = 0;
+    catsGame = 0;
+    drawStats();
+}
+
+function drawState(state){
+    var winner = detectWin(state);
+    if ((winner & 0x300000) != 0){
+        if ((winner & 0x300000) == 0x100000){
+            xWon++;
+        } else if ((winner & 0x300000) == 0x200000){
+            oWon++;
+        } else {
+            catsGame++;
+        }
+        drawStats();
+    }
+    for (var i=0; i<9; i++){
+        var value = '';
+        if ((state & (1<<(i*2+1))) != 0){
+            if ((state & (1<<(i*2))) != 0){
+                value = 'X';
+            } else {
+                value = 'O';
+            }
+        }
+        if ((winner & (1<<(i*2+1))) != 0){
+            if (cells[i].style){
+                cells[i].style.backgroundColor='red';
+            } else {
+                value = '*' + value + '*';
+            }
+        } else {
+            if (cells[i].style){
+                cells[i].style.backgroundColor='green';
+            }
+        }
+        cells[i].value = value;
+    }
+}
+
+function stateMove(state, move, nextTurn){
+    var value = 0x3;
+    if (nextTurn == -1) value = 0x2;
+    return (state | (value << (move*2)));
+}
+
+function move(cell){
+    if (cell.value == ''){
+        var state = getState();
+        var winner = detectWin(state);
+        if (winner == 0){
+            for (var i=0; i<9; i++){
+                if (cells[i] == cell){
+                    state = stateMove(state, i, turn);
+                }
+            }
+            drawState(state);
+            nextTurn();
+        }
+    }
+}
+function countMoves(state){
+    var count = 0;
+    for (var i=0; i<9; i++){
+        if ((state & (1<<(i*2+1))) != 0){
+           count++;
+        }
+    }
+    return count;
+}
+
+function newGame(){
+    var state = getState();
+    var winner = detectWin(state);
+    if (winner == 0 && countMoves(state) > 1){
+        if (turn == 1) oWon++;
+        else xWon++;
+        drawStats();
+    }
+    drawState(0);
+    if (document.board.firstMove[0].checked=='1'){
+        turn = -1;
+    } else {
+        turn = 1;
+    }
+    nextTurn();
+}
+
+function getCookie(name) {
+  var prefix = name + "=";
+  var begin = document.cookie.indexOf("; " + prefix);
+  if (begin == -1) {
+    begin = document.cookie.indexOf(prefix);
+    if (begin != 0) return null;
+  } else
+    begin += 2;
+  var end = document.cookie.indexOf(";", begin);
+  if (end == -1)
+    end = document.cookie.length;
+  return unescape(document.cookie.substring(begin + prefix.length, end));
+}

examples/tictactoe/tictactoe.py

+# Tic Tac Toe
+# python version of the javascript found at http://ostermiller.org/calc/tictactoe.html
+
+    # Copyright 2015 Michele Volpato - m.volpato@cs.ru.nl
+    #
+    # This program (Tic Tac Toe) is free software: you can redistribute it and/or modify
+    # it under the terms of the GNU General Public License as published by
+    # the Free Software Foundation, either version 3 of the License, or
+    # (at your option) any later version.
+    #
+    # This program is distributed in the hope that it will be useful,
+    # but WITHOUT ANY WARRANTY; without even the implied warranty of
+    # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+    # GNU General Public License for more details.
+    #
+    # You should have received a copy of the GNU General Public License
+    # along with this program.  If not, see <http://www.gnu.org/licenses/>.
+    #
+    #   ---------------------------------------------------------------
+    #
+    # This program is derived from Tic-Tac-Toe at  http://ostermiller.org/calc/tictactoe.html
+    # Copyright Stephen Ostermiller 2002-2014
+
+import random
+random.seed(100)
+
+turn = -1
+xWon = 0
+oWon = 0
+catsGame = 0
+cells = []
+
+# start with player 1 human and player 2 intermediate
+p1_index = 0
+p2_index = 2
+
+# start with player 1
+firstMove = 1
+
+def makeCells():
+    # code cells as list of strings
+    #  7 | 8 | 9
+    #  4 | 5 | 6
+    #  1 | 2 | 3
+    global cells
+    cells = ['','','','','','','','','']
+
+# loadStats not needed
+
+def nextTurn():
+    global turn
+    turn = 0 - turn;
+    if (turn == 1):
+        if(p1_index == 1):
+             beginnerMove()
+        if(p1_index == 2):
+            intermediateMove()
+        if(p1_index == 3):
+            experiencedMove()
+        if(p1_index == 4):
+            perfectMove()
+    else:
+        if(p2_index == 1):
+            beginnerMove()
+        if(p2_index == 2):
+            intermediateMove()
+        if(p2_index == 3):
+            experiencedMove()
+        if(p2_index == 4):
+            perfectMove()
+
+def getLegalMoves(state):
+    moves = 0;
+    for i in range(9):
+        if ((state & (1<<(i*2+1))) == 0):
+            moves |= 1 << i
+    return moves
+
+def moveRandom(moves):
+    numMoves = 0;
+    for i in range(9):
+        if ((moves & (1<<i)) != 0):
+            numMoves += 1
+
+    if numMoves > 0:
+        moveNum = random.sample(range(numMoves), 1)[0]
+        numMoves = 0;
+        for j in range(9):
+            if ((moves & (1<<j)) != 0):
+                numMoves += 1
+            if (numMoves == moveNum):
+                move(j)
+                return
+
+def openingBook(state):
+    mask = state & int('0x2AAAA', 16)
+    if (mask == 0x00000):
+        return 0x1FF
+    if (mask == 0x00200):
+        return 0x145
+    if (mask == 0x00002 or mask == 0x00020 or mask == 0x02000 or mask == 0x20000):
+        return 0x010
+    if (mask == 0x00008):
+        return 0x095
+    if (mask == 0x00080):
+        return 0x071
+    if (mask == 0x00800):
+        return 0x11C
+    if (mask == 0x08000):
+        return 0x152
+    return 0
+
+def perfectMove():
+    state = getState()
+    winner = detectWin(state)
+    if (winner == 0):
+        moves = getLegalMoves(state)
+        hope = -999;
+        goodMoves = openingBook(state)
+        if (goodMoves == 0):
+            for i in range(9):
+                if ((moves & (1<<i)) != 0):
+                    value = moveValue(state, i, turn, turn, 15, 1);
+                    if (value > hope):
+                        hope = value
+                        goodMoves = 0
+                    if (hope == value):
+                        goodMoves |= (1<<i)
+        moveRandom(goodMoves)
+
+def moveValue(istate, move, moveFor, nextTurn, limit, depth):
+    state = stateMove(istate, move, nextTurn)
+    winner = detectWin(state)
+    if ((winner & 0x300000) == 0x300000):
+        return 0
+    elif (winner != 0):
+        if (moveFor == nextTurn):
+            return 10 - depth
+        else:
+            return depth - 10
+
+    hope = 999
+    if (moveFor != nextTurn):
+        hope = -999
+    if (depth == limit):
+        return hope
+    moves = getLegalMoves(state)
+    for i in range(9):
+        if ((moves & (1<<i)) != 0):
+            value = moveValue(state, i, moveFor, -nextTurn, 10-Math.abs(hope), depth+1)
+            if (Math.abs(value) != 999):
+                if (moveFor == nextTurn and value < hope):
+                    hope = value
+                elif (moveFor != nextTurn and value > hope):
+                    hope = value
+    return hope
+
+def detectWinMove(state, cellNum, nextTurn):
+    value = 0x3
+    if (nextTurn == -1):
+        value = 0x2
+    newState = state | (value << cellNum*2)
+    return detectWin(newState)
+
+def beginnerMove():
+    state = getState()
+    winner = detectWin(state)
+    if (winner == 0):
+        moveRandom(getLegalMoves(state))
+
+def getGoodMove(state):
+    moves = getLegalMoves(state)
+    for i in range(9):
+        if ((moves & (1<<i)) != 0):
+            if (detectWinMove(state, i, turn)):
+                move(i)
+                return 0
+    for j in range(9):
+        if ((moves & (1<<j)) != 0):
+            if (detectWinMove(state, j, -turn)):
+                move(j)
+                return 0
+    return moves
+
+def intermediateMove():
+    state = getState()
+    winner = detectWin(state)
+    if (winner == 0):
+        moveRandom(getGoodMove(state))
+
+def experiencedMove():
+    state = getState()
+    winner = detectWin(state)
+    if (winner == 0):
+        moves = openingBook(state)
+        if (state == 0):
+            moves = 0x145
+        if (moves == 0):
+            moves = getGoodMove(state)
+        moveRandom(moves)
+
+def getState():
+    state = 0
+    for i in range(9):
+        cell = cells[i]
+        value = 0
+        if (cell == 'X'):
+            value = 0x3
+        if (cell <