diogo/yap-6.3
Archived
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

add documentation.

Browse Source
This commit is contained in:
Vitor Santos Costa 2014-05-12 16:36:41 +01:00
parent f0d17d0210
commit ee2d1f1332
1 changed files with 13 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

23
H/eval.h
View File

@ -140,9 +140,7 @@ typedef enum {
*/ */
op_pi, op_pi,
/** e /** e
Euler's number, the base of the natural logarithms. Euler's number, the base of the natural logarithms.
*
*/ */
op_e, op_e,
/** epsilon /** epsilon
@ -179,39 +177,44 @@ typedef enum {
* @brief specifies the available unary arithmetic operators * @brief specifies the available unary arithmetic operators
*/ */
typedef enum { typedef enum {
/** \+ _X_: the value of _X_. /** \+ _X_: the value of _X_ .
* *
* ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~{.prolog} * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~{.prolog}
* X =:= +X. * X =:= +X.
* ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
*/ */
op_uplus, op_uplus,
/** \- _X_: the complement of _X_. /** \- _X_: the complement of _X_ .
* *
* ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~{.prolog} * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~{.prolog}
* 0-X =:= -X. * 0-X =:= -X.
* ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
*/ */
*/
op_uminus, op_uminus,
/** \\ _X_, The bitwise negation of _X_. /** \\ _X_, The bitwise negation of _X_ .
* *
* ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~{.prolog} * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~{.prolog}
* \X /\ X =:= =:= 0. * \X /\ X =:= 0.
* ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
* *
* Note that the number of bits of an integer is at least the size in bitsof a Prolog term cell. * Note that the number of bits of an integer is at least the size in bitsof a Prolog term cell.
*/ */
op_unot, op_unot,
/** \\ _X_, The bitwise negation of _X_. /** exp( _X_ ), natural exponentiation of _X_ .
* *
* ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~{.prolog} * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~{.prolog}
* \X /\ X =:= =:= 0. * X = 0.0, abs(1.0 - exp( _X_ )) < 0.0001
* ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
* *
* Note that the number of bits of an integer is at least the size in bitsof a Prolog term cell.
*/ */
op_exp, op_exp,
/** log( _X_ ), natural logarithm of _X_ .
*
* ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~{.prolog}
* X = 1.0, abs( log( exp( _X_ )) -1.0) < 0.0001
* ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
*
*/
op_log, op_log,
op_log10, op_log10,
op_sqrt, op_sqrt,