← Back to branch summary

~ubuntu-branches/ubuntu/utopic/gridengine/utopic

« back to all changes in this revision

Viewing changes to doc/htmlman/htmlman3/list_intro.html

  • Committer: Bazaar Package Importer
  • Author(s): Mark Hymers
  • Date: 2008-06-25 22:36:13 UTC
  • Revision ID: james.westby@ubuntu.com-20080625223613-tvd9xlhuoct9kyhm
Tags: upstream-6.2~beta2
Import upstream version 6.2~beta2

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/htmlman/htmlman3/list_intro.html
 
1
<HTML>
 
2
<BODY BGCOLOR=white>
 
3
<PRE>
 
4
<!-- Manpage converted by man2html 3.0.1 -->
 
5
NAME
 
6
     Grid Engine List Library - a library providing generic  list
 
7
     functionality and database like list management
 
8
 
 
9
DESCRIPTION
 
10
     The Grid Engine List Library provides the functionality of a
 
11
     generic  list.  This means the list functions are applicable
 
12
     to every list based on a number of certain basic types. List
 
13
     definitions are extensible on a per program basis as long as
 
14
     the old fields remain in the list definition.
 
15
 
 
16
LIBRARY FUNCTIONS
 
17
     The list library provides the following functions. These are
 
18
     explained in detail in the stated man pages.
 
19
 
 
20
  LIST FUNCTIONS
 
21
     <B><A HREF="../htmlman3/lCreateList.html">lCreateList(3)</A></B>
 
22
          create a generic list
 
23
 
 
24
     <B><A HREF="../htmlman3/lCreateElemList.html">lCreateElemList(3)</A></B>
 
25
          create a generic list with a certain  number  of  empty
 
26
          elements
 
27
 
 
28
     <B><A HREF="../htmlman3/lFreeList.html">lFreeList(3)</A></B>
 
29
          free the memory allocated for a generic  list  and  all
 
30
          its sub-lists
 
31
 
 
32
     <B><A HREF="../htmlman3/lCopyList.html">lCopyList(3)</A></B>
 
33
          copy a generic list with all its sub-lists and strings
 
34
 
 
35
     <B><A HREF="../htmlman3/lAddList.html">lAddList(3)</A></B>
 
36
          concatenate two generic lists
 
37
 
 
38
     <B><A HREF="../htmlman3/lSortList.html">lSortList(3)</A></B>
 
39
          sort a generic list
 
40
 
 
41
     <B><A HREF="../htmlman3/lDumpList.html">lDumpList(3)</A></B>
 
42
          dump a generic list to file
 
43
 
 
44
     <B><A HREF="../htmlman3/lUndumpList.html">lUndumpList(3)</A></B>
 
45
          undump a generic list with all its data from file
 
46
 
 
47
     <B><A HREF="../htmlman3/lWriteList.html">lWriteList(3)</A></B>
 
48
          write a generic list to stdout
 
49
 
 
50
     <B><A HREF="../htmlman3/lGetListName.html">lGetListName(3)</A></B>
 
51
          return the name of a generic list
 
52
 
 
53
     <B><A HREF="../htmlman3/lGetListDescr.html">lGetListDescr(3)</A></B>
 
54
          return a pointer to the descriptor of a generic list
 
55
 
 
56
     <B><A HREF="../htmlman3/lGetNumberOfElem.html">lGetNumberOfElem(3)</A></B>
 
57
          return the number of list elements contained in a  gen-
 
58
          eric list
 
59
 
 
60
     <B><A HREF="../htmlman3/lGetNumberOfRemainingElem.html">lGetNumberOfRemainingElem(3)</A></B>
 
61
          return the number of list  elements  contained  in  the
 
62
          remainder of a generic list after a specified list ele-
 
63
          ment
 
64
 
 
65
  LIST ELEMENT FUNCTIONS
 
66
     <B><A HREF="../htmlman3/lCreateElem.html">lCreateElem(3)</A></B>
 
67
          create a generic list element
 
68
 
 
69
     <B><A HREF="../htmlman3/lFreeElem.html">lFreeElem(3)</A></B>
 
70
          frees the memory allocated for a generic list  element,
 
71
          its strings and its sub-lists
 
72
 
 
73
     <B><A HREF="../htmlman3/lCopyElem.html">lCopyElem(3)</A></B>
 
74
          duplicate a list element with  all  its  sub-lists  and
 
75
          strings
 
76
 
 
77
     <B><A HREF="../htmlman3/lAppendElem.html">lAppendElem(3)</A></B>
 
78
          append a list element to an existing list
 
79
 
 
80
     <B><A HREF="../htmlman3/lInsertElem.html">lInsertElem(3)</A></B>
 
81
          insert a list element into an  existing  list  after  a
 
82
          specified element
 
83
 
 
84
     <B><A HREF="../htmlman3/lDechainElem.html">lDechainElem(3)</A></B>
 
85
          dechain a list element from a list, the dechained  ele-
 
86
          ment is not freed
 
87
 
 
88
     <B><A HREF="../htmlman3/lFirst.html">lFirst(3)</A></B>
 
89
          get the first list element
 
90
 
 
91
     <B><A HREF="../htmlman3/lLast.html">lLast(3)</A></B>
 
92
          get the last list element
 
93
 
 
94
     <B><A HREF="../htmlman3/lNext.html">lNext(3)</A></B>
 
95
          get the successor of the list element
 
96
 
 
97
     <B><A HREF="../htmlman3/lPrev.html">lPrev(3)</A></B>
 
98
          get the predecessor of the list element
 
99
 
 
100
     <B><A HREF="../htmlman3/lFindFirst.html">lFindFirst(3)</A></B>
 
101
          find the first list element matching  specified  condi-
 
102
          tions
 
103
 
 
104
     <B><A HREF="../htmlman3/lFindLast.html">lFindLast(3)</A></B>
 
105
          find the last list element  matching  specified  condi-
 
106
          tions
 
107
 
 
108
     <B><A HREF="../htmlman3/lFindNext.html">lFindNext(3)</A></B>
 
109
          find the next list element starting at a  certain  list
 
110
          element matching specified conditions
 
111
 
 
112
     <B><A HREF="../htmlman3/lFindPrev.html">lFindPrev(3)</A></B>
 
113
          find the previous list element starting  at  a  certain
 
114
          list element matching specified conditions
 
115
 
 
116
     <B><A HREF="../htmlman3/lDumpElem.html">lDumpElem(3)</A></B>
 
117
          dump a list element to file
 
118
 
 
119
     <B><A HREF="../htmlman3/lUndumpElem.html">lUndumpElem(3)</A></B>
 
120
          undump a list element from file into memory
 
121
 
 
122
     <B><A HREF="../htmlman3/lWriteElem.html">lWriteElem(3)</A></B>
 
123
          write a list element to stdout
 
124
 
 
125
     <B><A HREF="../htmlman3/lGetPosViaElem.html">lGetPosViaElem(3)</A></B>
 
126
          get the field position of a  list  element  field  with
 
127
          name 'nm'
 
128
 
 
129
  FIELD ACCESS FUNCTIONS
 
130
     <B><A HREF="../htmlman3/lGetInt.html">lGetInt(3)</A></B>
 
131
 
 
132
     <B><A HREF="../htmlman3/lGetUlong.html">lGetUlong(3)</A></B>
 
133
 
 
134
     <B><A HREF="../htmlman3/lGetString.html">lGetString(3)</A></B>
 
135
 
 
136
     <B><A HREF="../htmlman3/lGetList.html">lGetList(3)</A></B>
 
137
 
 
138
     <B><A HREF="../htmlman3/lGetFloat.html">lGetFloat(3)</A></B>
 
139
 
 
140
     <B><A HREF="../htmlman3/lGetDouble.html">lGetDouble(3)</A></B>
 
141
 
 
142
     <B><A HREF="../htmlman3/lGetChar.html">lGetChar(3)</A></B>
 
143
 
 
144
     <B><A HREF="../htmlman3/lGetLong.html">lGetLong(3)</A></B>
 
145
 
 
146
          get the value of the specified type from a list element
 
147
          field;  the element and the field name are delivered as
 
148
          arguments
 
149
 
 
150
     <B><A HREF="../htmlman3/lSetInt.html">lSetInt(3)</A></B>
 
151
 
 
152
     <B><A HREF="../htmlman3/lSetUlong.html">lSetUlong(3)</A></B>
 
153
 
 
154
     <B><A HREF="../htmlman3/lSetString.html">lSetString(3)</A></B>
 
155
 
 
156
     <B><A HREF="../htmlman3/lSetList.html">lSetList(3)</A></B>
 
157
 
 
158
     <B><A HREF="../htmlman3/lSetFloat.html">lSetFloat(3)</A></B>
 
159
 
 
160
     <B><A HREF="../htmlman3/lSetDouble.html">lSetDouble(3)</A></B>
 
161
     <B><A HREF="../htmlman3/lSetChar.html">lSetChar(3)</A></B>
 
162
 
 
163
     <B><A HREF="../htmlman3/lSetLong.html">lSetLong(3)</A></B>
 
164
 
 
165
          set the value of the specified type in a  corresponding
 
166
          list  element  field; the element, the field name and a
 
167
          new value are delivered as arguments
 
168
 
 
169
     <B><A HREF="../htmlman3/lGetPosInt.html">lGetPosInt(3)</A></B>
 
170
 
 
171
     <B><A HREF="../htmlman3/lGetPosUlong.html">lGetPosUlong(3)</A></B>
 
172
 
 
173
     <B><A HREF="../htmlman3/lGetPosString.html">lGetPosString(3)</A></B>
 
174
 
 
175
     <B><A HREF="../htmlman3/lGetPosList.html">lGetPosList(3)</A></B>
 
176
 
 
177
     <B><A HREF="../htmlman3/lGetPosFloat.html">lGetPosFloat(3)</A></B>
 
178
 
 
179
     <B><A HREF="../htmlman3/lGetPosDouble.html">lGetPosDouble(3)</A></B>
 
180
 
 
181
     <B><A HREF="../htmlman3/lGetPosChar.html">lGetPosChar(3)</A></B>
 
182
 
 
183
     <B><A HREF="../htmlman3/lGetPosLong.html">lGetPosLong(3)</A></B>
 
184
 
 
185
          get the value of the specified type in a  corresponding
 
186
          list  element field; the element and the field position
 
187
          are delivered as arguments
 
188
 
 
189
     <B><A HREF="../htmlman3/lSetPosInt.html">lSetPosInt(3)</A></B>
 
190
 
 
191
     <B><A HREF="../htmlman3/lSetPosUlong.html">lSetPosUlong(3)</A></B>
 
192
 
 
193
     <B><A HREF="../htmlman3/lSetPosString.html">lSetPosString(3)</A></B>
 
194
 
 
195
     <B><A HREF="../htmlman3/lSetPosList.html">lSetPosList(3)</A></B>
 
196
 
 
197
     <B><A HREF="../htmlman3/lSetPosFloat.html">lSetPosFloat(3)</A></B>
 
198
 
 
199
     <B><A HREF="../htmlman3/lSetPosDouble.html">lSetPosDouble(3)</A></B>
 
200
 
 
201
     <B><A HREF="../htmlman3/lSetPosChar.html">lSetPosChar(3)</A></B>
 
202
 
 
203
     <B><A HREF="../htmlman3/lSetPosLong.html">lSetPosLong(3)</A></B>
 
204
 
 
205
          set the value of the specified type in a  corresponding
 
206
          list element field; the element, the field position and
 
207
          the new value are delivered as arguments
 
208
 
 
209
  LIST DESCRIPTOR FUNCTIONS
 
210
     <B><A HREF="../htmlman3/lInit.html">lInit(3)</A></B>
 
211
          initialize the name to string conversion
 
212
 
 
213
     <B><A HREF="../htmlman3/lNm2Str.html">lNm2Str(3)</A></B>
 
214
          convert an int value specifying a  field  name  to  its
 
215
          corresponding name string
 
216
 
 
217
     <B><A HREF="../htmlman3/_lNm2Str.html">_lNm2Str(3)</A></B>
 
218
          convert an int value specifying a  field  name  to  its
 
219
          corresponding name string using a specified name space
 
220
 
 
221
     <B><A HREF="../htmlman3/lStr2Nm.html">lStr2Nm(3)</A></B>
 
222
          convert a field name to its corresponding field id
 
223
 
 
224
     <B><A HREF="../htmlman3/_lStr2Nm.html">_lStr2Nm(3)</A></B>
 
225
          convert a field name  to  its  corresponding  field  id
 
226
          using a specified name space
 
227
 
 
228
     <B><A HREF="../htmlman3/lCountDescr.html">lCountDescr(3)</A></B>
 
229
          get the number of fields of a descriptor
 
230
 
 
231
     <B><A HREF="../htmlman3/lGetPosInDescr.html">lGetPosInDescr(3)</A></B>
 
232
          get the position of  the  field  named  'nm'  from  the
 
233
          descriptor
 
234
 
 
235
     <B><A HREF="../htmlman3/lDumpDescr.html">lDumpDescr(3)</A></B>
 
236
          dump a list descriptor to a file
 
237
 
 
238
     <B><A HREF="../htmlman3/lUndumpDescr.html">lUndumpDescr(3)</A></B>
 
239
          undump a list descriptor from a file to memory
 
240
 
 
241
     <B><A HREF="../htmlman3/lWriteDescr.html">lWriteDescr(3)</A></B>
 
242
          write a descriptor to stdout
 
243
 
 
244
  LIST DATABASE FUNCTIONS
 
245
     <B><A HREF="../htmlman3/lSelect.html">lSelect(3)</A></B>
 
246
          select returns a list of elements that match the speci-
 
247
          fied conditions.
 
248
 
 
249
     <B><A HREF="../htmlman3/lSelectDestroy.html">lSelectDestroy(3)</A></B>
 
250
          select reduces a list to those  elements  matching  the
 
251
          specified conditions.
 
252
 
 
253
     <B><A HREF="../htmlman3/lSplit.html">lSplit(3)</A></B>
 
254
          splits a list into two parts.  One  part  contains  all
 
255
          elements  fulfilling  the specified condition the other
 
256
          part contains the elements not  fulfilling  the  condi-
 
257
          tion.
 
258
 
 
259
     <B><A HREF="../htmlman3/lJoinSublist.html">lJoinSublist(3)</A></B>
 
260
          join a specified list with one of  its  sub-lists;  one
 
261
          can  specify  conditions for the list and the sub-list.
 
262
          The joined list is returned and the  original  list  is
 
263
          unchanged.
 
264
 
 
265
     <B><A HREF="../htmlman3/lJoin.html">lJoin(3)</A></B>
 
266
          join two lists which fulfill the  specified  conditions
 
267
          to a new list that contains the enumerated fields.  The
 
268
          joined list is returned  and  the  original  lists  are
 
269
          unaltered.
 
270
 
 
271
     <B><A HREF="../htmlman3/lWhere.html">lWhere(3)</A></B>
 
272
          build a lCondition data structure which is used as con-
 
273
          dition for various functions as lSelect or lJoin
 
274
 
 
275
     <B><A HREF="../htmlman3/_lWhere.html">_lWhere(3)</A></B>
 
276
          build a lCondition data structure which is used as con-
 
277
          dition for various functions as lSelect or lJoin
 
278
 
 
279
     <B><A HREF="../htmlman3/lOrWhere.html">lOrWhere(3)</A></B>
 
280
          build a lCondition data structure composed of two  con-
 
281
          ditions connected by logical or
 
282
 
 
283
     <B><A HREF="../htmlman3/lAndWhere.html">lAndWhere(3)</A></B>
 
284
          build a lCondition data structure composed of two  con-
 
285
          ditions connected by logical and
 
286
 
 
287
     <B><A HREF="../htmlman3/lFreeWhere.html">lFreeWhere(3)</A></B>
 
288
          free a lCondition data structure
 
289
 
 
290
     <B><A HREF="../htmlman3/lWriteWhere.html">lWriteWhere(3)</A></B>
 
291
          write a lCondition data structure to stdout
 
292
 
 
293
     <B><A HREF="../htmlman3/lWhat.html">lWhat(3)</A></B>
 
294
          build a lEnumeration data structure which  is  used  to
 
295
          specify  the  fields  that  are  contained  in  a newly
 
296
          created list element
 
297
 
 
298
     <B><A HREF="../htmlman3/lFreeWhat.html">lFreeWhat(3)</A></B>
 
299
          free a lEnumeration data structure
 
300
 
 
301
     <B><A HREF="../htmlman3/lWriteWhat.html">lWriteWhat(3)</A></B>
 
302
          write a lEnumeration data structure to stdout
 
303
 
 
304
     <B><A HREF="../htmlman3/lCountWhat.html">lCountWhat(3)</A></B>
 
305
          count the number  of  fields  in  a  lEnumeration  data
 
306
          structure
 
307
 
 
308
  DATA STRUCTURES
 
309
     The following essential data  structures  are  used  by  the
 
310
     various list library functions.
 
311
 
 
312
     lDescr *descriptor
 
313
          The descriptor contains the  information  which  fields
 
314
          (name, type) are contained in a list.
 
315
 
 
316
     lList  *list
 
317
          The lList pointer specifies a list created by lCreateL-
 
318
          ist  or  any  of the other functions generating a list.
 
319
          Here the name of the list, a reference to the  descrip-
 
320
          tor, the number of contained list elements and a refer-
 
321
          ence to the first and last list element are stored.
 
322
 
 
323
     lListElem *list_element
 
324
          The lListElem pointer is returned on creation of a  new
 
325
          list element and contains the actual data.
 
326
 
 
327
     lCondition *conditions
 
328
          The lCondition pointer is a representation of logically
 
329
          connected  compare  operations.  It  serves  to  decide
 
330
          whether it should be operated on a  special  list  ele-
 
331
          ment.
 
332
 
 
333
     lEnumeration *field_enumerations
 
334
          The lEnumeration pointer specifies which  fields  of  a
 
335
          given  list  element  shall  be involved in a specified
 
336
          action. It is possible under certain  circumstances  to
 
337
          specify all fields or no field at all.
 
338
 
 
339
     lSortOrder *sorting_order
 
340
          The lSortOrder pointer is used to specify sorting  cri-
 
341
          teria  for  a  generic  list. It is possible to declare
 
342
          combined sorting keys.
 
343
 
 
344
SEE ALSO
 
345
     <B><A HREF="../htmlman1/sge_intro.html">sge_intro(1)</A></B>.
 
346
 
 
347
COPYRIGHT
 
348
     See <B><A HREF="../htmlman1/sge_intro.html">sge_intro(1)</A></B> for a full statement of rights and  permis-
 
349
     sions.
 
350
 
 
351
 
 
352
 
 
353
 
 
354
 
 
355
 
 
356
 
 
357
 
 
358
 
 
359
 
 
360
 
 
361
 
 
362
 
 
363
 
 
364
 
 
365
 
 
366
 
 
367
 
 
368
 
 
369
</PRE>
 
370
<HR>
 
371
<ADDRESS>
 
372
Man(1) output converted with
 
373
<a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a>
 
374
</ADDRESS>
 
375
</BODY>
 
376
</HTML>