aboutsummaryrefslogtreecommitdiff
path: root/readme.rst
diff options
context:
space:
mode:
Diffstat (limited to 'readme.rst')
-rwxr-xr-xreadme.rst121
1 files changed, 81 insertions, 40 deletions
diff --git a/readme.rst b/readme.rst
index 970817e..b3ee815 100755
--- a/readme.rst
+++ b/readme.rst
@@ -9,40 +9,15 @@
Compilation
===========
-licht requires ocaml >= 4.03 and ncurses
+licht requires ocaml 4.04 and ncurses
.. code-block:: console
# sudo aptitude install opam libncures-dev libiconv-dev
- $ opam install ocamlbuild curses camlzip ezxmlm ounit text menhir calendar
+ $ opam install ocamlbuild curses camlzip ezxmlm ounit text menhir zarith
$ make
-Tester avec un encoding non UTF_8
-=================================
-
-
-Lancement du terminal avec l'encoding
-
-.. code-block:: console
-
- LANG=fr_FR.iso8859-1 xterm -en iso8859-1
-
-
-Définir l'encoding suivant :
-
-.. code-block:: console
-
- export LC_ALL=fr_FR.iso8859-1
-
-Pour la définir avec rxvt :
-
-.. code-block:: console
-
- export LC_CTYPE=fr_FR.ISO8859-1
- export LANG=fr_FR.iso8859-1
- printf "\33]701;$LC_CTYPE\007"
-
=====
Usage
=====
@@ -156,8 +131,8 @@ Undefined
If a reference point to an an empty cell, the content will be interpreted as
Undefined. Any formula impliyng Undefined will return Error
-Formulas
-========
+Functions
+=========
You can enter a formula by starting the value with `=`. The evaluation always
expands the reference to other cells.
@@ -183,14 +158,26 @@ Function Value
Boolean
-------
-=============== ===============================
-Function Value
-=============== ===============================
-`true()` True
-`false()` False
-`not(Bool)` True if the parameter is False,
- False if the parameter is True
-=============== ===============================
+================= ===============================
+Function Value
+================= ===============================
+`true()` True
+`false()` False
+`not(Bool)` True if the parameter is False,
+ False if the parameter is True
+`and(Bool; Bool)` Logical and
+`or(Bool; Bool)` Logical or
+`xor(Bool; Bool)` Logical exclusive or
+================= ===============================
+
+Condition
+~~~~~~~~~
+
+========================= ===========================================
+Function Value
+========================= ===========================================
+`if(Bool`; *x* ; *y* `)` Return *x* if `Bool` is Thue, otherwise *y*
+========================= ===========================================
Numeric
-------
@@ -198,8 +185,62 @@ Numeric
=================== =====================================
Function Value
=================== =====================================
-*x* `+` *y* Add two values
-*x* `**` *y* Compute *x* ^ *y*
-`sum(Numeric List)` Compute the sum of the list.
+*x* `+` *y* Addition
+*x* `-` *y* Difference
+*x* `*` *y* Multiplication
+*x* `/` *y* Division
+*x* `^` *y* Compute *x* ^ *y*
+`gcd(` *x*; *y* `)` Greatest common divisor
+`lcm(` *x*; *y* `)` Lowest common multiple
`rnd()` A random number between 0 and 1
+`sqrt(Numeric)` Square root
+`exp(Numeric)` Exponential
+`ln(Numeric)` Natural logarithm
+`abs(Numeric)` Absolute value
=================== =====================================
+
+Rounding
+~~~~~~~~
+
+The table show the differents results for the rounding functions
+
+===================== === === ==== ====
+Function 1.2 1.8 -1.2 -1.8
+===================== === === ==== ====
+`int(Numeric)` 1 1 -2 -2
+`rounddown(Numeric)` 1 1 -1 -1
+`round(Numeric)` 1 2 -1 -2
+===================== === === ==== ====
+
+Operations on lists
+~~~~~~~~~~~~~~~~~~~
+
+=================== =====================================
+Function Value
+=================== =====================================
+`sum(Numeric List)` Compute the sum of the list.
+`min(Numeric List)` Get the minimum value
+`max(Numeric List)` Get the maximum value
+=================== =====================================
+
+Trigonometry
+~~~~~~~~~~~~
+
+All the trigonometry functions works in radian.
+
+===================== =====================================
+Function Value
+===================== =====================================
+`pi()` Get the value for :math:`\pi`
+`cos(Numeric)` Get the cosine for the value
+`sin(Numeric)` Get the sine for the value
+`tan(Numeric)` Get the tangent for the value
+`acos(Numeric)` Arc cosine
+`asin(Numeric)` Arc sine
+`atan(Numeric)` Arc tangent
+`cosh(Numeric)` Hyperbolic cosine
+`sinh(Numeric)` Hyperbolic sine
+`tanh(Numeric)` Hyperbolic tangent
+`atan2(` *x*; *y* `)` Arc tangent of *x* / *y*
+===================== =====================================
+