Reverse Polish Notation calculator for ESP8266 & ESP32 microcontrollers.
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
examples
src
test
.gitignore
.travis.yml
CHANGELOG.md
LICENSE
README.md
keywords.txt
library.json
library.properties
platformio.ini
pre-commit

README.md

RPNlib

RPNlib is a Reverse Polish Notation calculator for ESP8266 & ESP32 microcontrollers. The library accepts a c-string with commands to execute and provides methods to evaluate the output. It is meant to be embedded into third party software as a way to provide the user a simple to implement scripting language.

version codacy travis license
donate twitter

RPN

First you should familiarize yourself with RPN calculation. Reverse Polish notation (RPN), also known as Polish postfix notation or simply postfix notation, is a mathematical notation in which operators follow their operands, in contrast to Polish notation (PN), in which operators precede their operands. It does not need any parentheses as long as each operator has a fixed number of operands. The description "Polish" refers to the nationality of logician Jan Łukasiewicz, who invented Polish notation in 1924.

A simple calculation in infix notation might look like this:

( 4 - 2 ) * 5 + 1 =

The same calculation in RPN (postfix) will look like this:

4 2 - 5 * 1 +

It results in a shorter expression since parenthesis are unnecessary. Also the equals sign is not needed since all results are stored in the stack. From the computer point of view is much simpler to evaluate since it doesn't have to look forward for the operands.

Check this wiki page on the topic.

Library usage

The RPNlib is not an object-based (OOP) library but a context-based set of methods. This means you don't instantiate a library object but instead, you create a data context object that is passed along to all methods in the library.

Using the library is pretty easy. Follow this steps:

  • Create the context (where stack, variables and operators are stored)
  • Initialize the context (loads default operators)
  • Add any required variables (optional)
  • Add any additional custom operators (optional)
  • Process a command
  • Inspect stack
  • Clear context

A simple code would be:

rpn_context ctxt;
rpn_init(ctxt);
rpn_process(ctxt, "4 2 - 5 * 1 +");

unsigned char size = rpn_stack_size(ctxt);
Serial.printf("Stack size: %d\n", size);

float value;
for (unsigned char i=0; i<size; i++) {
    rpn_stack_pop(ctxt, value);
    Serial.printf("Stack level #%d value: %f\n", i, value);
}

rpn_clear(ctxt);

Supported operators

This is a list of supported operators with their stack behaviour.

  • Operators (and variables) are case-sensitive.
  • All operators will throw an error if the number of available elements in the stack is less than the required parameters.
  • All elements in the stack are repesented as natural (float) numbers.
  • Some operators perform an automatic cast of the elements poped from the stack.
  • A boolean cast will be false if the element is 0, true otherwise.
  • True is represented as 1, whilst false is represented as 0.

pi      ( -> a ) where a is the value of PI
e       ( -> a ) where a is the value of e (base of the neperian logarithms)

+       ( a b -> a+b )
-       ( a b -> a-b )
*       ( a b -> a*b )
/       ( a b -> a/b ) throws error if b==0
mod     ( a b -> a\b ) returns the reminder for the a/b division as integers

round   ( a n -> b ) where b is a rounded to the n-th decimal
ceil    ( a -> b ) where b is a rounded to the closes greater or equal integer
floor   ( a -> b ) where b is a rounded to the closes lesser or equal integer
int     ( a -> b ) alias for "floor"

sqrt    ( a -> sqrt(a) )
log     ( a -> log(a) )
log10   ( a -> log10(a) )
exp     ( a -> e^a )
fmod    ( a b -> a\b ) returns the reminder for the a/b division as real numbers
pow     ( a b -> a^b )
cos     ( a -> cos(a) ) a in radians
sin     ( a -> sin(a) ) a in radians
tan     ( a -> tan(a) ) a in radians

==      ( a b -> a==b )
!=      ( a b -> a!=b )
>       ( a b -> a>b )
>=      ( a b -> a>=b )
<       ( a b -> a<b )
<=      ( a b -> a<=b )

and     ( a b -> c ) where c is 1 if both a and b are different from 0
or      ( a b -> c ) where c is 1 if a or b are different from 0
xor     ( a b -> c ) where c is 1 if either a or b are different from 0, but not both
not     ( a -> !a ) where b is 1 if a is 0, 0 otherwise

dup     ( a -> a a )
dup2    ( a b -> a b a b )
swap    ( a b -> b a )
rot     ( a b c -> b c a )
unrot   ( a b c -> c a b )
drop    ( a ->  )
over    ( a b -> a b a )
depth   ( a b c ... -> a b c ... n ) where n is the number of elements in the stack

ifn     ( a b c -> d ) if a!=0 then b else c

License

Copyright (C) 2018 by Xose Pérez

The rpnlib library is free software: you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

The rpnlib library 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 Lesser General Public License for more details.

You should have received a copy of the GNU Lesser General Public License along with the rpnlib library. If not, see http://www.gnu.org/licenses/.