<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>Class Array - Class Array</title>
<link href="faldoc.css" rel="stylesheet" type="text/css"/>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
</head>
<body class="faldoc_body">
<div class="navitop">
<div class="tabs">
<ul>
<li><a href="./index.html"><span>Main</span></a></li>
<li><a href="./pages.html"><span>Related pages</span></a></li>
<li><a href="./groups.html"><span>Groups</span></a></li>
<li><a href="./funset.html"><span>Function sets</span></a></li>
<li><a href="./classes.html"><span>Classes</span></a></li>
<li><a href="./objects.html"><span>Objects</span></a></li>
<li><a href="./functions.html"><span>All functions</span></a></li>
<li><a href="./globals.html"><span>Globals</span></a></li>
</ul>
</div>
</div>
<hr/>
<h1 class="faldoc_title">Class Array</h1>
<p class="faldoc_brief">MetaClass for Falcon arrays. </p>
<p class="faldoc_funcdecl">
<b>class</b> Array \
<b>from</b> <a href="./class_BOM.html">BOM</a>
</p>
<p class="faldoc_brief"><a href="#more">more...</a></p>
<h2 class="faldoc_title">Summary</h2>
<table class="faldoc_list">
<tr><td><a href="#NM">NM()</a></td><td>Force an array to be non-method. </td></tr>
<tr><td><a href="#add">add()</a></td><td>Adds an element to this array. </td></tr>
<tr><td><a href="#back">back()</a></td><td>Returns and eventually extracts the last element in the array. </td></tr>
<tr><td><a href="#comp">comp()</a></td><td>Appends elements to this array through a filter. </td></tr>
<tr><td><a href="#compact">compact()</a></td><td>Reduces the memory used by an array. </td></tr>
<tr><td><a href="#del">del()</a></td><td>Deletes the first element matching a given item. </td></tr>
<tr><td><a href="#delAll">delAll()</a></td><td>Deletes all the occurrences of a given item in this array. </td></tr>
<tr><td><a href="#fill">fill()</a></td><td>Fills the array with the given element. </td></tr>
<tr><td><a href="#find">find()</a></td><td>Searches for a given item in an array. </td></tr>
<tr><td><a href="#first">first()</a></td><td>Returns an iterator to the head of this array. </td></tr>
<tr><td><a href="#front">front()</a></td><td>Returns and eventually extracts the first element in the array. </td></tr>
<tr><td><a href="#head">head()</a></td><td>Extracts the first element from this array and returns it. </td></tr>
<tr><td><a href="#ins">ins()</a></td><td>Inserts an item into this array array. </td></tr>
<tr><td><a href="#last">last()</a></td><td>Returns an iterator to the last element in this array. </td></tr>
<tr><td><a href="#mcomp">mcomp()</a></td><td>Appends multiple elements to this array. </td></tr>
<tr><td><a href="#merge">merge()</a></td><td>Merges the given array into this one. </td></tr>
<tr><td><a href="#mfcomp">mfcomp()</a></td><td>Appends multiple elements to this array through a filter. </td></tr>
<tr><td><a href="#properties">properties()</a></td><td>Returns an array of properties (bindings) in the array. </td></tr>
<tr><td><a href="#remove">remove()</a></td><td>Removes one or more elements in the array. </td></tr>
<tr><td><a href="#scan">scan()</a></td><td>Searches an array for an item satisfying arbitrary criteria. </td></tr>
<tr><td><a href="#setProperty">setProperty()</a></td><td>Sets a binding (as a property) in the array. </td></tr>
<tr><td><a href="#sort">sort()</a></td><td>Sorts an array, possibly using an arbitrary ordering criterion. </td></tr>
<tr><td><a href="#tabField">tabField()</a></td><td>Returns one of the items in the array, given the field name. </td></tr>
<tr><td><a href="#tabRow">tabRow()</a></td><td>Returns the row ID of this element. </td></tr>
<tr><td><a href="#table">table()</a></td><td>Returns the table related with this array. </td></tr>
<tr><td><a href="#tail">tail()</a></td><td>Extracts the last element of an array and returns it. </td></tr>
</table>
<h3 class="faldoc_title">Inherited methods</h3>
<table class="faldoc_list">
<tr><td><a href="./class_BOM.html#__add">__add</a> from BOM </td><td>Overrides binary addition operand. </td></tr>
<tr><td><a href="./class_BOM.html#__call">__call</a> from BOM </td><td>Overrides call operator "self()". </td></tr>
<tr><td><a href="./class_BOM.html#__dec">__dec</a> from BOM </td><td>Overrides decrement unary prefix operand. </td></tr>
<tr><td><a href="./class_BOM.html#__decpost">__decpost</a> from BOM </td><td>Overrides decrement unary postfix operand. </td></tr>
<tr><td><a href="./class_BOM.html#__div">__div</a> from BOM </td><td>Overrides binary division operand. </td></tr>
<tr><td><a href="./class_BOM.html#__getIndex">__getIndex</a> from BOM </td><td>Overrides array access operator [] </td></tr>
<tr><td><a href="./class_BOM.html#__inc">__inc</a> from BOM </td><td>Overrides increment unary prefix operand. </td></tr>
<tr><td><a href="./class_BOM.html#__incpost">__incpost</a> from BOM </td><td>Overrides increment unary postifx operand. </td></tr>
<tr><td><a href="./class_BOM.html#__mod">__mod</a> from BOM </td><td>Overrides modulo operand. </td></tr>
<tr><td><a href="./class_BOM.html#__mul">__mul</a> from BOM </td><td>Overrides binary multiplication operand. </td></tr>
<tr><td><a href="./class_BOM.html#__pow">__pow</a> from BOM </td><td>Overrides power operand. </td></tr>
<tr><td><a href="./class_BOM.html#__setIndex">__setIndex</a> from BOM </td><td>Overrides array write operator [] </td></tr>
<tr><td><a href="./class_BOM.html#__sub">__sub</a> from BOM </td><td>Overrides binary subtraction operand. </td></tr>
<tr><td><a href="./class_BOM.html#baseClass">baseClass</a> from BOM </td><td>Returns the class item from which an object has been instantiated. </td></tr>
<tr><td><a href="./class_BOM.html#bound">bound</a> from BOM </td><td>Determines if an item is bound or not. </td></tr>
<tr><td><a href="./class_BOM.html#className">className</a> from BOM </td><td>Returns the name of the class an instance is instantiated from. </td></tr>
<tr><td><a href="./class_BOM.html#clone">clone</a> from BOM </td><td>Performs a deep copy of the item. </td></tr>
<tr><td><a href="./class_BOM.html#compare">compare</a> from BOM </td><td>Performs a lexicographical comparison. </td></tr>
<tr><td><a href="./class_BOM.html#derivedFrom">derivedFrom</a> from BOM </td><td>Checks if this item has a given parent. </td></tr>
<tr><td><a href="./class_BOM.html#describe">describe</a> from BOM </td><td>Returns the deep contents of an item on a string representation. </td></tr>
<tr><td><a href="./class_BOM.html#isCallable">isCallable</a> from BOM </td><td>Determines if an item is callable. </td></tr>
<tr><td><a href="./class_BOM.html#len">len</a> from BOM </td><td>Retrieves the length of a collection </td></tr>
<tr><td><a href="./class_BOM.html#metaclass">metaclass</a> from BOM </td><td>Returns the metaclass associated with this item. </td></tr>
<tr><td><a href="./class_BOM.html#ptr">ptr</a> from BOM </td><td>Returns a raw memory pointer out of this data (as an integer). </td></tr>
<tr><td><a href="./class_BOM.html#serialize">serialize</a> from BOM </td><td>Serialize the item on a stream for persistent storage. </td></tr>
<tr><td><a href="./class_BOM.html#toString">toString</a> from BOM </td><td>Coverts the object to string. </td></tr>
<tr><td><a href="./class_BOM.html#typeId">typeId</a> from BOM </td><td>Returns an integer indicating the type of this item. </td></tr>
</table>
<a name="more"><h2 class="faldoc_title">Detailed description</h2></a>
<p class="faldoc_funcdecl">
<b>class</b> Array \
<b>from</b> <a href="./class_BOM.html">BOM</a>
</p>
<table class="faldoc_function">
</table>
<br/>
<p class="item_brief">MetaClass for Falcon arrays. </p>
<p class="faldoc_text">This is the class reflecting the base array classes. </p>
<h2 class="faldoc_title">Methods</h2>
<h3 class="faldoc_funcname"><a name="NM">NM()</a></h3>
<p class="item_brief">Force an array to be non-method. </p>
<p class="faldoc_funcdecl">Array.NM( )</p>
<table class="faldoc_function">
<tr><td class="faldoc_funcreturn">Returns:</td><td class="faldoc_funcreturndesc">The This array </td></tr>
</table>
<h3 class="faldoc_funcname"><a name="add">add()</a></h3>
<p class="item_brief">Adds an element to this array. </p>
<p class="faldoc_funcdecl">Array.add( item )</p>
<table class="faldoc_function">
<tr><td class="faldoc_param">item</td><td class="faldoc_paramdesc">The item to be added. </td></tr>
</table>
<p class="faldoc_text"><p class="faldoc_text">The element will be added at the end of this array, and its size will be increased by one. </p>
</p>
<h3 class="faldoc_funcname"><a name="back">back()</a></h3>
<p class="item_brief">Returns and eventually extracts the last element in the array. </p>
<p class="faldoc_funcdecl">Array.back( [remove] )</p>
<table class="faldoc_function">
<tr><td class="faldoc_optparam">remove</td><td class="faldoc_optparamdesc">true to remove the front item. </td></tr>
<tr><td class="faldoc_funcreturn">Returns:</td><td class="faldoc_funcreturndesc">The extracted item. </td></tr>
<tr><td class="faldoc_raise">Raises:</td><td class="faldoc_raisedesc">
<table class="faldoc_raise">
<tr><td class="faldoc_raiseitem"><a href="./class_AccessError.html">AccessError</a></td><td class="faldoc_raisedesc">if the array is empty. </td></tr>
</table>
</td></tr>
</table>
<h3 class="faldoc_funcname"><a name="comp">comp()</a></h3>
<p class="item_brief">Appends elements to this array through a filter. </p>
<p class="faldoc_funcdecl">Array.comp( source, [filter] )</p>
<table class="faldoc_function">
<tr><td class="faldoc_param">source</td><td class="faldoc_paramdesc">A sequence, a range or a callable generating items. </td></tr>
<tr><td class="faldoc_optparam">filter</td><td class="faldoc_optparamdesc">A filtering function receiving one item at a time. </td></tr>
<tr><td class="faldoc_funcreturn">Returns:</td><td class="faldoc_funcreturndesc">This array. </td></tr>
</table>
<p class="faldoc_text"><p class="faldoc_text"> Please, see the description of <a href="./class_Sequence.html#comp">Sequence.comp</a>. </p>
</p>
<h3 class="faldoc_funcname"><a name="compact">compact()</a></h3>
<p class="item_brief">Reduces the memory used by an array. </p>
<p class="faldoc_funcdecl">Array.compact( )</p>
<table class="faldoc_function">
<tr><td class="faldoc_funcreturn">Returns:</td><td class="faldoc_funcreturndesc">Itself </td></tr>
</table>
<p class="faldoc_text"><p class="faldoc_text">Normally, array operations, as insertions, additions and so on cause the array to grow to accommodate items that may come in the future. also, reducing the size of an array doesn't automatically dispose of the memory held by the array to store its elements. </p>
<p class="faldoc_text">This method grants that the memory used by the array is strictly the memory needed to store its data. </p>
</p>
<h3 class="faldoc_funcname"><a name="del">del()</a></h3>
<p class="item_brief">Deletes the first element matching a given item. </p>
<p class="faldoc_funcdecl">Array.del( item )</p>
<table class="faldoc_function">
<tr><td class="faldoc_param">item</td><td class="faldoc_paramdesc">The item that must be deleted. </td></tr>
<tr><td class="faldoc_funcreturn">Returns:</td><td class="faldoc_funcreturndesc">true if at least one item has been removed, false otherwise. </td></tr>
</table>
<p class="faldoc_text"><p class="faldoc_text">The function scans the array searching for an item that is considered equal to the given one. If such an item can be found, it is removed and the function returns true. If the item cannot be found, false is returned. </p>
<p class="faldoc_text">Only the first item matching the given one will be deleted. </p>
</p>
<h3 class="faldoc_funcname"><a name="delAll">delAll()</a></h3>
<p class="item_brief">Deletes all the occurrences of a given item in this array. </p>
<p class="faldoc_funcdecl">Array.delAll( item )</p>
<table class="faldoc_function">
<tr><td class="faldoc_param">item</td><td class="faldoc_paramdesc">The item that must be deleted. </td></tr>
<tr><td class="faldoc_funcreturn">Returns:</td><td class="faldoc_funcreturndesc">true if at least one item has been removed, false otherwise. </td></tr>
</table>
<p class="faldoc_text"><p class="faldoc_text">This function removes all the elements in this array that are considered equivalent to the given item. If one or more elements have been found and deleted, the function will return true, else it will return false. </p>
</p>
<h3 class="faldoc_funcname"><a name="fill">fill()</a></h3>
<p class="item_brief">Fills the array with the given element. </p>
<p class="faldoc_funcdecl">Array.fill( item )</p>
<table class="faldoc_function">
<tr><td class="faldoc_param">item</td><td class="faldoc_paramdesc">The item to be replicated. </td></tr>
<tr><td class="faldoc_funcreturn">Returns:</td><td class="faldoc_funcreturndesc">This array. </td></tr>
</table>
<p class="faldoc_text"><p class="faldoc_text">This method allows to clear a whole array, resetting all the elements to a default value. </p>
</p>
<h3 class="faldoc_funcname"><a name="find">find()</a></h3>
<p class="item_brief">Searches for a given item in an array. </p>
<p class="faldoc_funcdecl">Array.find( item, [start], [end] )</p>
<table class="faldoc_function">
<tr><td class="faldoc_param">item</td><td class="faldoc_paramdesc">The array that will be searched. </td></tr>
<tr><td class="faldoc_optparam">start</td><td class="faldoc_optparamdesc">Optional first element to be searched. </td></tr><tr><td class="faldoc_optparam">end</td><td class="faldoc_optparamdesc">Optional last element +1 to be searched. </td></tr>
<tr><td class="faldoc_funcreturn">Returns:</td><td class="faldoc_funcreturndesc">The position of the searched item in the array, or -1 if not found. </td></tr>
</table>
<p class="faldoc_text"><p class="faldoc_text">This function searches the array for a given item (or for an item considered equivalent to the given one). If that item is found, the item position is returned, else -1 is returned. </p>
<p class="faldoc_text">An optional range may be specified to limit the search in the interval start included, end excluded. </p>
</p>
<h3 class="faldoc_funcname"><a name="first">first()</a></h3>
<p class="item_brief">Returns an iterator to the head of this array. </p>
<p class="faldoc_funcdecl">Array.first( )</p>
<table class="faldoc_function">
<tr><td class="faldoc_funcreturn">Returns:</td><td class="faldoc_funcreturndesc">An iterator. </td></tr>
</table>
<h3 class="faldoc_funcname"><a name="front">front()</a></h3>
<p class="item_brief">Returns and eventually extracts the first element in the array. </p>
<p class="faldoc_funcdecl">Array.front( [remove] )</p>
<table class="faldoc_function">
<tr><td class="faldoc_optparam">remove</td><td class="faldoc_optparamdesc">true to remove the front item. </td></tr>
<tr><td class="faldoc_funcreturn">Returns:</td><td class="faldoc_funcreturndesc">The extracted item. </td></tr>
<tr><td class="faldoc_raise">Raises:</td><td class="faldoc_raisedesc">
<table class="faldoc_raise">
<tr><td class="faldoc_raiseitem"><a href="./class_AccessError.html">AccessError</a></td><td class="faldoc_raisedesc">if the array is empty. </td></tr>
</table>
</td></tr>
</table>
<h3 class="faldoc_funcname"><a name="head">head()</a></h3>
<p class="item_brief">Extracts the first element from this array and returns it. </p>
<p class="faldoc_funcdecl">Array.head( )</p>
<table class="faldoc_function">
<tr><td class="faldoc_funcreturn">Returns:</td><td class="faldoc_funcreturndesc">The extracted item. </td></tr>
<tr><td class="faldoc_raise">Raises:</td><td class="faldoc_raisedesc">
<table class="faldoc_raise">
<tr><td class="faldoc_raiseitem"><a href="./class_AccessError.html">AccessError</a></td><td class="faldoc_raisedesc">if the array is empty. </td></tr>
</table>
</td></tr>
</table>
<p class="faldoc_text"><p class="faldoc_text">This function removes the first item from the array and returns it. If the original array is empty, AccessError is raised. </p>
</p>
<h3 class="faldoc_funcname"><a name="ins">ins()</a></h3>
<p class="item_brief">Inserts an item into this array array. </p>
<p class="faldoc_funcdecl">Array.ins( itempos, item )</p>
<table class="faldoc_function">
<tr><td class="faldoc_param">itempos</td><td class="faldoc_paramdesc">The position where the item should be placed. </td></tr><tr><td class="faldoc_param">item</td><td class="faldoc_paramdesc">The item to be inserted. </td></tr>
</table>
<p class="faldoc_text"><p class="faldoc_text">The item is inserted before the given position. If pos is 0, the item is inserted in the very first position, while if it's equal to the array length, it is appended at the array tail. </p>
</p>
<h3 class="faldoc_funcname"><a name="last">last()</a></h3>
<p class="item_brief">Returns an iterator to the last element in this array. </p>
<p class="faldoc_funcdecl">Array.last( )</p>
<table class="faldoc_function">
<tr><td class="faldoc_funcreturn">Returns:</td><td class="faldoc_funcreturndesc">An iterator. </td></tr>
</table>
<h3 class="faldoc_funcname"><a name="mcomp">mcomp()</a></h3>
<p class="item_brief">Appends multiple elements to this array. </p>
<p class="faldoc_funcdecl">Array.mcomp( ... )</p>
<table class="faldoc_function">
<tr><td class="faldoc_param">...</td><td class="faldoc_paramdesc">One or more sequences or item generators. </td></tr>
<tr><td class="faldoc_funcreturn">Returns:</td><td class="faldoc_funcreturndesc">This array. </td></tr>
</table>
<p class="faldoc_text"><p class="faldoc_text"> Please, see the description of <a href="./class_Sequence.html#mcomp">Sequence.mcomp</a>. </p>
</p>
<h3 class="faldoc_funcname"><a name="merge">merge()</a></h3>
<p class="item_brief">Merges the given array into this one. </p>
<p class="faldoc_funcdecl">Array.merge( array, [insertPos], [start], [end] )</p>
<table class="faldoc_function">
<tr><td class="faldoc_param">array</td><td class="faldoc_paramdesc">Array containing the second half of the merge, read-only </td></tr>
<tr><td class="faldoc_optparam">insertPos</td><td class="faldoc_optparamdesc">Optional position of array 1 at which to place array2 </td></tr><tr><td class="faldoc_optparam">start</td><td class="faldoc_optparamdesc">First element of array to merge in this array </td></tr><tr><td class="faldoc_optparam">end</td><td class="faldoc_optparamdesc">Last element - 1 of array2 to merge in this array </td></tr>
</table>
<h3 class="faldoc_funcname"><a name="mfcomp">mfcomp()</a></h3>
<p class="item_brief">Appends multiple elements to this array through a filter. </p>
<p class="faldoc_funcdecl">Array.mfcomp( filter, ... )</p>
<table class="faldoc_function">
<tr><td class="faldoc_param">filter</td><td class="faldoc_paramdesc">A filter function receiving each element before its insertion, or nil. </td></tr><tr><td class="faldoc_param">...</td><td class="faldoc_paramdesc">One or more sequences or item generators. </td></tr>
<tr><td class="faldoc_funcreturn">Returns:</td><td class="faldoc_funcreturndesc">This array. </td></tr>
</table>
<p class="faldoc_text"><p class="faldoc_text"> Please, see the description of <a href="./class_Sequence.html#mfcomp">Sequence.mfcomp</a>. </p>
</p>
<h3 class="faldoc_funcname"><a name="properties">properties()</a></h3>
<p class="item_brief">Returns an array of properties (bindings) in the array. </p>
<p class="faldoc_funcdecl">Array.properties( )</p>
<table class="faldoc_function">
<tr><td class="faldoc_funcreturn">Returns:</td><td class="faldoc_funcreturndesc">An array with 0 or more strings. </td></tr>
</table>
<p class="faldoc_text"><p class="faldoc_text">This methods returns all the properties in the given array, which represents the list of array bindings. If the array has no bindings, this method returns an empty array. </p>
<p class="faldoc_text">The property list includes properties that refer to any kind of data, including functions (that is, methods), but it doesn't include properties in the metaclass of this item (FBOM properties). </p>
<p class="faldoc_text">The returned list is ordered by UNICODE value of the property names. </p>
</p>
<h3 class="faldoc_funcname"><a name="remove">remove()</a></h3>
<p class="item_brief">Removes one or more elements in the array. </p>
<p class="faldoc_funcdecl">Array.remove( itemPos, [lastItemPos] )</p>
<table class="faldoc_function">
<tr><td class="faldoc_param">itemPos</td><td class="faldoc_paramdesc">The position of the item to be removed, or the first of the items to be removed. </td></tr>
<tr><td class="faldoc_optparam">lastItemPos</td><td class="faldoc_optparamdesc">The last item to be removed, in range semantic. </td></tr>
</table>
<p class="faldoc_text"><p class="faldoc_text"> Remove one item or a range of items. The size of the array is shortened accordingly. The semantic of <b>lastItemPos</b> is the same as ranged access to the array. </p>
</p>
<h3 class="faldoc_funcname"><a name="scan">scan()</a></h3>
<p class="item_brief">Searches an array for an item satisfying arbitrary criteria. </p>
<p class="faldoc_funcdecl">Array.scan( func, [start], [end] )</p>
<table class="faldoc_function">
<tr><td class="faldoc_param">func</td><td class="faldoc_paramdesc">Function that verifies the criterion. </td></tr>
<tr><td class="faldoc_optparam">start</td><td class="faldoc_optparamdesc">Optional first element to be searched. </td></tr><tr><td class="faldoc_optparam">end</td><td class="faldoc_optparamdesc">Optional upper end of the range.. </td></tr>
<tr><td class="faldoc_funcreturn">Returns:</td><td class="faldoc_funcreturndesc">The position of the searched item in the array, or -1 if not found. </td></tr>
</table>
<h3 class="faldoc_funcname"><a name="setProperty">setProperty()</a></h3>
<p class="item_brief">Sets a binding (as a property) in the array. </p>
<p class="faldoc_funcdecl">Array.setProperty( propName, value )</p>
<table class="faldoc_function">
<tr><td class="faldoc_param">propName</td><td class="faldoc_paramdesc">A string representing the name of a property or a method inside the array. </td></tr><tr><td class="faldoc_param">value</td><td class="faldoc_paramdesc">The property new value. </td></tr>
<tr><td class="faldoc_raise">Raises:</td><td class="faldoc_raisedesc">
<table class="faldoc_raise">
<tr><td class="faldoc_raiseitem"><a href="./class_AccessError.html">AccessError</a></td><td class="faldoc_raisedesc">If the property can't be found. </td></tr>
</table>
</td></tr>
</table>
<p class="faldoc_text"><p class="faldoc_text">Alters the value of the property in the given array. If the required property is not present, an AccessError is raised. </p>
</p>
<h3 class="faldoc_funcname"><a name="sort">sort()</a></h3>
<p class="item_brief">Sorts an array, possibly using an arbitrary ordering criterion. </p>
<p class="faldoc_funcdecl">Array.sort( [sortingFunc] )</p>
<table class="faldoc_function">
<tr><td class="faldoc_optparam">sortingFunc</td><td class="faldoc_optparamdesc">A function used to compare two items. </td></tr>
</table>
<h3 class="faldoc_funcname"><a name="tabField">tabField()</a></h3>
<p class="item_brief">Returns one of the items in the array, given the field name. </p>
<p class="faldoc_funcdecl">Array.tabField( field )</p>
<table class="faldoc_function">
<tr><td class="faldoc_param">field</td><td class="faldoc_paramdesc">The field name or position to be retreived. </td></tr>
<tr><td class="faldoc_funcreturn">Returns:</td><td class="faldoc_funcreturndesc">An item in the array or the default column value. </td></tr>
<tr><td class="faldoc_raise">Raises:</td><td class="faldoc_raisedesc">
<table class="faldoc_raise">
<tr><td class="faldoc_raiseitem"><a href="./class_AccessError.html">AccessError</a></td><td class="faldoc_raisedesc">if the item is not an array. </td></tr>
</table>
</td></tr>
</table>
<p class="faldoc_text"><p class="faldoc_text">If this item is an array and is part of a table, the field with the given name or ID (number) is searched in the table definition, and if found, it is returned. If the coresponding item in the array is nil, then the table column data (default data) is returned instead, unless the item is also an OOB item. In that case, nil is returned and the default column value is ignored. </p>
</p>
<h3 class="faldoc_funcname"><a name="tabRow">tabRow()</a></h3>
<p class="item_brief">Returns the row ID of this element. </p>
<p class="faldoc_funcdecl">Array.tabRow( )</p>
<table class="faldoc_function">
<tr><td class="faldoc_funcreturn">Returns:</td><td class="faldoc_funcreturndesc">A number indicating the position of this row in the table, or nil if this item is an array, but it's not stored in a table. </td></tr>
<tr><td class="faldoc_raise">Raises:</td><td class="faldoc_raisedesc">
<table class="faldoc_raise">
<tr><td class="faldoc_raiseitem"><a href="./class_AccessError.html">AccessError</a></td><td class="faldoc_raisedesc">if the item is not a table row (array). </td></tr>
</table>
</td></tr>
</table>
<p class="faldoc_text"><p class="faldoc_text">This method returns the position of this element in a table. </p>
<p class="faldoc_text"> This number gets valorized only after a <a href="./class_Table.html#get">Table.get</a> or <a href="./class_Table.html#find">Table.find</a> method call, so that it is possible to know what index had this element in the owning table. If the table is changed by inserting or removing a row, the number returned by this function becomes meaningless. </p>
</p>
<h3 class="faldoc_funcname"><a name="table">table()</a></h3>
<p class="item_brief">Returns the table related with this array. </p>
<p class="faldoc_funcdecl">Array.table( )</p>
<table class="faldoc_function">
<tr><td class="faldoc_funcreturn">Returns:</td><td class="faldoc_funcreturndesc">The table of which this item is a row. </td></tr>
<tr><td class="faldoc_raise">Raises:</td><td class="faldoc_raisedesc">
<table class="faldoc_raise">
<tr><td class="faldoc_raiseitem"><a href="./class_AccessError.html">AccessError</a></td><td class="faldoc_raisedesc">if the item is not an array. </td></tr>
</table>
</td></tr>
</table>
<p class="faldoc_text"><p class="faldoc_text">This array method retreives the table that is related with the item, provided the item is an array being part of a table. </p>
<p class="faldoc_text">In case the item is an array, but it doesn't belong to any table, nil is returned. </p>
</p>
<h3 class="faldoc_funcname"><a name="tail">tail()</a></h3>
<p class="item_brief">Extracts the last element of an array and returns it. </p>
<p class="faldoc_funcdecl">Array.tail( )</p>
<table class="faldoc_function">
<tr><td class="faldoc_funcreturn">Returns:</td><td class="faldoc_funcreturndesc">The extracted item. </td></tr>
</table>
<p class="faldoc_text"><p class="faldoc_text">This function removes the last item of the array and returns it. If the original array is empty, AccessError is raised. </p>
</p>
<hr/>
<div class="navibottom">
<center>
<a href="./index.html">Main</a> - <a href="./pages.html">Related pages</a> - <a href="./groups.html">Groups</a> - <a href="./funset.html">Function sets</a> - <a href="./classes.html">Classes</a> - <a href="./objects.html">Objects</a> - <a href="./functions.html">All functions</a> - <a href="./globals.html">Globals</a>
</center>
</div>
</div>
<div class="faldoc_signature">Made with <a href="http://www.falconpl.org">faldoc 2.2.0</div>
</body>
</html>
