Add a useful package (from Source forge) for octave

[CreaPhase.git] / octave_packages / struct-1.0.10 / doc-cache

diff --git a/octave_packages/struct-1.0.10/doc-cache b/octave_packages/struct-1.0.10/doc-cache
new file mode 100644 (file)
index 0000000..6382000
--- /dev/null
+++ b/octave_packages/struct-1.0.10/doc-cache
@@ -0,0 +1,117 @@
+# Created by Octave 3.6.1, Sat May 26 20:16:56 2012 UTC <root@brouzouf>
+# name: cache
+# type: cell
+# rows: 3
+# columns: 4
+# name: <cell-element>
+# type: sq_string
+# elements: 1
+# length: 9
+getfields
+
+
+# name: <cell-element>
+# type: sq_string
+# elements: 1
+# length: 239
+ -- Built-in Function:  [V1,...] =
+     getfields (S, 'k1',...) = [S.k1,...]  Return selected values from
+     a scalar struct. Provides some compatibility and some flexibility.
+
+   See also: setfields, rmfield, isfield, isstruct, struct
+
+
+
+
+# name: <cell-element>
+# type: sq_string
+# elements: 1
+# length: 20
+getfields (S, 'k1',.
+
+
+
+# name: <cell-element>
+# type: sq_string
+# elements: 1
+# length: 9
+setfields
+
+
+# name: <cell-element>
+# type: sq_string
+# elements: 1
+# length: 255
+ -- Function File:  S = setfields(S,KEY,VALUE,...)
+     Sets S.KEY1 = VALUE1,  S.KEY2 = VALUE2, etc, finally returning s.
+     For some compatibility and flexibility.
+
+     See also: cmpstruct, fields, rmfield, isstruct, getfields,
+     isfield, struct
+
+
+
+
+
+# name: <cell-element>
+# type: sq_string
+# elements: 1
+# length: 7
+Sets S.
+
+
+
+# name: <cell-element>
+# type: sq_string
+# elements: 1
+# length: 4
+tars
+
+
+# name: <cell-element>
+# type: sq_string
+# elements: 1
+# length: 200
+ s = tars (foo,bar, ... ) == struct ("foo",foo,"bar",bar,...)
+
+ Groups foo, bar, ... into a struct whose fields are "foo", "bar" ...
+ and such that s.foo == foo, s.bar == bar ...  
+
+ See also : untar
+
+
+
+# name: <cell-element>
+# type: sq_string
+# elements: 1
+# length: 21
+ s = tars (foo,bar, .
+
+
+
+# name: <cell-element>
+# type: sq_string
+# elements: 1
+# length: 11
+test_struct
+
+
+# name: <cell-element>
+# type: sq_string
+# elements: 1
+# length: 38
+ EOF my test function ###############
+
+
+
+# name: <cell-element>
+# type: sq_string
+# elements: 1
+# length: 38
+ EOF my test function ###############
+
+
+
+
+
+