Gambas Documentation
Application Repository
Code Snippets
Compilation & Installation
Components
gb
gb.args
gb.cairo
gb.chart
gb.clipper
gb.complex
gb.compress
gb.crypt
gb.data
.List.Backwards
.List.Item
Append
Index
IsFirst
IsLast
IsValid
Prepend
Value
AvlTree
Circular
Deque
Heap
List
PrioQueue
Queue
Stack
Trie
TriePrefix
gb.db
gb.db.form
gb.db.mysql
gb.db.odbc
gb.db.postgresql
gb.db.sqlite2
gb.db.sqlite3
gb.dbus
gb.dbus.trayicon
gb.debug
gb.desktop
gb.desktop.gnome.keyring
gb.desktop.x11
gb.eval
gb.eval.highlight
gb.form
gb.form.dialog
gb.form.editor
gb.form.htmlview
gb.form.mdi
gb.form.print
gb.form.stock
gb.form.terminal
gb.gmp
gb.gsl
gb.gtk
gb.gtk.opengl
gb.gtk3
gb.gtk3.opengl
gb.gtk3.webview
gb.gui
gb.gui.opengl
gb.gui.qt
gb.gui.qt.ext
gb.gui.qt.opengl
gb.gui.qt.webkit
gb.gui.trayicon
gb.gui.webview
gb.hash
gb.highlight
gb.image
gb.image.effect
gb.image.imlib
gb.image.io
gb.inotify
gb.jit
gb.libxml
gb.logging
gb.map
gb.markdown
gb.media
gb.media.form
gb.memcached
gb.mime
gb.mongodb
gb.mysql
gb.ncurses
gb.net
gb.net.curl
gb.net.pop3
gb.net.smtp
gb.openal
gb.opengl
gb.opengl.glsl
gb.opengl.glu
gb.opengl.sge
gb.openssl
gb.option
gb.pcre
gb.pdf
gb.poppler
gb.qt4
gb.qt4.ext
gb.qt4.opengl
gb.qt4.webkit
gb.qt4.webview
gb.qt5
gb.qt5.ext
gb.qt5.opengl
gb.qt5.webkit
gb.qt5.webview
gb.qt6
gb.qt6.ext
gb.qt6.opengl
gb.qt6.webview
gb.report
gb.report2
gb.scanner
gb.sdl
gb.sdl.sound
gb.sdl2
gb.sdl2.audio
gb.settings
gb.signal
gb.term
gb.test
gb.util
gb.util.web
gb.v4l
gb.vb
gb.web
gb.web.feed
gb.web.form
gb.web.gui
gb.xml
gb.xml.html
gb.xml.rpc
gb.xml.xslt
Controls pictures
Deprecated components
Developer Documentation
Development Environment Documentation
Documents
Error Messages
Gambas Playground
How To's
Language Index
Language Overviews
Last Changes
Lexicon
README
Search the wiki
To Do
Topics
Tutorials
Wiki License
Wiki Manual

.List.Item.Index (gb.data)

Return the index of this item.

Since a List is linked forwards and backwards, negative indices make sense. The non-negative indices behave as you would expect: 0 refers to the first element after the list head, 1 to the second, etc.. Negative indices relate to the end of the list -- but in one's complement, i.e. -1 is the first element before the list head, -2 the second-last element, etc.. This is so that List.Count + NegativeIndex = CorrespondingPositiveIndex.

To complicate things even more, since the List is circularly linked, there is no out-of-bounds condition. Indices just cycle around the end of the list to its beginning.

Rest assured that the implementation will always take the shortest way possible, though! There was quite some effort spent to relativise the cache-destructive nature of linked lists without any additional memory use. Internally, Current and all active enumerations are .List.Items which carry an Index. Traversals will regard them as "anchors" and try to get to a given index from them (in forward or backward direction) with the least elements in between as possible. This strategy will never traverse more than List.Count / 2 elements to get to any index.

This means that there are potentially infinitely many ways to address each element. This calls for a normal form for indices. A normalised index is a non-negative one, in the range of 0 and List.Count - 1 inclusively.

See also

List.AutoNormalize