Stacker is a powerful Reverse Polish Notation (RPN) calculator built with Python, featuring basic mathematical operations and extensibility through plugins.
Ensure Python 3 is installed.
-
Via pip:
pip install pystacker
-
From source:
git clone [email protected]:remokasu/stacker.git cd stacker python setup.py install
Feedback and contributions are welcome. Please submit issues or suggestions on the Issues page.
Stacker uses external libraries like NumPy and Python Prompt Toolkit. Ensure these are installed:
pip install numpy prompt_toolkit
Run Stacker:
stacker
Or:
python -m stacker
Stacker supports standard arithmetic operations (+, -, *, /) and advanced functions (sin, cos, tan, etc.). Users can input commands in RPN format and extend functionality using custom plugins.
Stacker allows for straightforward RPN input. For example:
-
Single-line input:
stacker:0> 3 4 + [7]
-
Multi-line input:
stacker:0> 3 [3] stacker:1> 4 [3, 4] stacker:2> + [7]
-
The Stacker command allows you to directly push integers, floating-point numbers, and complex numbers onto the stack. This facilitates easy management of various types of numerical data.
-
Integers:
stacker:0> 3 [3]
In this example, the integer 3 is added to the stack.
-
Floating-Point Numbers:
stacker:1> 3.14 [3.14]
Here, the floating-point number 3.14 is added to the stack.
-
Complex Numbers:
stacker:2> 1+2j [(1+2j)]
In this case, the complex number 1+2j (with a real part of 1 and an imaginary part of 2) is added to the stack. Complex numbers are denoted by combining the real and imaginary parts with a +, and the imaginary part is indicated using j.
-
-
- syntax:
"Hello, World!"
- example:
In this example, the string "Hello, World!" is added to the stack.
stacker:0> "Hello, World!" ["Hello, World!"]
- syntax:
-
- syntax:
value $name set
- example:
In this example, we assign
stacker:0> 3 $x set
3
tox
. If you input an undefined symbol, you need to prefix the symbol name with a dollar sign ($).
From now on, when usingx
, the character 'x' will be pushed onto the stack and evaluated to return3
when popped.
You can push the value of a symbol by prefixing it with @.
For example,@x
will push3
.stacker:0> 3 $x set stacker:1> x [x] stacker:2> @x [x, 3] stacker:1> + [6]
- syntax:
-
Arrays:
-
Single-line array:
stacker:0> [1 2 3; 4 5 6] [[1, 2, 3], [4, 5, 6]]
-
Multi-line array:
stacker:0> [1 2 3; ... > 4 5 6] [[1, 2, 3], [4, 5, 6]]
-
-
Code blocks are enclosed in curly braces ({}). These blocks are pushed onto the stack in their raw form and can be executed later. For example: {1 2 +}. These blocks are particularly useful for deferred (lazy) evaluation. Specific use-cases include conditional statements and loop controls.
- syntax:
{1 2 +}
- example:
In this command, the block
stacker:0> {1 2 +} [{1 2 +}]
{1 2 +}
is pushed (added) to the stack.
- syntax:
-
- if
- syntax:
{true_block} {condition} if
- example:
This example pushes
stacker:0> 0 $x set stacker:1> {3 4 +} {x 0 ==} if [7]
7
onto the stack becausex
is equal to0
.
- syntax:
- ifelse
- syntax:
{true_block} {false_block} {condition} ifelse
- example:
This example pushes
stacker:0> 0 $x set stacker:1> {3 4 +} {3 4 -} {x 0 ==} ifelse [7]
7
onto the stack becausex
is equal to0
.
- syntax:
- if
-
- do
- syntax:
start_value end_value $symbol {body} do
- example:
This example prints the numbers from 0 to 10.
stacker:0> 0 10 $i {i echo} do 0 1 2 3 4 5 6 7 8 9 10
- syntax:
- times
- syntax:
{body} n times
- example:
In this example, we push 1 onto the stack and then repeat {dup (duplicate the top element) and ++ (add 1 to the top element)} 10 times.
stacker:0> 1 {dup ++} 10 times [1 2 3 4 5 6 7 8 9 10 11]
- syntax:
- do
-
- syntax:
{break}
- example:
This example prints the numbers from 0 to 5. When
stacker:0> 0 $i set stacker:1> 0 10 $i {{break} i 5 == if i echo} do 0 1 2 3 4 5
i
is equal to5
, the loop is terminated bybreak
.
- syntax:
-
- syntax:
(arg1 arg2 ... argN) {body} $name defun
- example:
This defines a function named
stacker:0> (x y) {x y *} $multiply defun stacker:1> 10 20 multiply [200]
multiply
that takes two argumentsx
andy
and multiplies them together.
- syntax:
-
- syntax:
{body} $name alias
- example:
This defines a macro with the body
stacker:0> {2 ^ 3 * 5 +} $calculatePowerAndAdd alias stacker:1> 5 calculatePowerAndAdd [80]
{2 ^ 3 * 5 +}
and assigns it the namecalculatePowerAndAdd
. This macro squares the number on the stack, multiplies it by 3, and then adds 5.
- syntax:
-
Stacker scripts can be included in other scripts using the
include
command. For example:stacker:0> "my_script.stk" include
All functions, macros and variables defined in "my_script.stk" are added to the current stack.
-
-
Writing to a file:
stacker:0> "output.txt" "hoge" write
This writes the string "hoge" to the file "output.txt".
-
Reading from a file:
stacker:0> "output.txt" read [hoge]
This reads the contents of "output.txt" and executes it.
stacker:0> "output.txt" read $text set
You can also set the contents of the file to a variable using the
set
command.
-
Stacker scripts can be created in .stk
files. To run a script, simply execute it with Stacker. For example:
-
my_script.stk:
0 $p set 0 100000 $k { -1 k ^ 2 k * 1 + / p + p set } do 4 p * p set p echo
Running the script:
stacker my_script.stk
You can directly execute a specified RPN expression from the command line.
stacker -e "3 4 + echo"
-
disable_plugin Disable a specified plugin:
stacker:0> "hoge" disable_plugin
This command deactivates the
hoge
operator added as a plugin. Note that it cannot be used on non-plugin operators. -
disable_all_plugins Disable all plugins at once.
stacker:0> disable_all_plugins
-
enable_disp_ans Enables the display of the last result (ans) at the end of the stack.
stacker:0> enable_disp_ans stacker:1> 3 4 + 7 [7]
-
disable_disp_ans Disables the display of the last result (ans) at the end of the stack.
stacker:0> disable_disp_ans stacker:1> 3 4 + [7]
-
enable_disp_stack Enables the setting to display the stack contents each time. By default, this setting is already active.
stacker:0> enable_disp_stack
-
disable_disp_stack Sets the display of stack contents to be disabled. When this setting is enabled, only the latest element of the stack is displayed.
stacker:0> disable_disp_stack
-
disable_disp_logo Disables the display of the logo at startup.
stacker:0> disable_disp_logo
You can automatically load settings at startup. The configuration file should be placed in ~/.stackerrc. For example, if you write the following contents in ~/.stackerrc, the disable_disp_logo and disable_disp_stack will be automatically activated at startup.
disable_disp_logo
disable_disp_stack
enabble_disp_ans
Create custom plugins for Stacker using Python:
-
Creating the Plugin: In the
plugins
directory, create a new Python file for your plugin (e.g.,my_plugin.py
).stacker/ │ ├── stacker/ │ ├── plugins/ │ │ ├── my_plugin.py │ │ └── ... │ │ │ ├── data/ │ ├── stacker.py │ ├── test.py │ └── ... │ └── ...
Adding your plugin here and reinstalling Stacker will apply the plugin permanently.
-
Defining Functions and Classes: Define the necessary functions and classes in
my_plugin.py
. -
Defining the
setup
Function: Inmy_plugin.py
, define asetup
function that takesstacker
as its only argument. -
Registering Custom Commands and Parameters:
Within the
setup
function, use theregister_plugin
method ofstacker
to register custom commands. Additionally, you can also register custom parameters using theregister_parameter
method. This allows for greater flexibility and customization in your plugin's behavior.Here's an example where custom commands for matrix operations and a custom parameter are registered:
Example:
from stacker.stacker import Stacker def function(a, b): # Do something def setup(stacker: Stacker): stacker.register_plugin("command", function)
You can specify the command description for the help command using desc. This field is optional.
This example demonstrates how to register functions for matrix operations and how to set a custom parameter within a plugin. The register_parameter method is used to add a custom parameter to the Stacker environment, allowing for additional customization and control within your plugin.
-
Reinstalling Stacker: Run the following command to reinstall Stacker:
> python setup.py install
Note: If you want to apply the plugin only temporarily, create a
plugins
directory in the directory where Stacker is executed and add your plugin there. The method for creating it is the same as described above. This method does not require reinstalling Stacker. -
Using the Plugin: When Stacker is launched, the plugin will automatically be loaded, and the custom commands will be available for use.
-
Disabling Plugins: Use operatorName disable_plugin to disable a specific plugin.
Use disable_all_plugins to disable all plugins.
You can also run Stacker as a Python module. For example:
from stacker import Stacker
stacker = Stacker()
print(stacker.eval("3 4 +"))
Operator | Description | Example |
---|---|---|
+ | Add | 3 5 + |
- | Subtract | 10 3 - |
* | Multiply | 4 6 * |
/ | Divide | 12 4 / |
// | Integer divide | 7 2 // |
% | Modulus | 9 2 % |
^ | Power | 3 2 ^ |
== | Equal | 1 1 == |
!= | Not equal | 1 0 != |
< | Less than | 1 2 < |
<= | Less than or equal to | 3 3 <= |
> | Greater than | 2 1 > |
>= | Greater than or equal to | 3 3 >= |
neg | Negate | 5 neg |
and | Logical and | true false and |
or | Logical or | true false or |
not | Logical not | true not |
band | Bitwise and | 3 2 band |
bor | Bitwise or | 3 2 bor |
bxor | Bitwise xor | 3 2 bxor |
>> | Right bit shit | 8 2 >> |
<< | Left bit shit | 2 2 << |
~ | Bitwise not | 5 ~ |
bin | Binary representation (result is a string) | 5 bin |
oct | Octal representation (result is a string) | 10 oct |
dec | Decimal representation (result is an integer) | 0b101010 dec |
hex | Hexadecimal representation (result is a string) | 255 hex |
Operator | Description | Example |
---|---|---|
abs | Absolute value | -3 abs |
exp | Exponential | 3 exp |
log | Natural logarithm | 2 log |
log10 | Common logarithm (base 10) | 4 log10 |
log2 | Logarithm base 2 | 4 log2 |
sin | Sine | 30 sin |
cos | Cosine | 45 cos |
tan | Tangent | 60 tan |
asin | Arcsine | 0.5 asin |
acos | Arccosine | 0.5 acos |
atan | Arctangent | 1 atan |
sinh | Hyperbolic sine | 1 sinh |
cosh | Hyperbolic cosine | 1 cosh |
tanh | Hyperbolic tangent | 1 tanh |
asinh | Inverse hyperbolic sine | 1 asinh |
acosh | Inverse hyperbolic cosine | 2 acosh |
atanh | Inverse hyperbolic tangent | 0.5 atanh |
sqrt | Square root | 9 sqrt |
ceil | Ceiling | 3.2 ceil |
floor | Floor | 3.8 floor |
round | Round | 3.5 round |
roundn | Round to specified decimal places | 3.51 1 roundn |
float | Convert to floating-point number | 5 float |
int | Convert to integer | 3.14 int |
gcd | Greatest common divisor | 4 2 gcd |
! | Factorial | 4 ! |
radians | Convert degrees to radians | 180 radians |
random | Generate a random floating-point number between 0 and 1 | random |
randint | Generate a random integer within a specified range | 1 6 randint |
uniform | Generate a random floating-point number within a specified range | 1 2 uniform |
dice | Roll dice (e.g., 3d6) | 3 6 dice |
Operator | Description | Example |
---|---|---|
drop | Drops the top element of the stack. | drop |
drop2 | Drops the top two elements of the stack. | drop2 |
dropn | Drops the nth element from the top of the stack. | n drop |
dup | Duplicate the top element of the stack. | dup |
dup2 | Duplicate the top two elements of the stack. | dup2 |
dupn | Duplicate the nth element from the top of the stack. | n dup |
swap | Swap the top two elements of the stack. | swap |
rev | Reverse the stack. | rev |
rot | Move the third element to the top of the stack. | rot |
unrot | Move the top element to the third position of the stack. | unrot |
roll | Moves the nth element to the top of the stack. | roll |
over | Copy the second element from the top of the stack. | over |
pick | Copies the nth element to the top of the stack. | n pick |
nip | Remove the second element from the top of the stack. | nip |
depth | Returns the depth of the stack. | depth |
ins | Insert the specified value at the specified position. | 3 1 ins |
count | Counts the number of occurrences of a value in the stack. | count |
clear | Clear the stack. | clear |
disp | Display the stack. | disp |
Operator | Description | Example |
---|---|---|
time | Get Python time time object. | time |
include | Include the specified file | "file.stk" include |
eval | Evaluate the specified RPN expression | '3 5 +' eval |
evalpy | Evaluate the specified Python expression | '3+5' evalpy |
echo | Print the specified value to stdout without adding it to the stack | 3 4 + echo |
println | Print the specified value to stdout without adding it to the stack | 3 4 + println |
Print the specified value to stdout without adding a newline character at the end or adding it to the stack. | 3 4 + print |
|
input | Get input from the user | input |
read | Read the contents of the specified file | "file.txt" read |
write | Write the specified value to the specified file | "hoge" "file.txt" write |
Constants | Description |
---|---|
e | Euler's number |
pi | Pi |
tau | Tau |
nan | Not a number |
inf | Infinity |
true | Boolean true |
false | Boolean false |