Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/phikal/sc
calculator
Last synced: about 21 hours ago
JSON representation
- Host: GitHub
- URL: https://github.com/phikal/sc
- Owner: phikal
- License: gpl-2.0
- Created: 2016-10-10T11:26:07.000Z (over 8 years ago)
- Default Branch: lisp
- Last Pushed: 2016-10-10T11:32:54.000Z (over 8 years ago)
- Last Synced: 2024-11-18T15:45:41.098Z (2 months ago)
- Topics: calculator
- Size: 57.6 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.org
Awesome Lists containing this project
README
#+TITLE: sc - Shell/Simple/Stack Calculator
=sc= is a simple RPN calculator that interprets
command line input and outputs a result. In some
sense =dc(1)= but without =p= and a lot worse (for now...).
* How to use
Wikipedia's [[https://en.wikipedia.org/wiki/Reverse_Polish_notation][RPN]] article explains what the reversed polish
notation is about an why it's /not bad/.
The main reason it's used in =sc= is because brackets
are annoying to use in a shell environment.
Arguments are separated for the each other via a
white spaces, and if one argument is not a number it
is either a operator or causes an error. Here are the
operators.
** Operators
| Symbol | Meaning | Argument count |
|--------+--------------------------------+----------------|
| =+= | Addition | 2 |
| =-= | Subtraction | 2 |
| =x= | Multiplication (note: not =*=) | 2 |
| =/= | Division | 2 |
| =^= | Power | 2 |
| =s= | Square Root | 1 |
| =i= | Inversion | 1 |
| =n= | Negative | 1 |
| =!= | Factorial | 1 |
| =gcd= | Greatest Common Denominator | 2 |
| =rnd= | Random number (0 to 1) | 0 |
| =rand= | Random number (arg1 to arg2) | 2 |
| =r= | Round value (nearest int) | 1 |
| =f= | Floor value (lesser int) | 1 |
| =c= | Ceil' value (greater int) | 1 |
* Examples
=sc 3 4 x= Results in: =12.000000=
=sc 1 5 s + 2 /= ([[https://en.wikipedia.org/wiki/Golden_ratio][Golden ratio]]), results in: =1.618034=
If a operator requires more arguments than it is given,
=sc= will report an error (code 2) and quit.
* Building
To build and install, simply type:
#+begin_src
make
make install
#+end_src
And to uninstall:
#+begin_src
make uninstall
#+end_src
See [[./Makefile][Makefile]] for more information.
** Tests
As of now, there are two tests, managed with =make=:
#+begin_src
make calc_test
make stack_test
#+end_src
* To do
* Reimplement NUM struct and functions to resemble
GNU =bc= / =dc='s precision.
* Integration and Deviation
* Implement command line flag handling. Ideas.
| Flag | Meaning | Argument[s] |
|------+-------------------+-----------------------|
| =-h= | Help screen | none |
| =-v= | Version | none |
| =-s= | Print whole stack | none |
| =-d= | Derivation | Variable to derive |
| =-i= | Integration | Variable to integrate |
* Extra functions and operators. Ideas:
| Symbol | Meaning | Arguments |
|--------+--------------------------------------------+-----------|
| sin | Sine | 1 |
| cos | Cosine | 1 |
| tan | Tangent | 1 |
| asin | arc-sine | 1 |
| acos | arc-cosine | 1 |
| atan | arc-tan | 1 |
| exp | exponential to the power of e | 1 |
| lg | natural logarithm | 1 |
| log | logarithm to the power of 10 | 1 |
| fact | Factorial | 1 |
| abs | Absolute of value | 1 |
| pi | Value of Pi | 0 |
| e | Value of Eulers Number | 0 |
And probably more over time
* Licence
=sc= uses the GNU General Public License v2.0.
See [[LICENCE]].