changeset 8584:848f7d3e589c

Update the examples for structure arrays in container.txi
author Thorsten Meyer <thorsten.meyier@gmx.de>
date Sat, 24 Jan 2009 16:37:48 +0100
parents 27b2db6ff0d7
children e6497be3f3d6
files doc/ChangeLog doc/interpreter/container.txi
diffstat 2 files changed, 42 insertions(+), 24 deletions(-) [+]
line wrap: on
line diff
--- a/doc/ChangeLog	Fri Jan 23 15:03:39 2009 -0500
+++ b/doc/ChangeLog	Sat Jan 24 16:37:48 2009 +0100
@@ -1,3 +1,8 @@
+2009-01-24  Thorsten Meyer  <thorsten@hexe>
+
+	* interpreter/container.txi (Data Structures): Update examples for
+	structure arrays.
+
 2009-01-22  John W. Eaton  <jwe@octave.org>
 
 	* interpreter/io.txi (Terminal Output): Remove @DOCSTRING(ans).
--- a/doc/interpreter/container.txi	Fri Jan 23 15:03:39 2009 -0500
+++ b/doc/interpreter/container.txi	Sat Jan 24 16:37:48 2009 +0100
@@ -240,24 +240,14 @@
 
 @example
 @group
-octave:2> x
+octave:1> x
 x =
 @{
-  a =
-
-  (,
-    [1] = string1
-    [2] = string2
-  ,)
+  1x2 struct array containing the fields:
 
-  b =
-
-  (,
-    [1] =  1
-    [2] =  2
-  ,)
-
-@}
+    a
+    b
+@}  
 @end group
 @end example
 
@@ -283,24 +273,47 @@
 @example
 @group
 octave:3> x.a
-ans =
-
-(,
-  [1] = string1
-  [2] = string2
-,)
+ans = string1
+ans = string2
 @end group
 @end example
 
-The function @code{size} with return the size of the structure. For
+Here is another example, using this comma separated list on the
+left-hand side of an assignment:
+
+@example
+@group
+octave:4> [x.a] = deal("new string1", "new string2");
+octave:5> x(1).a
+ans = new string1
+octave:6> x(2).a
+ans = new string2
+@end group
+@end example
+
+Just as for numerical arrays, it is possible to use vectors as indices (@pxref{Index Expressions}):
+
+@example
+@group
+octave:7> x(3:4) = x(1:2);
+octave:8> [x([1,3]).a] = deal("other string1", "other string2");
+octave:9> x.a
+ans = other string1
+ans = new string2
+ans = other string2
+ans = new string2
+@end group
+@end example
+
+The function @code{size} will return the size of the structure. For
 the example above
 
 @example
 @group
-octave:4> size(x)
+octave:10> size(x)
 ans =
 
-   1   2
+   1   4
 @end group
 @end example