Merge pull request #10 from bxparks/develop

merge 0.5.0 into master

Author: bxparks

CHANGELOG.md

@@ -1,9 +1,68 @@
 # Changelog
 
 - Unreleased
+- 0.5.0 (2023-08-31)
+    - `USER_GUIDE.md`, `README.md`
+        - Update "Menu Indicator Arrows" section with latest screenshots which
+          changed the menu arrows.
+        - rename 'Menu Strip' to 'Menu Row' for consistency with HP-42S
+          terminology.
+    - `BASE`
+        - display just a bare `-` for negatives numbers in `BASE` modes (instead
+          of `...` which is now reserved for valid numbers which overflows the
+          number of digits supported by the display)
+        - validate that the `X` and `Y` values are in the range of `[0, 2^32)`
+          when performing bitwise operations (e.g. `B+`, `AND`, `XOR`, etc).
+          Floating point numbers are truncated to `u32` integers before the
+          bitwise operations are performed.
+    - Add menu selector dots
+        - Replicate HP-42S menu selector dots, where a menu item can be both an
+          action (e.g. select `DEG`) and a selection indicator.
+        - display modes: `FIX`, `SCI`, `ENG`
+        - trig modes: `RAD`, `DEG`
+        - base modes: `DEC`, `HEX`, `OCT`, `BIN`
+    - Improve menu name centering algorithm.
+        - No change for strings which are even-number of pixels wide.
+        - Strings which are odd-number of pixels wide are now centered
+          perfectly, instead of being off-centered by one-px to the left.
+        - Allows strings which are 17px wide to be rendered properly.
+    - Add `STAT` menu items
+        - 1 or 2 variable statistics
+        - `Sigma+` (add data point), `Sigma-` (remove data point)
+        - `SUM`, `MEAN`, `WMN` (weighted mean)
+        - `SDEV` (sample standard deviation), `SCOV` (sample covariance)
+        - `PDEV` (population standard deviation), `PCOV` (population covariance)
+    - Add `CFIT` curve fit menu items
+        - `Y>X` (forcast X from Y)
+        - `X>Y` (forcast Y from X)
+        - `SLOP` (least square fit slope)
+        - `YINT` (least square fit y-intercept)
+        - `CORR` (correlation coefficient)
+        - `LINF` (linear curve fit model)
+        - `LOGF` (logarithmic curve fit model)
+        - `EXPF` (exponential curve fit model)
+        - `PWRF` (power curve fit model)
+        - `BEST` (choose best curve fit model)
+    - Fix RPN stack lift logic for pending input
+        - Simplify stack lift logic to handle empty and non-empty pending input
+          consistently.
+        - If the input buffer is empty (showing just a `_` cursor), then any
+          subsequent keystroke that generates a single value (e.g. `PI` or
+          `STAT:N`) replaces the empty `X` register.
+        - If the input buffer is pending but not empty (i.e. has digits with a
+          trailing `_` cursor), then subsequent keystrokes causes a stack lift,
+          preserving the pending input into the `Y` register.
+        - If the subsequent keystroke is a function that consumes an `X`
+          register, then the empty input buffer is assumed to be a `0` value.
+    - Allow data transfer between RPN83P and TI-OS through the `ANS` variable.
+        - When the RPN83P app starts, the TI-OS `ANS` variable (if Real) is
+          available as the `LastX` register.
+        - When the RPN83P app exits, the most recent `X` register becomes
+          avaiable in TI-OS as the `ANS` variable.
+    - Add `X Root Y` menu item under `MATH`
 - 0.4.0 (2023-08-16)
     - More `BASE` menu functions:
-        - `SL` (shift left), `SR` (shift right)`, `RL` (rotate left circular),
+        - `SL` (shift left), `SR` (shift right), `RL` (rotate left circular),
         `RR` (rotate right circular).
         - `B+`, `B-`, `B*`, `B/`
         - `BDIV` (division with remainder)
@@ -19,7 +78,7 @@
         - preserve the original `X`, and push it up to `Y`
             - allows the `/` button to be chained with additional `PRIM` to
               calculate all prime factors
-            - see [Prime Factors](#USER_GUIDE.md#prime-factors]) for details
+            - see [Prime Factors](USER_GUIDE.md#prime-factors) for details
         - improve speed by 7X using u32 integer routines instead of floating
           point routines
 - 0.3.3 (2023-08-14)
@@ -36,7 +95,7 @@
     - Move `CLRG` from F1 position to F3. Move `CLX` to F1. If the F1
       is accidentally hit twice when selecting the `CLR` menu group, then
       invoking `CLX` is a lot less destructive than invoking `CLRG`.
-    - Move `IP,FP,...` menu strips before the `ABS,SIGN,...` menu strip. The
+    - Move `IP,FP,...` menu rows before the `ABS,SIGN,...` menu row. The
       `IP,FP` functions seem more frequently used than the `ABS,SIGN` functions.
 - 0.2.1 (2023-08-13)
     - Update README.md. Test minor version number with new release.

README.md

@@ -8,7 +8,7 @@ calculator app for the [TI-83 Plus](https://en.wikipedia.org/wiki/TI-83_series)
 Plus](https://en.wikipedia.org/wiki/TI-84_Plus_series) (including the Silver
 Edition). The app is inspired mostly by the
 [HP-42S](https://en.wikipedia.org/wiki/HP-42S) calculator, with some sprinkles
-of some older HP calculators like the
+of older HP calculators like the
 [HP-12C](https://en.wikipedia.org/wiki/HP-12C) and the
 [HP-15C](https://en.wikipedia.org/wiki/HP-15C).
 
@@ -17,39 +17,54 @@ memory. Since it is stored in flash, it is preserved if the RAM is cleared. It
 consumes a small amount of TI-OS RAM: 2 list variables named `REGS` and `STK`
 which are 240 bytes and 59 bytes respectively.
 
-Here the quick summary of its features:
+Here is a quick summary of its features:
 
 - traditional 4-level RPN stack (`X`, `Y`, `Z`, `T` registers)
 - support for `lastX` register
+- 8-line display showing all stack registers
 - 25 storage registers (`STO 00`, `RCL 00`, ..., `STO 24`, `RCL 24`)
 - hierarchical menu system, inspired by the HP-42S
 - support for all math functions with dedicated buttons on the TI-83 Plus and
   TI-84 Plus
     - arithmetic: `/`, `*`, `-`, `+`
     - trigonometric: `SIN`, `COS`, `TAN`, etc.
-    - `1/X`, `X^2`, `2ND SQRT`
+    - `1/X`, `X^2`, `SQRT`
     - `^` (i.e. `Y^X`),
     - `LOG`, `10^X`, `LN`, `e^X`
     - constants: `pi` and `e`
 - additional menu functions:
+    - `X^3`, `CBRT`, `XRootY`, `ATN2`, `2^X`, `LOG2`, `LOGB`
     - `%`, `%CH`, `GCD`, `LCM`, `PRIM` (is prime)
     - `IP` (integer part), `FP` (fractional part), `FLR` (floor), `CEIL`
-    - `ABS`, `SIGN`, `MOD`, `MIN`, `MAX`
       (ceiling), `NEAR` (nearest integer)
+    - `ABS`, `SIGN`, `MOD`, `MIN`, `MAX`
     - probability: `PERM`, `COMB`, `N!`, `RAND`, `SEED`
     - hyperbolic: `SINH`, `COSH`, `TANH`, etc.
     - angle conversions: `>DEG`, `>RAD`, `>HR`, `>HMS`, `P>R`, `R>P`
     - unit conversions: `>C`, `>F`, `>km`, `>mi`, etc
     - base conversions: `DEC`, `HEX`, `OCT`, `BIN`
     - bitwise operations: `AND`, `OR`, `XOR`, `NOT`, `NEG`, `SL`, `SR`, `RL`,
       `RR`, `B+`, `B-`, `B*`, `B/`, `BDIV`
+    - statistics: `Sigma+`, `Sigma-`, `SUM`, `MEAN`, `WMN` (weighted mean),
+      `SDEV` (sample standard deviation), `SCOV` (sample covariance),
+      `PDEV` (population standard deviation), `PCOV` (population covariance)
+    - curve fitting: `Y>X`, `X>Y`, `SLOP` (slope), `YINT` (y intercept), `CORR`
+      (correlation coefficent)
+    - curve fit models: `LINF` (linear)`, `LOGF` (logarithmic), `EXPF`
+      (exponential), `PWRF` (power)
 - various display modes
     - `RAD`, `DEG`
     - `FIX` (fixed point 0-9 digits)
     - `SCI` (scientific 0-9 digits)
     - `ENG` (engineering 0-9 digits)
 
-**Version**: 0.4.0 (2023-08-16)
+Here are some missing features which may be added in the future:
+
+- vectors and matrices
+- complex numbers
+- keystroke programming
+
+**Version**: 0.5.0 (2023-08-31)
 
 **Changelog**: [CHANGELOG.md](CHANGELOG.md)
 
@@ -68,7 +83,7 @@ Here the quick summary of its features:
 - [Compiling from Source](#compiling-from-source)
 - [Tools and Resources](#tools-and-resources)
 - [License](#license)
-- [Feedback](#feedback)
+- [Feedback and Support](#feedback-and-support)
 - [Author](#author)
 
 ## Installation
@@ -152,23 +167,27 @@ and `65`, then see the result as an octal number, a binary (base-2) number, then
 finally as a decimal number:
 
 - Navigate the menu with the DOWN arrow to get to
-  ![ROOT MenuStrip 2](docs/rpn83p-screenshot-menu-root-2.png)
+  ![ROOT MenuRow 2](docs/rpn83p-screenshot-menu-root-2.png)
 - Press `BASE` menu to get to
-  ![BASE MenuStrip 1](docs/rpn83p-screenshot-menu-root-base-1.png)
-- Press `HEX` menu.
+  ![BASE Menu DEC](docs/rpn83p-menu-base-dec.png)
+- Press `HEX` menu to get to
+  ![BASE Menu HEX](docs/rpn83p-menu-base-hex.png)
 - Press `ALPHA` `B` buttons
 - Press `6` button
 - Press `ENTER` button
 - Press `6` button
 - Press `5` button
 - Press DOWN arrow to get to
-  ![BASE MenuStrip 2](docs/rpn83p-screenshot-menu-root-base-2.png)
+  ![BASE MenuRow 2](docs/rpn83p-screenshot-menu-root-base-2.png)
 - Press `AND` menu, the `X` register should show `00000024`
 - Press UP arrow to go back to
-  ![BASE MenuStrip 1](docs/rpn83p-screenshot-menu-root-base-1.png)
-- Press `OCT` menu, the `X` register should show `00000000044`
-- Press `BIN` menu, the `X` register should show `00000000100100`
-- Press `DEC` menu, the `X` register should show `36`
+  ![BASE Menu HEX](docs/rpn83p-menu-base-hex.png)
+- Press `OCT` menu, the `X` register should show `00000000044` with the menu
+  showing ![BASE Menu OCT](docs/rpn83p-menu-base-oct.png)
+- Press `BIN` menu, the `X` register should show `00000000100100` with the menu
+  showing ![BASE Menu BIN](docs/rpn83p-menu-base-bin.png)
+- Press `DEC` menu, the `X` register should show `36` with the menu showing
+  ![BASE Menu DEC](docs/rpn83p-menu-base-dec.png)
 
 Here is the animated GIF that shows this calculation:
 
@@ -179,7 +198,7 @@ Press:
 - `ON` button (`ESC/EXIT`) multiple times to back to the home menu, or
 - `MATH` button (`HOME`) to go back directly.
 
-> ![ROOT MenuStrip 1](docs/rpn83p-screenshot-menu-root-1.png)
+> ![ROOT MenuRow 1](docs/rpn83p-screenshot-menu-root-1.png)
 
 ## User Guide
 
@@ -205,7 +224,7 @@ been verified only on my dev machine.
 
 ## Tools and Resources
 
-Here is the tools and resources that I use for development on Ubuntu Linux
+Here are the tools and resources that I used for development on Ubuntu Linux
 22.04:
 
 - spasm-ng Z80 assembler