Ken's Quick Pick Files

----------------------------------------------------------------------------
   kqp - Ken's Quick Pick
   Copyright (C) MMXVIII-MMXXII Kenneth P. Salerno
   With contributions from Paul M. Ruhl II

   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 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 <https://www.gnu.org/licenses/>.
----------------------------------------------------------------------------


DESCRIPTION
   Generate New York State Lottery numbers for Lotto, Mega Millions and
   Powerball, using all numbers in the range without repeats (Mega Millions)
   or only one repeat (Lotto and Powerball).

   This program has two distribution modes: even and random. The program will
   pause for a random interval between one and two milliseconds between each
   and every random number pick, simulating the Lottery balls bouncing before
   rolling down the ramp.

   Even distribution premise (default): 42% of all winning Lottery
   combinations have an even distribution of odds/evens and at most three low
   range numbers. High, Medium and Low-range numbers are defined by evenly
   splitting the full range of numbers into three sub-ranges to analyze.

   Random distribution premise (-r): Have full faith in
   arc4random_uniform(unsigned int) (OpenBSD's implementation based on
   ChaCha20). This is not recommended however because only 2% of all winning
   Lottery combinations have an even distribution of high/medium/low range
   numbers and odds/evens, which is why we introduce the bias in the default
   distribution algorithm.

   If the computer fails to correctly guess the remaining numbers late in the
   game (threshold is hard-coded to 20x high_ceiling) the application will end
   in an error and display the results for the interests of science.


PRE-BUILT BINARY PACKAGES FOR SUPPORTED PLATFORMS
   IBM AIX ............................... ppc64
   Android ............................... aarch64
   Debian Linux .......................... amd64
   Fedora Linux .......................... amd64
   Microsoft Windows ..................... amd64
   Red Hat Enterprise Linux .............. amd64, ppc64le, s390x


ANDROID BINARY INSTALLATION
   Transfer "kqp" to Droid (e.g. /sdcard/Download/kqp)
   Install "Terminal Emulator for Android" by Jack Palevich on Google Play

   From Terminal App:
   $ mkdir /data/data/jackpal.androidterm/bin
   $ cp /sdcard/Download/kqp /data/data/jackpal.androidterm/bin/
   $ chmod 755 /data/data/jackpal.androidterm/bin/kqp

   Set Preferences->Initial command:
   "PATH=$PATH:/data/data/jackpal.androidterm/bin; clear"

   Removal:
   $ rm /data/data/jackpal.androidterm/bin/kqp
   $ rmdir /data/data/jackpal.androidterm/bin

ANDROID COMPILATION FROM SOURCE
   $ sudo dnf install -y xz make gcc gcc-c++ bison m4 diffutils rsync python3
   $ ./android/build_cross-compiler_aarch64.sh
   $ . cross-compile/aarch64/setenv.sh
   $ make -j8 CC=aarch64-unknown-linux-gnueabi-gcc \
        STRIP=aarch64-unknown-linux-gnueabi-strip \
        LDFLAGS="-s -static -Wl,--gc-sections"


FEDORA/RED HAT ENTERPRISE LINUX BINARY PACKAGE INSTALLATION
   $ sudo dnf install ./KPSkenquickpick*.rpm
   $ sudo mandb -q
   Removal:
   $ sudo dnf remove KPSkenquickpick
   $ sudo mandb -q


DEBIAN BINARY PACKAGE INSTALLATION
   $ sudo dpkg -i KPSkenquickpick*.deb
   Removal:
   $ sudo dpkg -r kpskenquickpick


LINUX COMPILATION FROM SOURCE
   $ make -j8 && make test
   $ sudo make install
   $ sudo mandb -q
   Removal:
   $ sudo make uninstall
   $ sudo mandb -q


AIX BINARY PACKAGE INSTALLATION
   $ sudo installp -ad. KPSkenquickpick
   $ sudo catman -w
   Removal:
   $ sudo installp -u KPSkenquickpick
   $ sudo catman -w

AIX COMPILATION FROM SOURCE
   If IBM Open XL C >= V17 compiler is installed (recommended):
   $ make -j8 CC=ibm-clang EXTRACFLAGS="-m64" LDFLAGS="" \
        LIBS="-lpthread -lperfstat" STRIP="strip -X64" && make test

   Or, if you only have GCC installed:
   $ make -j8 CC=gcc EXTRACFLAGS="-fno-lto" LDFLAGS="" \
        LIBS="-lperfstat -lpthread" && make test

   $ sudo make PREFIX=/usr install
   $ sudo catman -w
   Removal:
   $ sudo make PREFIX=/usr uninstall
   $ sudo catman -w


WINDOWS BINARY INSTALLATION
   $ cp kqp.exe /mnt/c/Users/YOUR_NAME/AppData/Local/Microsoft/WindowsApps/
   Removal:
   $ rm /mnt/c/Users/YOUR_NAME/AppData/Local/Microsoft/WindowsApps/kqp.exe

WINDOWS COMPILATION FROM SOURCE
   $ make -j8 CC=x86_64-w64-mingw32-gcc
   $ cp kqp.exe /mnt/c/Users/YOUR_NAME/AppData/Local/Microsoft/WindowsApps/
   Removal:
   $ rm /mnt/c/Users/YOUR_NAME/AppData/Local/Microsoft/WindowsApps/kqp.exe


USAGE (ALL PLATFORMS)
   $ kqp --help

DOCUMENTATION (LINUX/AIX ONLY)
   $ apropos kqp
   $ man kqp

CHANGELOG (FEDORA/RED HAT ENTERPRISE LINUX ONLY)
   $ rpm -q --changelog KPSkenquickpick

   (see also packaging/rpm/KPSkenquickpick.spec)

EXAMPLES
   Generate Lotto games, distribution=random:
   $ kqp -l -r

   Generate Lotto games, distribution=even:
   $ kqp -l

   Generate Mega Millions games, distribution=random:
   $ kqp -m -r

   Generate Powerball games, distribution=random:
   $ kqp -p -r

   Generate custom game, no bonus ball, distribution=even:
   $ kqp -u 1 6 1 1 10 11 15 16 20 0 0

   Generate custom game, with bonus ball, distribution=random:
   $ kqp -r -u 4 6 10 1 20 21 40 41 60 1 25