Editing XOR linked list

{{Short description|Datastructure}}
{{More citations needed|date=October 2009}}

An '''XOR linked list''' is a type of [[data structure]] used in [[computer programming]]. It takes advantage of the [[Bitwise operation#XOR|bitwise XOR]] operation to decrease storage requirements for [[doubly linked list]]s by storing the composition of both addresses in one field. While the composed address is not meaningful on its own, during traversal it can be combined with knowledge of the last-visited node address to deduce the address of the following node.

== Description ==
An ordinary doubly linked list stores addresses of the previous and next list items in each list node, requiring two address fields:

  ... A        B        C         D         E ...
          –>  next –>  next  –>  next  –>
          <–  prev <–  prev  <–  prev  <–

An XOR linked list compresses the same information into ''one'' address field by storing the bitwise XOR (here denoted by ⊕) of the address for ''previous'' and the address for ''next'' in one field:

  ... A        B          C          D         E ...
          ⇌   A⊕C   ⇌   B⊕D   ⇌   C⊕E   ⇌

More formally: 
   link(B) = addr(A)⊕addr(C), link(C) = addr(B)⊕addr(D), ...

When traversing the list from left to right: supposing the cursor is at C, the previous item, B, may be XORed with the value in the link field (B⊕D). The address for D will then be obtained and list traversal may resume. The same pattern applies in the other direction.

i.e.  {{code|1=addr(D) = link(C) ⊕ addr(B)}}
where
       link(C) = addr(B)⊕addr(D)
so  
       addr(D) = addr(B)⊕addr(D) ⊕ addr(B)           
   
       addr(D) = addr(B)⊕addr(B) ⊕ addr(D) 
since 
        X⊕X = 0                 
        => addr(D) = 0 ⊕ addr(D)
since
        X⊕0 = X
        => addr(D) = addr(D)
The XOR operation cancels {{code|addr(B)}} appearing twice in the equation and all we are left with is the {{code|addr(D)}}.

To start traversing the list in either direction from some point, the address of two consecutive items is required. If the addresses of the two consecutive items are reversed, list traversal will occur in the opposite direction.<ref>{{Cite news|url=https://www.geeksforgeeks.org/xor-linked-list-a-memory-efficient-doubly-linked-list-set-1/|title=XOR Linked List - A Memory Efficient Doubly Linked List {{!}} Set 1 - GeeksforGeeks|date=2011-05-23|work=GeeksforGeeks|access-date=2018-10-29|language=en-US}}</ref>

===Theory of operation===
The key is the first operation, and the properties of XOR: 
*X⊕X = 0
*X⊕0 = X
*X⊕Y = Y⊕X
*(X⊕Y)⊕Z = X⊕(Y⊕Z)

The R2 register always contains the XOR of the address of current item C with the address of the predecessor item P: C⊕P. The Link fields in the records contain the XOR of the left and right successor addresses, say L⊕R. XOR of R2 (C⊕P) with the current link field (L⊕R) yields C⊕P⊕L⊕R. 
* If the predecessor was L, the P(=L) and L ''cancel out''  leaving C⊕R. 
* If the predecessor had been R, the P(=R) and R  cancel, leaving C⊕L.

In each case, the result is the XOR of the current address with the next address. XOR of this with the current address in R1 leaves the next address. R2 is left with the requisite XOR pair of the (now) current address and the predecessor.

==Features==
* Two XOR operations suffice to do the traversal from one item to the next, the same instructions sufficing in both cases. Consider a list with items <code>{…B C D…}</code> and with R1 and R2 being [[Processor register|registers]] containing, respectively, the address of the current (say C) list item and a work register containing the XOR of the current address with the previous address (say C⊕D).  Cast as [[System/360]] instructions:

 X  R2,Link    R2 <- C⊕D ⊕ B⊕D (i.e. B⊕C, "Link" being the link field
                                   in the current record, containing B⊕D)
 XR R1,R2      R1 <- C ⊕ B⊕C    (i.e. B, voilà: the next record)

* End of list is signified by imagining a list item at address zero placed adjacent to an end point, as in <code>{0 A B C…}</code>. The link field at A would be 0⊕B. An additional instruction is needed in the above sequence after the two XOR operations to detect a zero result in developing the address of the current item,
* A list end point can be made reflective by making the link pointer be zero. A zero pointer is a ''mirror''. (The XOR of the left and right neighbor addresses, being the same, is zero.)

== Drawbacks ==

* General-purpose debugging tools cannot follow the XOR chain, making debugging more difficult;<ref>{{cite web |url=http://www.iecc.com/gclist/GC-faq.html#GC,%20C,%20and%20C++ |title=GC [garbage collection] FAQ – draft |first=David |last=Gadbois |display-authors=etal|access-date=5 December 2018}}</ref>
* The price for the decrease in memory usage is an increase in code complexity, making maintenance more expensive;
* Most [[garbage collection (computer science)|garbage collection]] schemes do not work with data structures that do not contain literal [[pointer (computer programming)|pointer]]s;
* Not all languages support [[type conversion]] between pointers and integers, XOR on pointers is not defined in some contexts;
* While traversing the list, the address of the previously accessed node is needed to calculate the next node's address and the pointers will be unreadable if one isn't traversing the list&mdash;for example, if the pointer to a list item was contained in another data structure;
* XOR linked lists do not provide some of the important advantages of doubly linked lists, such as the ability to delete a node from the list knowing only its address or the ability to insert a new node before or after an existing node when knowing only the address of the existing node.

Computer systems have increasingly cheap and plentiful memory, therefore storage overhead is not generally an overriding issue outside specialized [[embedded system]]s. Where it is still desirable to reduce the overhead of a linked list, [[unrolled linked list|unrolling]] provides a more practical approach (as well as other advantages, such as increasing cache performance and speeding [[random access]]).

==Variations==
The underlying principle of the XOR linked list can be applied to any reversible binary operation. Replacing XOR by addition or subtraction gives slightly different, but largely equivalent, formulations:

===Addition linked list===

  ...  A        B         C         D         E  ...
           ⇌   A+C   ⇌   B+D   ⇌   C+E   ⇌

This kind of list has exactly the same properties as the XOR linked list, except that a zero link field is not a "mirror". The address of the next node in the list is given by subtracting the previous node's address from the current node's link field.

===Subtraction linked list===

  ...  A        B         C         D         E  ...
           ⇌   C-A   ⇌   D-B   ⇌   E-C   ⇌

This kind of list differs from the standard "traditional" XOR linked list in that the instruction sequences needed to traverse the list forwards is different from the sequence needed to traverse the list in reverse. The address of the next node, going forwards, is given by ''adding'' the link field to the previous node's address; the address of the preceding node is given by ''subtracting'' the link field from the next node's address.

The subtraction linked list is also special in that the entire list can be relocated in memory without needing any patching of pointer values, since adding a constant offset to each address in the list will not require any changes to the values stored in the link fields. (See also [[serialization]].) This is an advantage over both XOR linked lists and traditional linked lists.

===Binary search tree===
The XOR linked list concept can be generalized to XOR [[binary search tree]]s.<ref>{{cite web |url=https://github.com/user1095108/xsg |title=c++ associative containers based on the XOR scapegoat tree |website=[[GitHub]] |access-date=5 November 2021}}</ref>

==See also==
*[[XOR swap algorithm]]

==References==
<references/>

==External links==
* {{cite magazine|author=Prokash Sinha |url=http://www.linuxjournal.com/article/6828 |title=A Memory-Efficient Doubly Linked List |magazine=Linux Journal |date=Dec 1, 2004}}
* [https://github.com/25077667/XORList XORList: Efficient C++ Linked List (MIT License)]
* [https://github.com/ManosPapadakis95/Listes Implementation of Xor List in C++ in library Listes.]
{{Data structures}}

[[Category:Binary arithmetic]]
[[Category:Linked lists]]