File: elementary_getfield.html

package info (click to toggle)
freemat 4.0-3
  • links: PTS, VCS
  • area: main
  • in suites: squeeze
  • size: 174,756 kB
  • ctags: 67,023
  • sloc: cpp: 351,059; ansic: 255,892; sh: 40,590; makefile: 4,387; perl: 4,058; asm: 3,313; pascal: 2,718; fortran: 1,722; ada: 1,681; ml: 1,360; cs: 879; csh: 795; python: 430; sed: 162; lisp: 160; awk: 5
file content (33 lines) | stat: -rw-r--r-- 1,000 bytes parent folder | download | duplicates (3)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">

<HTML>
<HEAD>
<TITLE>GETFIELD Get Field Contents
</TITLE>
</HEAD>
<BODY>
<H2>GETFIELD Get Field Contents
</H2>
<P>
Section: <A HREF=sec_elementary.html> Elementary Functions </A>
<H3>Usage</H3>
Given a structure or structure array, returns the contents of the
specified field.  The first version is for scalar structures, and
has the following syntax
<PRE>
   y = getfield(x,'fieldname')
</PRE>
<P>
and is equivalent to <code>y = x.fieldname</code> where <code>x</code> is a scalar (1 x 1)
structure.  If <code>x</code> is not a scalar structure, then <code>y</code> is the 
first value, i.e., it is equivalent to <code>y = x(1).fieldname</code>.  
The second form allows you to specify a subindex into a
structure array, and has the following syntax
<PRE>
    y = getfield(x, {m,n}, 'fieldname')
</PRE>
<P>
and is equivalent to <code>y = x(m,n).fieldname</code>.  You can chain multiple
references together using this syntax.
</BODY>
</HTML>