Slot Machine in Python. GitHub Gist: instantly share code, notes, and snippets.
I was bored and that can be a dangerous thing. Like doodling on the phone book while you are talking on the phone, I doodle code while answering questions on DIC. Yeah, it means I have no life and yes it means I was born a coder. During this little doodle I decided to make a slot machine. But not your standard slot machine per say, but one designed a little bit more like the real thing. Sure it could have been done a little more simpler and not even using a Wheel class at all, but what fun is that? In this entry I show the creation of a slot machine from a bit more of a mechanical aspect than a purely computerized one. It should provide a small sampling of classes and how they can represent real life machines. We cover it all right here on the Programming Underground!
So as I have already said, this little project was just something to play around with. It turned out kinda nice, so I thought I would share it. But what did I mean about it being mechanical in nature? Well, if you have ever played a real slot machine, not the digital ones they have in casinos now, you would see a metal case with a series of wheels. Typically it would be three wheels with pictures on them. When you put your money in and pull the handle the wheels would be set into motion. They would spin and then the first wheel would stop, followed by the second and then the third. After they have all stopped, the winnings are determined and you are paid out in coinage or credits.
I thought, why not be a bit mechanical in this slot machine design and create the wheels as a class called “Wheel” and give it the ability to spin independently of the other wheels? Have the wheel keep track of which picture (or in our case number) is flying by and report the results to the actual slot machine class. I could have done this mechanism without the need of a wheel at all and instead load up an array and have it randomly pick a number from the wheel. Little slimmer, little more efficient but wouldn’t show much programming theory.
What do we gain by recreating these Wheel classes and spinning them independently? Well, you gain a slight bit of flexibility. Independently we are able to control the speed of the spinning if we wanted to, we are able to grasp the idea of the wheel as a concept in our mind and manipulate it. We could easily built in features like if the wheel lands on a certain number it will adjust itself. Like some slots in Vegas, if you land on lets say a rocket in the center line, the machine would see the rocket and correct the wheel to spin backwards 1 spot (in the direction of the rocket as if the rocket was controlling the wheel). We could spin one wheel one way and another wheel another. We could inherit from that wheel and create a specialized wheel that does a slew of new different behaviors. All encapsulated into one solid object making the actual Machine class oblivious to the trickery of the wheel itself… encapsulation at its finest!
The machine class we create will contain 3 pointers. Each to one of the wheels. The machine itself will be in charge of a few different tasks. Taking money, issuing and removing credits, determining when to spin, telling each of the wheels to spin and checking our winnings based on some chart we create. It has enough on its plate than worrying about the wheels and reading their values.
So lets start with our Wheel class and its declaration/implementation…
wheel.h
As you can see the wheel itself is not a difficult concept to envision. The bulk of the work is in the read() method. Here we simply read the values from our internal array of integers (the values on the wheel) and return those values as an array of the three integers… representing the visible column. This column will then be loaded into our 2-Dimensional Array back in the Machine class. The 2D array represents the view or screen by which the user sees the results. Remember that the user never gets to see the entire wheel. Only the 3 consecutive values on the face of the wheel.
Here is how it may look in the real world. We have our machine with the three wheels and our 2D array called “Screen” which acts as our viewing window. Each wheel will report its values and those values will be put into the screen…
Below is our machine class…
machine.h
This looks like a lot of code but really it is not if you look at each function. Most of them are very very simple to understand. We have a spin method which essentially spins each of the wheels, reads their values back from the Wheel class into a pointer (representing each column), then they are loaded into the 2D array one column at a time (our view screen), printed for the user to see the results and lastly the winnings are checked. The checkwinnings() method determines which rows to check based on the amount of the bet. If they chose 1 line, it checks for winning combinations on the middle row only. If they choose 2 lines, it checks the middle and top lines, 3 line bet checks all three horizontal rows, 4 line bet checks the first diagonal as well and 5 line bet checks both diagonals in addition to the lines.
How does it check the lines? Well each line is given to the checkline() helper function which compares the 3 values of the line against an enumerated type of various symbols. Here we are just assigning a symbol against each numbered value to help the programmer determine which numbers correspond to which winning combos. For instance, luckyseven represents the number 3 in the enumeration. So if it runs across a line with 3 number 3s, then it knows it hit the grand jackpot and credits the player 1000. This method makes things easy because if we ever wanted to change the win patterns later, we could change the enum and checkline method to do so. We could also build in multiple types of symbols and even let the user choose what slot machine game they want to go by. It becomes very flexible and is a testament to great design!
Lastly we can put some tests together just to show some the various aspects of how this thing works and how the programmer can use the classes…
slotmachine.cpp
This simply inserts a 5 dollar bill and a coin for good luck. Then bets 5 lines and spins. Despite the outcome we go and bet five lines again and spin once more. Hopefully we win something this time around! But either way, those are the classes for you and I hope you like them. As always, all code here on the Programming Underground is in the public domain and free for the taking (just don’t cause a mess in isle 3, I am tired of running out there for cleanup). Thanks for stopping by and reading my blog. 🙂
Latest versionReleased:
A multi-armed bandit library for Python
Project description
A multi-armed bandit library for Python
Slots is intended to be a basic, very easy-to-use multi-armed bandit library for Python.
Author
Roy Keyes -- roy.coding@gmail
License: MIT
See LICENSE.txt
Introduction
slots is a Python library designed to allow the user to explore and use simple multi-armed bandit (MAB) strategies. The basic concept behind the multi-armed bandit problem is that you are faced with n choices (e.g. slot machines, medicines, or UI/UX designs), each of which results in a 'win' with some unknown probability. Multi-armed bandit strategies are designed to let you quickly determine which choice will yield the highest result over time, while reducing the number of tests (or arm pulls) needed to make this determination. Typically, MAB strategies attempt to strike a balance between 'exploration', testing different arms in order to find the best, and 'exploitation', using the best known choice. There are many variation of this problem, see here for more background.
slots provides a hopefully simple API to allow you to explore, test, and use these strategies. Basic usage looks like this:
Using slots to determine the best of 3 variations on a live website.
Make the first choice randomly, record responses, and input reward 2 was chosen. Run online trial (input most recent result) until test criteria is met.
The response of mab.online_trial()
is a dict of the form:
Where:
- If the criterion is met,
new_trial
=False
. choice
is the current choice of arm to try.best
is the current best estimate of the highest payout arm.
To test strategies on arms with pre-set probabilities:
To inspect the results and compare the estimated win probabilities versus the true win probabilities:
By default, slots uses the epsilon greedy strategy. Besides epsilon greedy, the softmax, upper confidence bound (UCB1), and Bayesian bandit strategies are also implemented.
Regret analysis
A common metric used to evaluate the relative success of a MAB strategy is 'regret'. This reflects that fraction of payouts (wins) that have been lost by using the sequence of pulls versus the currently best known arm. The current regret value can be calculated by calling the mab.regret()
method.
For example, the regret curves for several different MAB strategies can be generated as follows:
API documentation
For documentation on the slots API, see slots-docs.md.
Todo list
- More MAB strategies
- Argument to save regret values after each trial in an array.
- TESTS!
Contributing
I welcome contributions, though the pace of development is highly variable. Please file issues and submit pull requests as makes sense.
The current development environment uses:
- pytest >= 5.3 (5.3.2)
- black >= 19.1 (19.10b0)
- mypy = 0.761
You can pip install these easily by including dev-requirements.txt
.
For mypy config, see mypy.ini
. For black config, see pyproject.toml
.
Release historyRelease notifications | RSS feed
0.4.0
0.3.1
0.3.0
0.2.0
0.1.0
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Filename, size | File type | Python version | Upload date | Hashes |
---|---|---|---|---|
Filename, size slots-0.4.0-py3-none-any.whl (8.7 kB) | File type Wheel | Python version py3 | Upload date | Hashes |
Filename, size slots-0.4.0.tar.gz (174.8 kB) | File type Source | Python version None | Upload date | Hashes |
Slot Machine Games
CloseHashes for slots-0.4.0-py3-none-any.whl
Algorithm | Hash digest |
---|---|
SHA256 | 2bc3e51a6223ae3984476f5d1bb272e70ca6d74fbd298fe48c7283cc1c358cc7 |
MD5 | 1ec6d4398f2a36036f452a9c77d0d43c |
BLAKE2-256 | 61dacfca624262fdcce7c043b5e96f06a64019d4a6581a31d5e34ee52b9d30cd |
Hashes for slots-0.4.0.tar.gz
Algorithm | Hash digest |
---|---|
SHA256 | b02b7b60084b6fe2b0297a14493289c4f7ee88ae374ec518237ca6b13d39e7ae |
MD5 | f91161c95cf32357b2b23b01ca4041c9 |
BLAKE2-256 | 443e20fea85cf3b7054cd90da868b50640e9dc532509567462e623ea1aeefb42 |