=head1 NAME

table - table manipulation functions (standard library)

=head1 OVERVIEW

This library provides generic functions for table manipulation.  It
provides all its functions inside the table C<table>.

Most functions in the table library assume that the table
represents an array or a list.
For these functions, when we talk about the "length" of a table
we mean the result of the length operator.

=head2 C<table.concat>

  table.concat (table [, sep [, i [, j]]])

Returns C<table[i]..sep..table[i+1] E...sep..table[j]>.  The default
value for C<sep> is the empty string, the default for C<i> is 1, and
the default for C<j> is the length of the table.  If C<i> is greater
than C<j>, returns the empty string.

=head2 C<table.insert>

  table.insert (table, [pos,] value)

Inserts element C<value> at position C<pos> in C<table>, shifting up
other elements to open space, if necessary.  The default value for
C<pos> is C<n+1>, where C<n> is the length of the table (see sect
2.5.5), so that a call C<table.insert(t,x)> inserts C<x> at the end of
table C<t>.

=head2 C<table.maxn>

  table.maxn (table)

Returns the largest positive numerical index of the given table, or
zero if the table has no positive numerical indices.  (To do its job
this function does a linear traversal of the whole table.)

=head2 C<table.remove>

  table.remove (table [, pos])

Removes from C<table> the element at position
C<pos>, shifting down other elements to close the space, if
necessary.  Returns the value of the removed element.  The default
value for C<pos> is C<n>, where C<n> is
the length of the table, so that a call C<table.remove(t)>
removes the last element of table C<t>.

=head2 C<table.sort>

  table.sort (table [, comp])

Sorts table elements in a given order, I<in-place>, from C<table[1]>
to C<table[n]>, where C<n> is the length of the table.  If C<comp> is
given, then it must be a function that receives two table elements,
and returns true when the first is less than the second (so that C<not
comp(a[i+1],a[i])> will be true after the sort).  If C<comp> is not
given, then the standard Lua operator C<<> is used instead.

The sort algorithm is not stable; that is, elements considered equal
by the given order may have their relative positions changed by the
sort.

=head1 VERSION

This is Lua version 5.1.1.

=head1 CREDITS

Lua is developed at Lua.org, a laboratory of the Department of
Computer Science of PUC-Rio (the Pontifical Catholic University of Rio
de Janeiro in Brazil).  For more information about the authors, see
http://www.lua.org/authors.html .

=head1 LICENSE

Lua is licensed under the terms of the MIT license reproduced below.
This means that Lua is free software and can be used for both academic
and commercial purposes at absolutely no cost.

For details and rationale, see http://www.lua.org/license.html .

~~~~~

Copyright (C) 1994-2006 Lua.org, PUC-Rio.

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.

~~~~~