Return to note.txt CVS log

Up to [local] / OpenXM / src / hgm

Annotation of OpenXM/src/hgm/note.txt, Revision 1.1

1.1     ! takayama    1: $OpenXM$
        !             2:
        !             3:
        !             4: See also note.txt under OpenXM/src/R/r-packages/hgm.
        !             5:
        !             6: * Naming of C functions.
        !             7:    C functions in this folder may also be used in r-packages.
        !             8:    They are loaded dynamically from shared libraries.
        !             9:    Then, it is recommended to use the following naming conventions
        !            10:    to define C functions.
        !            11:    When the directory name is xxyy, all (non-static) functions should have
        !            12:    a name starting with xxyy_ and global variables a anme starting with
        !            13:    XXYY_.
        !            14:    For example, all function names in so3 start with so3_ and
        !            15:    all global variables in so3 start with SO3_.  See the directory so3/src.
        !            16:
        !            17: * The main() functions for the standalon mode should be enclosed as
        !            18:   #ifdef STANDALONE  ~~~ main ~~~~  #else  ~~~~~ #endif
        !            19:   In order to generate R-shared libraries, the main function should not
        !            20:   be included.
        !            21:   See the file so3/src/so3_nc.c as an example.
        !            22:
        !            23: * A subset of gsl should be put under gsl-t-[numbers].
        !            24:   The subset is necessary to generate a shared library for R.
        !            25:   The R project does not recommend to include the full set of GSL.
        !            26:   Please use #ifdef USE_GSL_LIB ~~~~ #else ~~~~ #endif.
        !            27:   See so3/src/so3_nc.c and so3/src/Makefile as an example.
        !            28:
        !            29:
        !            30: Ref: http://fe.math.kobe-u.ac.jp/Movies/oxvh