.\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.13
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sh \" Subsection heading
.br
.if t .Sp
.ne 5
.PP
\fB\\$1\fR
.PP
..
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  | will give a
.\" real vertical bar.  \*(C+ will give a nicer C++.  Capital omega is used to
.\" do unbreakable dashes and therefore won't be available.  \*(C` and \*(C'
.\" expand to `' in nroff, nothing in troff, for use with C<>.
.tr \(*W-|\(bv\*(Tr
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
'br\}
.\"
.\" If the F register is turned on, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.if \nF \{\
.    de IX
.    tm Index:\\$1\t\\n%\t"\\$2"
..
.    nr % 0
.    rr F
.\}
.\"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.hy 0
.if n .na
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
.    \" fudge factors for nroff and troff
.if n \{\
.    ds #H 0
.    ds #V .8m
.    ds #F .3m
.    ds #[ \f1
.    ds #] \fP
.\}
.if t \{\
.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
.    ds #V .6m
.    ds #F 0
.    ds #[ \&
.    ds #] \&
.\}
.    \" simple accents for nroff and troff
.if n \{\
.    ds ' \&
.    ds ` \&
.    ds ^ \&
.    ds , \&
.    ds ~ ~
.    ds /
.\}
.if t \{\
.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
.    \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
.    \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
.    \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
.    ds : e
.    ds 8 ss
.    ds o a
.    ds d- d\h'-1'\(ga
.    ds D- D\h'-1'\(hy
.    ds th \o'bp'
.    ds Th \o'LP'
.    ds ae ae
.    ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "rarray 3"
.TH rarray 3 "2003-10-23" "Roy 1.0.7" "Roy API Docs"
.SH "NAME"
rchunk \- Roy variable sized arrays
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
#include <roy.h>
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
Implements variable sized arrays.  These arrays are allocated in chunks, with
the each chunk pointing to the next.  This structure has the advantage that
many of the entries are in order in memory, which allows you to walk them
in order very fast, as this is usually the way that the cache is implemented.
.PP
If you are storing structures in the array, it also has the advantage that
the members of the structure exist in the linear array, again increasing
cache hits of the structure members.
.PP
They may also be used to implement stacks.
.PP
Thay are also used as a linked list replacement with less overhead (no
next/previous pointers).
.SH "RARRAY_FOREACH (array, entry)"
.IX Header "RARRAY_FOREACH (array, entry)"
Because the array is broken up into chunks (see \fIrarray_new\fR\|(3)), in order to
walk the array, you must use the \s-1RARRAY_FOREACH\s0 macro.
.PP
This macro walks through the array, assigning 'entry' to the
concequent array entry through each iteration.  The programmer can
use \f(CW\*(C`break\*(C'\fR, \f(CW\*(C`continue\*(C'\fR, or \f(CW\*(C`goto\*(C'\fR safely.  All rarray functions
can be called safely inside the \s-1RLIST_FOREACH\s0 macro except
\&\fIrarray_free\fR\|(3).  You also cannot remove the next item in the array,
as a pointer is kept to it through each iteration.
.RE
.IP "\s-1EXAMPLE\s0"
.IX Item "EXAMPLE"
To walk an array:
.PP
.Vb 2
\&        MyEntry *entry;
\&        RArray *array;
.Ve
.PP
.Vb 1
\&        /* ... */
.Ve
.PP
.Vb 4
\&        RARRAY_FOREACH (array, entry) {
\&                /* do something with entry */
\&                entry->foo++;
\&        } RFOREACH_CLOSE;
.Ve
.SH "SEE ALSO"
.IX Header "SEE ALSO"
\&\fIrarray_append\fR\|(3), \fIrarray_free\fR\|(3), 
\&\fIrarray_last\fR\|(3), \fIrarray_len\fR\|(3), 
\&\fIrarray_new\fR\|(3), \fIrarray_nth\fR\|(3), 
\&\fIrarray_peek\fR\|(3), \fIrarray_pop\fR\|(3), 
\&\fIrarray_push\fR\|(3), \fIrarray_set_len\fR\|(3), 
\&\fIroy\fR\|(3)