Home My Page Projects Code Snippets Project Openings diderot
Summary Activity Tracker Tasks SCM

SCM Repository

[diderot] Annotation of /branches/vis12-cl/doc/man/diderot-api.5.txt
ViewVC logotype

Annotation of /branches/vis12-cl/doc/man/diderot-api.5.txt

Parent Directory Parent Directory | Revision Log Revision Log


Revision 2495 - (view) (download)

1 : jhr 2495 DIDEROT-API(5)
2 :     ==============
3 :     :doctype: manpage
4 :    
5 :    
6 :     NAME
7 :     ----
8 :     Diderot API - the library API for Diderot programs.
9 :    
10 :    
11 :     SYNOPSIS
12 :     --------
13 :    
14 :     [source,c]
15 :     ----
16 :     typedef struct NS_struct_world NS_World_t;
17 :    
18 :     void NS_SetVerbose (NS_World_t *wrld, bool mode);
19 :     bool NS_GetVerbose (NS_World_t *wrld);
20 :    
21 :     uint32_t NS_NumStrands (NS_World_t *wrld);
22 :     uint32_t NS_NumActive (NS_World_t *wrld);
23 :     uint32_t NS_NumStable (NS_World_t *wrld);
24 :    
25 :     NS_World_t *NS_Init ();
26 :     bool NS_Initially (NS_World_t *wrld);
27 :     uint32_t NS_Run (NS_World_t *wrld, uint32_t maxNSteps);
28 :     void NS_Shutdown (NS_World_t *wrld);
29 :     ----
30 :    
31 :    
32 :     DESCRIPTION
33 :     -----------
34 :    
35 :     By default, the *diderotc*(1) compiler generates library represented as an
36 :     object file with a companion C header file that describes the library's
37 :     API.
38 :     The symbols in this header file have a common _namespace_ prefix, which is
39 :     specified by the *--namespace* commandline option (the default namespace is +Diderot+).
40 :    
41 :    
42 :     SEE ALSO
43 :     --------
44 :     *diderotc*(1)
45 :    
46 :     teem -- http://teem.sourceforge.net
47 :    
48 :    
49 :     AUTHOR
50 :     ------
51 :    
52 :     Maintained by the Diderot project (http://diderot-language.cs.uchicago.edu[]).

root@smlnj-gforge.cs.uchicago.edu
ViewVC Help
Powered by ViewVC 1.0.0