+++ /dev/null
-.\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.32
-.\"
-.\" 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. \*(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-
-.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 "tst 3"
-.TH tst 3 "2008-04-06" "INN 2.4.5" "InterNetNews Documentation"
-.SH "NAME"
-tst \- ternary search trie functions
-.SH "SYNOPSIS"
-.IX Header "SYNOPSIS"
-\&\fB#include <inn/tst.h>\fR
-.PP
-\&\fBstruct tst;\fR
-.PP
-\&\fBstruct tst *tst_init(int \fR\fInode_line_width\fR\fB);\fR
-.PP
-\&\fBvoid tst_cleanup(struct tst *\fR\fItst\fR\fB);\fR
-.PP
-\&\fBint tst_insert(struct tst *\fR\fItst\fR\fB, const unsigned char *\fR\fIkey\fR\fB, void *\fR\fIdata\fR\fB, int \fR\fIoption\fR\fB, void **\fR\fIexist_ptr\fR\fB);\fR
-.PP
-\&\fBvoid *tst_search(struct tst *\fR\fItst\fR\fB, const unsigned char *\fR\fIkey\fR\fB);\fR
-.PP
-\&\fBvoid *tst_delete(struct tst *\fR\fItst\fR\fB, const unsigned char *\fR\fIkey\fR\fB);\fR
-.SH "DESCRIPTION"
-.IX Header "DESCRIPTION"
-\&\fBtst_init\fR allocates memory for members of \fIstruct tst\fR, and
-allocates the first \fInode_line_width\fR nodes. A \s-1NULL\s0 pointer is
-returned by \fBtst_init\fR if any part of the memory allocation fails. On
-success, a pointer to a \fIstruct tst\fR is returned.
-.PP
-The value for \fInode_line_width\fR must be chosen very carefully. One
-node is required for every character in the tree. If you choose a
-value that is too small, your application will spend too much time
-calling \fImalloc\fR\|(3) and your node space will be too spread out. Too large
-a value is just a waste of space.
-.PP
-\&\fBtst_cleanup\fR frees all memory allocated to nodes, internal structures,
-as well as \fItst\fR itself.
-.PP
-\&\fBtst_insert\fR inserts the string \fIkey\fR into the tree. Behavior when a
-duplicate key is inserted is controlled by \fIoption\fR. If \fIkey\fR is
-already in the tree then \fB\s-1TST_DUPLICATE_KEY\s0\fR is returned, and the
-data pointer for the existing key is placed in \fIexist_ptr\fR. If
-\&\fIoption\fR is set to \fB\s-1TST_REPLACE\s0\fR then the existing data pointer for
-the existing key is replaced by \fIdata\fR. Note that the old data
-pointer will still be placed in \fIexist_ptr\fR.
-.PP
-If a duplicate key is encountered and \fIoption\fR is not set to
-\&\fB\s-1TST_REPLACE\s0\fR then \fB\s-1TST_DUPLICATE_KEY\s0\fR is returned. If \fIkey\fR is
-zero length then \fB\s-1TST_NULL_KEY\s0\fR is returned. A successful insert or
-replace returns \fB\s-1TST_OK\s0\fR. A return value of \fB\s-1TST_ERROR\s0\fR indicates
-that a memory allocation error occurred while trying to grow the node
-free.
-.PP
-Note that the \fIdata\fR argument must never be \fB\s-1NULL\s0\fR. If it is, then
-calls to \fBtst_search\fR will fail for a key that exists because the
-data value was set to \fB\s-1NULL\s0\fR, which is what \fBtst_search\fR returns. If
-you just want a simple existence tree, use the \fBtst\fR pointer as the
-data pointer.
-.PP
-\&\fBtst_search\fR finds the string \fIkey\fR in the tree if it exists and
-returns the data pointer associated with that key.
-.PP
-If \fIkey\fR is not found then \fB\s-1NULL\s0\fR is returned, otherwise the data pointer
-associated with \fIkey\fR is returned.
-.PP
-\&\fBtst_delete\fR deletes the string \fIkey\fR from the tree if it exists and
-returns the data pointer assocaited with that key.
-.PP
-If \fIkey\fR is not found then \fB\s-1NULL\s0\fR is returned, otherwise the data
-pointer associated with \fIkey\fR is returned.
-.SH "HISTORY"
-.IX Header "HISTORY"
-Converted to \s-1POD\s0 from Peter A. Friend's ternary search trie
-documentation by Alex Kiernan <alex.kiernan@thus.net> for InterNetNews
-2.4.0.
-.PP
-$Id: tst.3 7880 2008-06-16 20:37:13Z iulius $
~ian / innduct.git / blobdiff