]> Creatis software - CreaPhase.git/blob - octave_packages/struct-1.0.10/doc-cache
Add a useful package (from Source forge) for octave
[CreaPhase.git] / octave_packages / struct-1.0.10 / doc-cache
1 # Created by Octave 3.6.1, Sat May 26 20:16:56 2012 UTC <root@brouzouf>
2 # name: cache
3 # type: cell
4 # rows: 3
5 # columns: 4
6 # name: <cell-element>
7 # type: sq_string
8 # elements: 1
9 # length: 9
10 getfields
11
12
13 # name: <cell-element>
14 # type: sq_string
15 # elements: 1
16 # length: 239
17  -- Built-in Function:  [V1,...] =
18      getfields (S, 'k1',...) = [S.k1,...]  Return selected values from
19      a scalar struct. Provides some compatibility and some flexibility.
20
21    See also: setfields, rmfield, isfield, isstruct, struct
22
23
24
25
26 # name: <cell-element>
27 # type: sq_string
28 # elements: 1
29 # length: 20
30 getfields (S, 'k1',.
31
32
33
34 # name: <cell-element>
35 # type: sq_string
36 # elements: 1
37 # length: 9
38 setfields
39
40
41 # name: <cell-element>
42 # type: sq_string
43 # elements: 1
44 # length: 255
45  -- Function File:  S = setfields(S,KEY,VALUE,...)
46      Sets S.KEY1 = VALUE1,  S.KEY2 = VALUE2, etc, finally returning s.
47      For some compatibility and flexibility.
48
49      See also: cmpstruct, fields, rmfield, isstruct, getfields,
50      isfield, struct
51
52
53
54
55
56 # name: <cell-element>
57 # type: sq_string
58 # elements: 1
59 # length: 7
60 Sets S.
61
62
63
64 # name: <cell-element>
65 # type: sq_string
66 # elements: 1
67 # length: 4
68 tars
69
70
71 # name: <cell-element>
72 # type: sq_string
73 # elements: 1
74 # length: 200
75  s = tars (foo,bar, ... ) == struct ("foo",foo,"bar",bar,...)
76
77  Groups foo, bar, ... into a struct whose fields are "foo", "bar" ...
78  and such that s.foo == foo, s.bar == bar ...  
79
80  See also : untar
81
82
83
84 # name: <cell-element>
85 # type: sq_string
86 # elements: 1
87 # length: 21
88  s = tars (foo,bar, .
89
90
91
92 # name: <cell-element>
93 # type: sq_string
94 # elements: 1
95 # length: 11
96 test_struct
97
98
99 # name: <cell-element>
100 # type: sq_string
101 # elements: 1
102 # length: 38
103  EOF my test function ###############
104
105
106
107 # name: <cell-element>
108 # type: sq_string
109 # elements: 1
110 # length: 38
111  EOF my test function ###############
112
113
114
115
116
117