Data

Tools

Indexes

Applications

Experiments

Awesome

An open API service indexing awesome lists of open source software.

https://github.com/mateuszkubuszok/masterthesis

Master Thesis snapshot - permanently frozen
https://github.com/mateuszkubuszok/masterthesis

Last synced: 7 months ago
JSON representation

Master Thesis snapshot - permanently frozen

Awesome Lists containing this project

README 

        
# Game Theory Tools



[![Build Status](https://travis-ci.org/MateuszKubuszok/MasterThesis.png)](https://travis-ci.org/MateuszKubuszok/MasterThesis)



Project of a tool for finding Nash equilibria for given Games. Currently should be able to find:



* pure-strategy Nash equilibria for strategic-form games,

* mixed-strategy equilibria for 2 player strategic-form games,

* pure strategy equilibria for extensive form games without nature and with perfect information.



## Requirements



Project is written with a C++ language, and so it requires some C++ compiler to be present. It also makes

use of GNU Multiple Precision library, and several of Boost libraries. These tools should be available in

the user's environment for a program to compile.



Compilations and dependencies are managed by a SCons tool. As such Python and SCons installations are also

required.



GTL parser uses Flex and Bison tools to build `.cpp` files.



### Linux pre-requirements installation



On Debian (and Debian-based distributions) dependencies can be installed by calling

`sudo apt-get install g++ bison flex libgmp-dev glpk libboost-all-dev scons`.



On Ubuntu Precise it is necessary to install `libboost1.48-all-dev` instead of `libboost-all-dev` and

`g++-4.8` instead of `g++` to make it work. `scons` would be then called  `CXX=g++4.8 scons [arguments]`.



During development program has been successfully building with:



 * **g++** version *4.7.2*,

 * **bison** version *2.5*,

 * **flex** version *2.5.35*,

 * **gmp** version *2.5.0.5+dfsg-2*,

 * **glpk** version *4.45-1*,

 * **boost** version *1.49*,

 * **scons** version *2.1.0.r5357[MODIFIED]*,



on *Debian 7.2 Stable* (*Wheezy*).



### Windows pre-requirements installation



On *Windows 7* the project was successfully built with *Cygwin* and following items installed:



 * Devel:

    * **gcc-core** version *4.8.2*,

    * **gcc-c++** version *4.8.2*,

    * **bison** version *2.7.1-1*,

    * **flex** version *2.5.35-3*,

    * **scons** version *2.3.0-5*,

 * Math:

    * **gmp** version *5.1.3-1*,

    * **libgmp-devel** version *5.1.3-1*,

    * **libgmp10** version *5.1.3-1*,

    * **libgmpxx4** version *5.1.3-1*,

    * **glpk** version *4.45-1*,

    * **libglpk-devel** version *4.45-1*,

    * **libglpk.35** version *4.45-1*



as well as their required dependencies.



Boost libraries need to be build separately and manually since version provided with Cygwin doesn't contain e.g.

*Boost Unit Test Framework* - version *1.54* is known to work well. After extracting source to directory of

choice call commands under Cygwin terminal:



    cd [boost directory]

    ./bootstrap.sh

    ./b2 install --prefix=[cygwin directory]                                   # for x86 (32-bit)

    ./b2 install --prefix=[cygwin directory] architecture=x86 address-model=64 # for x86_64 (64-bit)



making sure that chosen architecture matches Cygwin's one. Alternatively you might try any other tutorial

explaining how to install Boost on Windows and make it visible to Cygwin environment. Also make sure that

`--prefix` points to the root directory of Cygwin installation - this way `[prefix]/lib` will match

`[Cygwin]/lib` and so on.



### Clang instead of GCC



Project can be built with Clang compiler. It should be noted though that there is a "bug" in a Boost library

(in version prior to 1.50.0-beta1) that would fail building process:



    ...

    /usr/include/boost/container/allocator/allocator_traits.hpp:167:54: error: missing 'typename' prior to dependent type name 'boost::intrusive::detail::type_rebinder::type'

         template  using rebind_alloc  = boost::intrusive::detail::type_rebinder::type;

                                                     ^~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~



In version 1.54 used on Travis CI there is no such error, as it was removed in a commit

[between 1.49 and 1.50.0-beta1 release](https://github.com/boostorg/container/commit/7f1456c30fa5ed58af912d67352f55bc961be55e).



## Building process



To build program navigate in console to a root directory of a checked out project and type `scons`. Program

should be built automatically.



Object files will be placed in `objects/` directory.



Executables  will be placed in `bin/` directory.



Builder can also run specified tasks:



 * `scons -Q buildModels` - builds Models' classes,

 * `scons -Q buildModelsTests` - builds Models' test classes with dependencies,

 * `scons -Q runModelsTests` - runs Models' test classes building theirs dependencies,

 * `scons -Q buildRoutines` - builds Routines' classes,

 * `scons -Q buildRoutinesTests` - builds Routines' test classes with dependencies,

 * `scons -Q runRoutinesTests` - runs Routines' test classes building theirs dependencies,

 * `scons -Q buildParserClasses` - builds Parser and Scanner with yacc (bison) and lex (flex),

 * `scons -Q buildGTL` - builds GTL classes,

 * `scons -Q buildGTLTests` - builds GTL test classes with dependencies,

 * `scons -Q runGTLTests` - runs GTL test classes building theirs dependencies,

 * `scons -Q buildPrograms` - builds Program's Controllers classes,

 * `scons -Q buildProgramsTests` - builds Program's Controllers test classes with dependencies,

 * `scons -Q runProgramsTests` - runs Program's Controllers test classes building theirs dependencies,

 * `scons -Q buildExecutables` - builds actual executables,

 * `scons -Q buildLibraries` - builds static and shared library with Models and Routines.



### Clang



To build project using Clang you should run builder like this: `CXX=clang++ CC=clang scons` provided

that you have Boost version at least `1.50.0-beta1`.



### Debug symbols



To build with debug symbols run builder with argument `debug=1`.



### Optimization



To turn on optimization run with builder argument `optimize=1`.



### Static linking



To make executables (`gtl_program`) statically linked run SCons with argument `static=1`. Note, that this

would require having installed static versions of all required libraries, otherwise linker will fail.



## Running tests



To run tests manually call

`bin/ModelsTests && bin/RoutinesTests && bin/GTLTests && bin/ProgramsTests`.

Notice that they will be run automatically during build as well.



For more information you can run each of them with `--log_level=test_suite` parameter.



## Running program



To run program you need to execute `./gtl_program` command. If not set otherwise it will read from standard

input and write to standard output and standard error. More information can be found when run with `--help`

argument: `./gtl_program --help`.



Some examples of correct GTL syntax can be found in `examples` directory.



## Generating documentation



To generate documentation `Doxygen` at least version `1.8.5` is required. Versions prior to `1.8.2` did not

have C++11 support, and will generate invalid documentation due to e.g. `final` specifier usage.



Before running Doxygen execute `scone -Q buildParserClasses` task to make sure that flex-and-bison generated

files are present during the generation of documentation.



To generate public API - the one actually intended to use by a programmer - run command

`doxygen doxygen/public_api`from main directory.



To generate full documentation - the one documenting all classes, including those intended to be hidden from

programmer - run command `doxygen doxygen/private_api` from main directory.



## Documentation



Documentation itself can also be found [here](https://github.com/MateuszKubuszok/MasterThesis/wiki).



Additional information about SCons builder can be found on a [project's site](http://www.scons.org/).



## License



Game Theory Tools - tools for calculating Nash equilibria.

Copyright (C) 2013-2014  Mateusz Kubuszok



This program is free software: you can redistribute it and/or modify it under the terms of the GNU Affero

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 Affero General Public

License for more details.



Full license can be found [here](LICENSE.md) or on [gnu.org](http://www.gnu.org/licenses/).