+@ (c) 2020 Aaron Taylor <ataylor at subgeniuskitty dot com>
+@ See LICENSE.txt file for copyright and license details.
+
#ifndef VVS_STDLIB_MATH
#define VVS_STDLIB_MATH
@ Name:
@ random (10000)
@ Description:
-@ Returns a kinda-random number.
-@ Before using for the first time, seed heap[0] with a value.
+@ Returns a pseudo-random number.
+@ Before using for the first time, seed heap[0] with a non-zero value.
+@ This PRNG was taken from: https://en.wikipedia.org/wiki/Xorshift
@ Call Stack:
@ empty
@ Return Stack:
@ random number <-- TOS
@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
+#include <logic.pvvs>
NSSVTSSSSN | Mark: 10000 (random)
+@ Fetch seed from heap[0].
+SSSSN | PUSH 0 (ptr)
+TTT | LOAD
+
+@ Set TOS ^= TOS << 13
+SNS | DUP
+SSSTTSTN | PUSH +13
+NSTTSTTSTN | JSR > 101101 (lshift)
+NSTTSTSTTN | JSR > 101011 (xor)
+
+@ Set TOS ^= TOS >> 7
+SNS | DUP
+SSSTTTN | PUSH +7
+NSTTSTTSSN | JSR > 101100 (rshift)
+NSTTSTSTTN | JSR > 101011 (xor)
+
+@ Set TOS ^= TOS << 17
+SNS | DUP
+SSSTSSSTN | PUSH +17
+NSTTSTTSTN | JSR > 101101 (lshift)
+NSTTSTSTTN | JSR > 101011 (xor)
+
+@ Store a copy of the new seed at heap[0] and return.
+SNS | DUP
+SSSSN | PUSH 0 (ptr)
+SNT | SWAP
+TTS | STORE
+NTN | RTS
+
+@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
+@ Name:
+@ fastrand (10011)
+@ Description:
+@ Returns a pseudo-random number.
+@ Probably not as good as `random`, but much faster since it does not use XOR.
+@ Based on the POSIX.1-2001 example for random().
+@ Before using for the first time, seed heap[0] with a value.
+@ Call Stack:
+@ empty
+@ Return Stack:
+@ random number <-- TOS
+@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
+NSSVTSSTTN | Mark: 10011 (fastrand)
+
@ Generate the next seed value
SSSSN | PUSH 0 (ptr)
TTT | LOAD
SSSSN | PUSH 0
NTN | RTS
+@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
+@ Name:
+@ gcd (10010)
+@ Description:
+@ Returns greatest common divisor of X and Y.
+@ Call Stack:
+@ Y
+@ X <-- TOS
+@ Return Stack:
+@ gcd(X,Y) <-- TOS
+@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
+#include <stack.pvvs>
+NSSVTSSTSN | Mark: 10010 (gcd)
+
+@ Since 1 > -1, transform problem into gcd(abs(X),abs(Y)).
+SNT | SWAP
+NSTTSSSTN | JSR > 10001 (abs)
+SNT | SWAP
+NSTTSSSTN | JSR > 10001 (abs)
+
+@ Verify neither operand is zero.
+SNT | SWAP
+SNS | DUP
+NTSSSSTSSTSSSSSSSSSN | BRZ > 00010010 00000000 (gcd:zero input)
+SNT | SWAP
+SNS | DUP
+NTSSSSTSSTSSSSSSSSSN | BRZ > 00010010 00000000 (gcd:zero input)
+
+@ Verify X != Y and sort X,Y so the smaller is TOS.
+SNS | DUP
+SSSTTN | PUSH 3
+NSTTTSSN | JSR > 1100 (deepdup)
+SNT | SWAP
+TSST | SUBTRACT
+@ TOS> Y-X, X, Y
+NTTSSSTSSTSSSSSSSSTN | BMI > 00010010 00000001 (gcd:swap inputs)
+NSNSSSTSSTSSSSSSSTSN | JMP > 00010010 00000010 (gcd:main loop)
+NSSVSSSTSSTSSSSSSSSTN | MARK: 00010010 00000001 (gcd:swap inputs)
+SNT | SWAP
+
+@ Main gcd loop.
+@ Euclidean algorithm.
+NSSVSSSTSSTSSSSSSSTSN | MARK: 00010010 00000010 (gcd:main loop)
+SNS | DUP
+SSSTTN | PUSH 3
+NSTTSTSN | JSR > 1010 (stackrotate)
+TSTT | MODULO
+SNS | DUP
+NTSSSSTSSTSSSSSSSTTN | BRZ > 00010010 00000011 (gcd:loop termination)
+NSNSSSTSSTSSSSSSSTSN | JMP > 00010010 00000010 (gcd:main loop)
+NSSVSSSTSSTSSSSSSSTTN | MARK: 00010010 00000011 (gcd:loop termination)
+SNN | DROP
+NTN | RTS
+
+@ At least one operand was zero.
+@ Since we define gcd(a,0) = a, return the other operand.
+NSSVSSSTSSTSSSSSSSSSN | MARK: 00010010 00000000 (gcd:zero input)
+SNN | DROP
+NTN | RTS
+
#endif