blob: 60cb1ecc83fe5d87bf071d26a8cb94a8559396a7 [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html lang="en">
<head>
<title>Source code</title>
<link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style">
</head>
<body>
<div class="sourceContainer">
<pre><span class="sourceLineNo">001</span>/**<a name="line.1"></a>
<span class="sourceLineNo">002</span> *<a name="line.2"></a>
<span class="sourceLineNo">003</span> * Licensed to the Apache Software Foundation (ASF) under one<a name="line.3"></a>
<span class="sourceLineNo">004</span> * or more contributor license agreements. See the NOTICE file<a name="line.4"></a>
<span class="sourceLineNo">005</span> * distributed with this work for additional information<a name="line.5"></a>
<span class="sourceLineNo">006</span> * regarding copyright ownership. The ASF licenses this file<a name="line.6"></a>
<span class="sourceLineNo">007</span> * to you under the Apache License, Version 2.0 (the<a name="line.7"></a>
<span class="sourceLineNo">008</span> * "License"); you may not use this file except in compliance<a name="line.8"></a>
<span class="sourceLineNo">009</span> * with the License. You may obtain a copy of the License at<a name="line.9"></a>
<span class="sourceLineNo">010</span> *<a name="line.10"></a>
<span class="sourceLineNo">011</span> * http://www.apache.org/licenses/LICENSE-2.0<a name="line.11"></a>
<span class="sourceLineNo">012</span> *<a name="line.12"></a>
<span class="sourceLineNo">013</span> * Unless required by applicable law or agreed to in writing, software<a name="line.13"></a>
<span class="sourceLineNo">014</span> * distributed under the License is distributed on an "AS IS" BASIS,<a name="line.14"></a>
<span class="sourceLineNo">015</span> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.<a name="line.15"></a>
<span class="sourceLineNo">016</span> * See the License for the specific language governing permissions and<a name="line.16"></a>
<span class="sourceLineNo">017</span> * limitations under the License.<a name="line.17"></a>
<span class="sourceLineNo">018</span> */<a name="line.18"></a>
<span class="sourceLineNo">019</span><a name="line.19"></a>
<span class="sourceLineNo">020</span>package org.apache.hadoop.hbase.util;<a name="line.20"></a>
<span class="sourceLineNo">021</span><a name="line.21"></a>
<span class="sourceLineNo">022</span>import java.util.Iterator;<a name="line.22"></a>
<span class="sourceLineNo">023</span>import java.util.concurrent.atomic.AtomicBoolean;<a name="line.23"></a>
<span class="sourceLineNo">024</span><a name="line.24"></a>
<span class="sourceLineNo">025</span>import org.apache.yetus.audience.InterfaceAudience;<a name="line.25"></a>
<span class="sourceLineNo">026</span>import org.apache.yetus.audience.InterfaceStability;<a name="line.26"></a>
<span class="sourceLineNo">027</span><a name="line.27"></a>
<span class="sourceLineNo">028</span>/**<a name="line.28"></a>
<span class="sourceLineNo">029</span> * Helper class that allows to create and manipulate an AvlTree.<a name="line.29"></a>
<span class="sourceLineNo">030</span> * The main utility is in cases where over time we have a lot of add/remove of the same object,<a name="line.30"></a>
<span class="sourceLineNo">031</span> * and we want to avoid all the allocations/deallocations of the "node" objects that the<a name="line.31"></a>
<span class="sourceLineNo">032</span> * java containers will create.<a name="line.32"></a>
<span class="sourceLineNo">033</span> */<a name="line.33"></a>
<span class="sourceLineNo">034</span>@InterfaceAudience.Private<a name="line.34"></a>
<span class="sourceLineNo">035</span>@InterfaceStability.Evolving<a name="line.35"></a>
<span class="sourceLineNo">036</span>public final class AvlUtil {<a name="line.36"></a>
<span class="sourceLineNo">037</span> private AvlUtil() {}<a name="line.37"></a>
<span class="sourceLineNo">038</span><a name="line.38"></a>
<span class="sourceLineNo">039</span> /**<a name="line.39"></a>
<span class="sourceLineNo">040</span> * This class represent a node that will be used in an AvlTree.<a name="line.40"></a>
<span class="sourceLineNo">041</span> * Instead of creating another object for the tree node,<a name="line.41"></a>
<span class="sourceLineNo">042</span> * like the TreeMap and the other java contains, here the node can be extended<a name="line.42"></a>
<span class="sourceLineNo">043</span> * and the content can be embedded directly in the node itself.<a name="line.43"></a>
<span class="sourceLineNo">044</span> * This is useful in cases where over time we have a lot of add/remove of the same object.<a name="line.44"></a>
<span class="sourceLineNo">045</span> */<a name="line.45"></a>
<span class="sourceLineNo">046</span> @InterfaceAudience.Private<a name="line.46"></a>
<span class="sourceLineNo">047</span> public static abstract class AvlNode&lt;TNode extends AvlNode&gt; {<a name="line.47"></a>
<span class="sourceLineNo">048</span> protected TNode avlLeft;<a name="line.48"></a>
<span class="sourceLineNo">049</span> protected TNode avlRight;<a name="line.49"></a>
<span class="sourceLineNo">050</span> protected int avlHeight;<a name="line.50"></a>
<span class="sourceLineNo">051</span><a name="line.51"></a>
<span class="sourceLineNo">052</span> public abstract int compareTo(TNode other);<a name="line.52"></a>
<span class="sourceLineNo">053</span> }<a name="line.53"></a>
<span class="sourceLineNo">054</span><a name="line.54"></a>
<span class="sourceLineNo">055</span> /**<a name="line.55"></a>
<span class="sourceLineNo">056</span> * This class extends the AvlNode and adds two links that will be used in conjunction<a name="line.56"></a>
<span class="sourceLineNo">057</span> * with the AvlIterableList class.<a name="line.57"></a>
<span class="sourceLineNo">058</span> * This is useful in situations where your node must be in a map to have a quick lookup by key,<a name="line.58"></a>
<span class="sourceLineNo">059</span> * but it also require to be in something like a list/queue.<a name="line.59"></a>
<span class="sourceLineNo">060</span> * This is useful in cases where over time we have a lot of add/remove of the same object.<a name="line.60"></a>
<span class="sourceLineNo">061</span> */<a name="line.61"></a>
<span class="sourceLineNo">062</span> @InterfaceAudience.Private<a name="line.62"></a>
<span class="sourceLineNo">063</span> public static abstract class AvlLinkedNode&lt;TNode extends AvlLinkedNode&gt; extends AvlNode&lt;TNode&gt; {<a name="line.63"></a>
<span class="sourceLineNo">064</span> protected TNode iterNext = null;<a name="line.64"></a>
<span class="sourceLineNo">065</span> protected TNode iterPrev = null;<a name="line.65"></a>
<span class="sourceLineNo">066</span> }<a name="line.66"></a>
<span class="sourceLineNo">067</span><a name="line.67"></a>
<span class="sourceLineNo">068</span> @InterfaceAudience.Private<a name="line.68"></a>
<span class="sourceLineNo">069</span> public interface AvlInsertOrReplace&lt;TNode extends AvlNode&gt; {<a name="line.69"></a>
<span class="sourceLineNo">070</span> TNode insert(Object searchKey);<a name="line.70"></a>
<span class="sourceLineNo">071</span> TNode replace(Object searchKey, TNode prevNode);<a name="line.71"></a>
<span class="sourceLineNo">072</span> }<a name="line.72"></a>
<span class="sourceLineNo">073</span><a name="line.73"></a>
<span class="sourceLineNo">074</span> /**<a name="line.74"></a>
<span class="sourceLineNo">075</span> * The AvlTree allows to lookup an object using a custom key.<a name="line.75"></a>
<span class="sourceLineNo">076</span> * e.g. the java Map allows only to lookup by key using the Comparator<a name="line.76"></a>
<span class="sourceLineNo">077</span> * specified in the constructor.<a name="line.77"></a>
<span class="sourceLineNo">078</span> * In this case you can pass a specific comparator for every needs.<a name="line.78"></a>
<span class="sourceLineNo">079</span> */<a name="line.79"></a>
<span class="sourceLineNo">080</span> @InterfaceAudience.Private<a name="line.80"></a>
<span class="sourceLineNo">081</span> public static interface AvlKeyComparator&lt;TNode extends AvlNode&gt; {<a name="line.81"></a>
<span class="sourceLineNo">082</span> int compareKey(TNode node, Object key);<a name="line.82"></a>
<span class="sourceLineNo">083</span> }<a name="line.83"></a>
<span class="sourceLineNo">084</span><a name="line.84"></a>
<span class="sourceLineNo">085</span> /**<a name="line.85"></a>
<span class="sourceLineNo">086</span> * Visitor that allows to traverse a set of AvlNodes.<a name="line.86"></a>
<span class="sourceLineNo">087</span> * If you don't like the callback style of the visitor you can always use the AvlTreeIterator.<a name="line.87"></a>
<span class="sourceLineNo">088</span> */<a name="line.88"></a>
<span class="sourceLineNo">089</span> @InterfaceAudience.Private<a name="line.89"></a>
<span class="sourceLineNo">090</span> public static interface AvlNodeVisitor&lt;TNode extends AvlNode&gt; {<a name="line.90"></a>
<span class="sourceLineNo">091</span> /**<a name="line.91"></a>
<span class="sourceLineNo">092</span> * @param node the node that we are currently visiting<a name="line.92"></a>
<span class="sourceLineNo">093</span> * @return false to stop the iteration. true to continue.<a name="line.93"></a>
<span class="sourceLineNo">094</span> */<a name="line.94"></a>
<span class="sourceLineNo">095</span> boolean visitNode(TNode node);<a name="line.95"></a>
<span class="sourceLineNo">096</span> }<a name="line.96"></a>
<span class="sourceLineNo">097</span><a name="line.97"></a>
<span class="sourceLineNo">098</span> /**<a name="line.98"></a>
<span class="sourceLineNo">099</span> * Helper class that allows to create and manipulate an AVL Tree<a name="line.99"></a>
<span class="sourceLineNo">100</span> */<a name="line.100"></a>
<span class="sourceLineNo">101</span> @InterfaceAudience.Private<a name="line.101"></a>
<span class="sourceLineNo">102</span> public static class AvlTree {<a name="line.102"></a>
<span class="sourceLineNo">103</span> /**<a name="line.103"></a>
<span class="sourceLineNo">104</span> * @param root the current root of the tree<a name="line.104"></a>
<span class="sourceLineNo">105</span> * @param key the key for the node we are trying to find<a name="line.105"></a>
<span class="sourceLineNo">106</span> * @param keyComparator the comparator to use to match node and key<a name="line.106"></a>
<span class="sourceLineNo">107</span> * @return the node that matches the specified key or null in case of node not found.<a name="line.107"></a>
<span class="sourceLineNo">108</span> */<a name="line.108"></a>
<span class="sourceLineNo">109</span> public static &lt;TNode extends AvlNode&gt; TNode get(TNode root, final Object key,<a name="line.109"></a>
<span class="sourceLineNo">110</span> final AvlKeyComparator&lt;TNode&gt; keyComparator) {<a name="line.110"></a>
<span class="sourceLineNo">111</span> while (root != null) {<a name="line.111"></a>
<span class="sourceLineNo">112</span> int cmp = keyComparator.compareKey(root, key);<a name="line.112"></a>
<span class="sourceLineNo">113</span> if (cmp &gt; 0) {<a name="line.113"></a>
<span class="sourceLineNo">114</span> root = (TNode)root.avlLeft;<a name="line.114"></a>
<span class="sourceLineNo">115</span> } else if (cmp &lt; 0) {<a name="line.115"></a>
<span class="sourceLineNo">116</span> root = (TNode)root.avlRight;<a name="line.116"></a>
<span class="sourceLineNo">117</span> } else {<a name="line.117"></a>
<span class="sourceLineNo">118</span> return (TNode)root;<a name="line.118"></a>
<span class="sourceLineNo">119</span> }<a name="line.119"></a>
<span class="sourceLineNo">120</span> }<a name="line.120"></a>
<span class="sourceLineNo">121</span> return null;<a name="line.121"></a>
<span class="sourceLineNo">122</span> }<a name="line.122"></a>
<span class="sourceLineNo">123</span><a name="line.123"></a>
<span class="sourceLineNo">124</span> /**<a name="line.124"></a>
<span class="sourceLineNo">125</span> * @param root the current root of the tree<a name="line.125"></a>
<span class="sourceLineNo">126</span> * @return the first (min) node of the tree<a name="line.126"></a>
<span class="sourceLineNo">127</span> */<a name="line.127"></a>
<span class="sourceLineNo">128</span> public static &lt;TNode extends AvlNode&gt; TNode getFirst(TNode root) {<a name="line.128"></a>
<span class="sourceLineNo">129</span> if (root != null) {<a name="line.129"></a>
<span class="sourceLineNo">130</span> while (root.avlLeft != null) {<a name="line.130"></a>
<span class="sourceLineNo">131</span> root = (TNode)root.avlLeft;<a name="line.131"></a>
<span class="sourceLineNo">132</span> }<a name="line.132"></a>
<span class="sourceLineNo">133</span> }<a name="line.133"></a>
<span class="sourceLineNo">134</span> return root;<a name="line.134"></a>
<span class="sourceLineNo">135</span> }<a name="line.135"></a>
<span class="sourceLineNo">136</span><a name="line.136"></a>
<span class="sourceLineNo">137</span> /**<a name="line.137"></a>
<span class="sourceLineNo">138</span> * @param root the current root of the tree<a name="line.138"></a>
<span class="sourceLineNo">139</span> * @return the last (max) node of the tree<a name="line.139"></a>
<span class="sourceLineNo">140</span> */<a name="line.140"></a>
<span class="sourceLineNo">141</span> public static &lt;TNode extends AvlNode&gt; TNode getLast(TNode root) {<a name="line.141"></a>
<span class="sourceLineNo">142</span> if (root != null) {<a name="line.142"></a>
<span class="sourceLineNo">143</span> while (root.avlRight != null) {<a name="line.143"></a>
<span class="sourceLineNo">144</span> root = (TNode)root.avlRight;<a name="line.144"></a>
<span class="sourceLineNo">145</span> }<a name="line.145"></a>
<span class="sourceLineNo">146</span> }<a name="line.146"></a>
<span class="sourceLineNo">147</span> return root;<a name="line.147"></a>
<span class="sourceLineNo">148</span> }<a name="line.148"></a>
<span class="sourceLineNo">149</span><a name="line.149"></a>
<span class="sourceLineNo">150</span> /**<a name="line.150"></a>
<span class="sourceLineNo">151</span> * Insert a node into the tree. It uses the AvlNode.compareTo() for ordering.<a name="line.151"></a>
<span class="sourceLineNo">152</span> * NOTE: The node must not be already in the tree.<a name="line.152"></a>
<span class="sourceLineNo">153</span> * @param root the current root of the tree<a name="line.153"></a>
<span class="sourceLineNo">154</span> * @param node the node to insert<a name="line.154"></a>
<span class="sourceLineNo">155</span> * @return the new root of the tree<a name="line.155"></a>
<span class="sourceLineNo">156</span> */<a name="line.156"></a>
<span class="sourceLineNo">157</span> public static &lt;TNode extends AvlNode&gt; TNode insert(TNode root, TNode node) {<a name="line.157"></a>
<span class="sourceLineNo">158</span> if (root == null) return node;<a name="line.158"></a>
<span class="sourceLineNo">159</span><a name="line.159"></a>
<span class="sourceLineNo">160</span> int cmp = node.compareTo(root);<a name="line.160"></a>
<span class="sourceLineNo">161</span> assert cmp != 0 : "node already inserted: " + root;<a name="line.161"></a>
<span class="sourceLineNo">162</span> if (cmp &lt; 0) {<a name="line.162"></a>
<span class="sourceLineNo">163</span> root.avlLeft = insert(root.avlLeft, node);<a name="line.163"></a>
<span class="sourceLineNo">164</span> } else {<a name="line.164"></a>
<span class="sourceLineNo">165</span> root.avlRight = insert(root.avlRight, node);<a name="line.165"></a>
<span class="sourceLineNo">166</span> }<a name="line.166"></a>
<span class="sourceLineNo">167</span> return balance(root);<a name="line.167"></a>
<span class="sourceLineNo">168</span> }<a name="line.168"></a>
<span class="sourceLineNo">169</span><a name="line.169"></a>
<span class="sourceLineNo">170</span> /**<a name="line.170"></a>
<span class="sourceLineNo">171</span> * Insert a node into the tree.<a name="line.171"></a>
<span class="sourceLineNo">172</span> * This is useful when you want to create a new node or replace the content<a name="line.172"></a>
<span class="sourceLineNo">173</span> * depending if the node already exists or not.<a name="line.173"></a>
<span class="sourceLineNo">174</span> * Using AvlInsertOrReplace class you can return the node to add/replace.<a name="line.174"></a>
<span class="sourceLineNo">175</span> *<a name="line.175"></a>
<span class="sourceLineNo">176</span> * @param root the current root of the tree<a name="line.176"></a>
<span class="sourceLineNo">177</span> * @param key the key for the node we are trying to insert<a name="line.177"></a>
<span class="sourceLineNo">178</span> * @param keyComparator the comparator to use to match node and key<a name="line.178"></a>
<span class="sourceLineNo">179</span> * @param insertOrReplace the class to use to insert or replace the node<a name="line.179"></a>
<span class="sourceLineNo">180</span> * @return the new root of the tree<a name="line.180"></a>
<span class="sourceLineNo">181</span> */<a name="line.181"></a>
<span class="sourceLineNo">182</span> public static &lt;TNode extends AvlNode&gt; TNode insert(TNode root, Object key,<a name="line.182"></a>
<span class="sourceLineNo">183</span> final AvlKeyComparator&lt;TNode&gt; keyComparator,<a name="line.183"></a>
<span class="sourceLineNo">184</span> final AvlInsertOrReplace&lt;TNode&gt; insertOrReplace) {<a name="line.184"></a>
<span class="sourceLineNo">185</span> if (root == null) {<a name="line.185"></a>
<span class="sourceLineNo">186</span> return insertOrReplace.insert(key);<a name="line.186"></a>
<span class="sourceLineNo">187</span> }<a name="line.187"></a>
<span class="sourceLineNo">188</span><a name="line.188"></a>
<span class="sourceLineNo">189</span> int cmp = keyComparator.compareKey(root, key);<a name="line.189"></a>
<span class="sourceLineNo">190</span> if (cmp &lt; 0) {<a name="line.190"></a>
<span class="sourceLineNo">191</span> root.avlLeft = insert((TNode)root.avlLeft, key, keyComparator, insertOrReplace);<a name="line.191"></a>
<span class="sourceLineNo">192</span> } else if (cmp &gt; 0) {<a name="line.192"></a>
<span class="sourceLineNo">193</span> root.avlRight = insert((TNode)root.avlRight, key, keyComparator, insertOrReplace);<a name="line.193"></a>
<span class="sourceLineNo">194</span> } else {<a name="line.194"></a>
<span class="sourceLineNo">195</span> TNode left = (TNode)root.avlLeft;<a name="line.195"></a>
<span class="sourceLineNo">196</span> TNode right = (TNode)root.avlRight;<a name="line.196"></a>
<span class="sourceLineNo">197</span> root = insertOrReplace.replace(key, root);<a name="line.197"></a>
<span class="sourceLineNo">198</span> root.avlLeft = left;<a name="line.198"></a>
<span class="sourceLineNo">199</span> root.avlRight = right;<a name="line.199"></a>
<span class="sourceLineNo">200</span> return root;<a name="line.200"></a>
<span class="sourceLineNo">201</span> }<a name="line.201"></a>
<span class="sourceLineNo">202</span> return balance(root);<a name="line.202"></a>
<span class="sourceLineNo">203</span> }<a name="line.203"></a>
<span class="sourceLineNo">204</span><a name="line.204"></a>
<span class="sourceLineNo">205</span> private static &lt;TNode extends AvlNode&gt; TNode removeMin(TNode p) {<a name="line.205"></a>
<span class="sourceLineNo">206</span> if (p.avlLeft == null)<a name="line.206"></a>
<span class="sourceLineNo">207</span> return (TNode)p.avlRight;<a name="line.207"></a>
<span class="sourceLineNo">208</span> p.avlLeft = removeMin(p.avlLeft);<a name="line.208"></a>
<span class="sourceLineNo">209</span> return balance(p);<a name="line.209"></a>
<span class="sourceLineNo">210</span> }<a name="line.210"></a>
<span class="sourceLineNo">211</span><a name="line.211"></a>
<span class="sourceLineNo">212</span> /**<a name="line.212"></a>
<span class="sourceLineNo">213</span> * Removes the node matching the specified key from the tree<a name="line.213"></a>
<span class="sourceLineNo">214</span> * @param root the current root of the tree<a name="line.214"></a>
<span class="sourceLineNo">215</span> * @param key the key for the node we are trying to find<a name="line.215"></a>
<span class="sourceLineNo">216</span> * @param keyComparator the comparator to use to match node and key<a name="line.216"></a>
<span class="sourceLineNo">217</span> * @return the new root of the tree<a name="line.217"></a>
<span class="sourceLineNo">218</span> */<a name="line.218"></a>
<span class="sourceLineNo">219</span> public static &lt;TNode extends AvlNode&gt; TNode remove(TNode root, Object key,<a name="line.219"></a>
<span class="sourceLineNo">220</span> final AvlKeyComparator&lt;TNode&gt; keyComparator) {<a name="line.220"></a>
<span class="sourceLineNo">221</span> return remove(root, key, keyComparator, null);<a name="line.221"></a>
<span class="sourceLineNo">222</span> }<a name="line.222"></a>
<span class="sourceLineNo">223</span><a name="line.223"></a>
<span class="sourceLineNo">224</span> /**<a name="line.224"></a>
<span class="sourceLineNo">225</span> * Removes the node matching the specified key from the tree<a name="line.225"></a>
<span class="sourceLineNo">226</span> * @param root the current root of the tree<a name="line.226"></a>
<span class="sourceLineNo">227</span> * @param key the key for the node we are trying to find<a name="line.227"></a>
<span class="sourceLineNo">228</span> * @param keyComparator the comparator to use to match node and key<a name="line.228"></a>
<span class="sourceLineNo">229</span> * @param removed will be set to true if the node was found and removed, otherwise false<a name="line.229"></a>
<span class="sourceLineNo">230</span> * @return the new root of the tree<a name="line.230"></a>
<span class="sourceLineNo">231</span> */<a name="line.231"></a>
<span class="sourceLineNo">232</span> public static &lt;TNode extends AvlNode&gt; TNode remove(TNode root, Object key,<a name="line.232"></a>
<span class="sourceLineNo">233</span> final AvlKeyComparator&lt;TNode&gt; keyComparator, final AtomicBoolean removed) {<a name="line.233"></a>
<span class="sourceLineNo">234</span> if (root == null) return null;<a name="line.234"></a>
<span class="sourceLineNo">235</span><a name="line.235"></a>
<span class="sourceLineNo">236</span> int cmp = keyComparator.compareKey(root, key);<a name="line.236"></a>
<span class="sourceLineNo">237</span> if (cmp == 0) {<a name="line.237"></a>
<span class="sourceLineNo">238</span> if (removed != null) removed.set(true);<a name="line.238"></a>
<span class="sourceLineNo">239</span><a name="line.239"></a>
<span class="sourceLineNo">240</span> TNode q = (TNode)root.avlLeft;<a name="line.240"></a>
<span class="sourceLineNo">241</span> TNode r = (TNode)root.avlRight;<a name="line.241"></a>
<span class="sourceLineNo">242</span> if (r == null) return q;<a name="line.242"></a>
<span class="sourceLineNo">243</span> TNode min = getFirst(r);<a name="line.243"></a>
<span class="sourceLineNo">244</span> min.avlRight = removeMin(r);<a name="line.244"></a>
<span class="sourceLineNo">245</span> min.avlLeft = q;<a name="line.245"></a>
<span class="sourceLineNo">246</span> return balance(min);<a name="line.246"></a>
<span class="sourceLineNo">247</span> } else if (cmp &gt; 0) {<a name="line.247"></a>
<span class="sourceLineNo">248</span> root.avlLeft = remove((TNode)root.avlLeft, key, keyComparator);<a name="line.248"></a>
<span class="sourceLineNo">249</span> } else /* if (cmp &lt; 0) */ {<a name="line.249"></a>
<span class="sourceLineNo">250</span> root.avlRight = remove((TNode)root.avlRight, key, keyComparator);<a name="line.250"></a>
<span class="sourceLineNo">251</span> }<a name="line.251"></a>
<span class="sourceLineNo">252</span> return balance(root);<a name="line.252"></a>
<span class="sourceLineNo">253</span> }<a name="line.253"></a>
<span class="sourceLineNo">254</span><a name="line.254"></a>
<span class="sourceLineNo">255</span> /**<a name="line.255"></a>
<span class="sourceLineNo">256</span> * Visit each node of the tree<a name="line.256"></a>
<span class="sourceLineNo">257</span> * @param root the current root of the tree<a name="line.257"></a>
<span class="sourceLineNo">258</span> * @param visitor the AvlNodeVisitor instance<a name="line.258"></a>
<span class="sourceLineNo">259</span> */<a name="line.259"></a>
<span class="sourceLineNo">260</span> public static &lt;TNode extends AvlNode&gt; void visit(final TNode root,<a name="line.260"></a>
<span class="sourceLineNo">261</span> final AvlNodeVisitor&lt;TNode&gt; visitor) {<a name="line.261"></a>
<span class="sourceLineNo">262</span> if (root == null) return;<a name="line.262"></a>
<span class="sourceLineNo">263</span><a name="line.263"></a>
<span class="sourceLineNo">264</span> final AvlTreeIterator&lt;TNode&gt; iterator = new AvlTreeIterator&lt;&gt;(root);<a name="line.264"></a>
<span class="sourceLineNo">265</span> boolean visitNext = true;<a name="line.265"></a>
<span class="sourceLineNo">266</span> while (visitNext &amp;&amp; iterator.hasNext()) {<a name="line.266"></a>
<span class="sourceLineNo">267</span> visitNext = visitor.visitNode(iterator.next());<a name="line.267"></a>
<span class="sourceLineNo">268</span> }<a name="line.268"></a>
<span class="sourceLineNo">269</span> }<a name="line.269"></a>
<span class="sourceLineNo">270</span><a name="line.270"></a>
<span class="sourceLineNo">271</span> private static &lt;TNode extends AvlNode&gt; TNode balance(TNode p) {<a name="line.271"></a>
<span class="sourceLineNo">272</span> fixHeight(p);<a name="line.272"></a>
<span class="sourceLineNo">273</span> int balance = balanceFactor(p);<a name="line.273"></a>
<span class="sourceLineNo">274</span> if (balance == 2) {<a name="line.274"></a>
<span class="sourceLineNo">275</span> if (balanceFactor(p.avlRight) &lt; 0) {<a name="line.275"></a>
<span class="sourceLineNo">276</span> p.avlRight = rotateRight(p.avlRight);<a name="line.276"></a>
<span class="sourceLineNo">277</span> }<a name="line.277"></a>
<span class="sourceLineNo">278</span> return rotateLeft(p);<a name="line.278"></a>
<span class="sourceLineNo">279</span> } else if (balance == -2) {<a name="line.279"></a>
<span class="sourceLineNo">280</span> if (balanceFactor(p.avlLeft) &gt; 0) {<a name="line.280"></a>
<span class="sourceLineNo">281</span> p.avlLeft = rotateLeft(p.avlLeft);<a name="line.281"></a>
<span class="sourceLineNo">282</span> }<a name="line.282"></a>
<span class="sourceLineNo">283</span> return rotateRight(p);<a name="line.283"></a>
<span class="sourceLineNo">284</span> }<a name="line.284"></a>
<span class="sourceLineNo">285</span> return p;<a name="line.285"></a>
<span class="sourceLineNo">286</span> }<a name="line.286"></a>
<span class="sourceLineNo">287</span><a name="line.287"></a>
<span class="sourceLineNo">288</span> private static &lt;TNode extends AvlNode&gt; TNode rotateRight(TNode p) {<a name="line.288"></a>
<span class="sourceLineNo">289</span> TNode q = (TNode)p.avlLeft;<a name="line.289"></a>
<span class="sourceLineNo">290</span> p.avlLeft = q.avlRight;<a name="line.290"></a>
<span class="sourceLineNo">291</span> q.avlRight = p;<a name="line.291"></a>
<span class="sourceLineNo">292</span> fixHeight(p);<a name="line.292"></a>
<span class="sourceLineNo">293</span> fixHeight(q);<a name="line.293"></a>
<span class="sourceLineNo">294</span> return q;<a name="line.294"></a>
<span class="sourceLineNo">295</span> }<a name="line.295"></a>
<span class="sourceLineNo">296</span><a name="line.296"></a>
<span class="sourceLineNo">297</span> private static &lt;TNode extends AvlNode&gt; TNode rotateLeft(TNode q) {<a name="line.297"></a>
<span class="sourceLineNo">298</span> TNode p = (TNode)q.avlRight;<a name="line.298"></a>
<span class="sourceLineNo">299</span> q.avlRight = p.avlLeft;<a name="line.299"></a>
<span class="sourceLineNo">300</span> p.avlLeft = q;<a name="line.300"></a>
<span class="sourceLineNo">301</span> fixHeight(q);<a name="line.301"></a>
<span class="sourceLineNo">302</span> fixHeight(p);<a name="line.302"></a>
<span class="sourceLineNo">303</span> return p;<a name="line.303"></a>
<span class="sourceLineNo">304</span> }<a name="line.304"></a>
<span class="sourceLineNo">305</span><a name="line.305"></a>
<span class="sourceLineNo">306</span> private static &lt;TNode extends AvlNode&gt; void fixHeight(TNode node) {<a name="line.306"></a>
<span class="sourceLineNo">307</span> final int heightLeft = height(node.avlLeft);<a name="line.307"></a>
<span class="sourceLineNo">308</span> final int heightRight = height(node.avlRight);<a name="line.308"></a>
<span class="sourceLineNo">309</span> node.avlHeight = 1 + Math.max(heightLeft, heightRight);<a name="line.309"></a>
<span class="sourceLineNo">310</span> }<a name="line.310"></a>
<span class="sourceLineNo">311</span><a name="line.311"></a>
<span class="sourceLineNo">312</span> private static &lt;TNode extends AvlNode&gt; int height(TNode node) {<a name="line.312"></a>
<span class="sourceLineNo">313</span> return node != null ? node.avlHeight : 0;<a name="line.313"></a>
<span class="sourceLineNo">314</span> }<a name="line.314"></a>
<span class="sourceLineNo">315</span><a name="line.315"></a>
<span class="sourceLineNo">316</span> private static &lt;TNode extends AvlNode&gt; int balanceFactor(TNode node) {<a name="line.316"></a>
<span class="sourceLineNo">317</span> return height(node.avlRight) - height(node.avlLeft);<a name="line.317"></a>
<span class="sourceLineNo">318</span> }<a name="line.318"></a>
<span class="sourceLineNo">319</span> }<a name="line.319"></a>
<span class="sourceLineNo">320</span><a name="line.320"></a>
<span class="sourceLineNo">321</span> /**<a name="line.321"></a>
<span class="sourceLineNo">322</span> * Iterator for the AvlTree<a name="line.322"></a>
<span class="sourceLineNo">323</span> */<a name="line.323"></a>
<span class="sourceLineNo">324</span> @InterfaceAudience.Private<a name="line.324"></a>
<span class="sourceLineNo">325</span> public static class AvlTreeIterator&lt;TNode extends AvlNode&gt; implements Iterator&lt;TNode&gt; {<a name="line.325"></a>
<span class="sourceLineNo">326</span> private final Object[] stack = new Object[64];<a name="line.326"></a>
<span class="sourceLineNo">327</span><a name="line.327"></a>
<span class="sourceLineNo">328</span> private TNode current = null;<a name="line.328"></a>
<span class="sourceLineNo">329</span> private int height = 0;<a name="line.329"></a>
<span class="sourceLineNo">330</span><a name="line.330"></a>
<span class="sourceLineNo">331</span> public AvlTreeIterator() {<a name="line.331"></a>
<span class="sourceLineNo">332</span> }<a name="line.332"></a>
<span class="sourceLineNo">333</span><a name="line.333"></a>
<span class="sourceLineNo">334</span> /**<a name="line.334"></a>
<span class="sourceLineNo">335</span> * Create the iterator starting from the first (min) node of the tree<a name="line.335"></a>
<span class="sourceLineNo">336</span> */<a name="line.336"></a>
<span class="sourceLineNo">337</span> public AvlTreeIterator(final TNode root) {<a name="line.337"></a>
<span class="sourceLineNo">338</span> seekFirst(root);<a name="line.338"></a>
<span class="sourceLineNo">339</span> }<a name="line.339"></a>
<span class="sourceLineNo">340</span><a name="line.340"></a>
<span class="sourceLineNo">341</span> /**<a name="line.341"></a>
<span class="sourceLineNo">342</span> * Create the iterator starting from the specified key<a name="line.342"></a>
<span class="sourceLineNo">343</span> * @param root the current root of the tree<a name="line.343"></a>
<span class="sourceLineNo">344</span> * @param key the key for the node we are trying to find<a name="line.344"></a>
<span class="sourceLineNo">345</span> * @param keyComparator the comparator to use to match node and key<a name="line.345"></a>
<span class="sourceLineNo">346</span> */<a name="line.346"></a>
<span class="sourceLineNo">347</span> public AvlTreeIterator(final TNode root, final Object key,<a name="line.347"></a>
<span class="sourceLineNo">348</span> final AvlKeyComparator&lt;TNode&gt; keyComparator) {<a name="line.348"></a>
<span class="sourceLineNo">349</span> seekTo(root, key, keyComparator);<a name="line.349"></a>
<span class="sourceLineNo">350</span> }<a name="line.350"></a>
<span class="sourceLineNo">351</span><a name="line.351"></a>
<span class="sourceLineNo">352</span> @Override<a name="line.352"></a>
<span class="sourceLineNo">353</span> public boolean hasNext() {<a name="line.353"></a>
<span class="sourceLineNo">354</span> return current != null;<a name="line.354"></a>
<span class="sourceLineNo">355</span> }<a name="line.355"></a>
<span class="sourceLineNo">356</span><a name="line.356"></a>
<span class="sourceLineNo">357</span> @Override<a name="line.357"></a>
<span class="sourceLineNo">358</span> public TNode next() {<a name="line.358"></a>
<span class="sourceLineNo">359</span> final TNode node = this.current;<a name="line.359"></a>
<span class="sourceLineNo">360</span> seekNext();<a name="line.360"></a>
<span class="sourceLineNo">361</span> return node;<a name="line.361"></a>
<span class="sourceLineNo">362</span> }<a name="line.362"></a>
<span class="sourceLineNo">363</span><a name="line.363"></a>
<span class="sourceLineNo">364</span> @Override<a name="line.364"></a>
<span class="sourceLineNo">365</span> public void remove() {<a name="line.365"></a>
<span class="sourceLineNo">366</span> throw new UnsupportedOperationException();<a name="line.366"></a>
<span class="sourceLineNo">367</span> }<a name="line.367"></a>
<span class="sourceLineNo">368</span><a name="line.368"></a>
<span class="sourceLineNo">369</span> /**<a name="line.369"></a>
<span class="sourceLineNo">370</span> * Reset the iterator, and seeks to the first (min) node of the tree<a name="line.370"></a>
<span class="sourceLineNo">371</span> * @param root the current root of the tree<a name="line.371"></a>
<span class="sourceLineNo">372</span> */<a name="line.372"></a>
<span class="sourceLineNo">373</span> public void seekFirst(final TNode root) {<a name="line.373"></a>
<span class="sourceLineNo">374</span> current = root;<a name="line.374"></a>
<span class="sourceLineNo">375</span> height = 0;<a name="line.375"></a>
<span class="sourceLineNo">376</span> if (root != null) {<a name="line.376"></a>
<span class="sourceLineNo">377</span> while (current.avlLeft != null) {<a name="line.377"></a>
<span class="sourceLineNo">378</span> stack[height++] = current;<a name="line.378"></a>
<span class="sourceLineNo">379</span> current = (TNode)current.avlLeft;<a name="line.379"></a>
<span class="sourceLineNo">380</span> }<a name="line.380"></a>
<span class="sourceLineNo">381</span> }<a name="line.381"></a>
<span class="sourceLineNo">382</span> }<a name="line.382"></a>
<span class="sourceLineNo">383</span><a name="line.383"></a>
<span class="sourceLineNo">384</span> /**<a name="line.384"></a>
<span class="sourceLineNo">385</span> * Reset the iterator, and seeks to the specified key<a name="line.385"></a>
<span class="sourceLineNo">386</span> * @param root the current root of the tree<a name="line.386"></a>
<span class="sourceLineNo">387</span> * @param key the key for the node we are trying to find<a name="line.387"></a>
<span class="sourceLineNo">388</span> * @param keyComparator the comparator to use to match node and key<a name="line.388"></a>
<span class="sourceLineNo">389</span> */<a name="line.389"></a>
<span class="sourceLineNo">390</span> public void seekTo(final TNode root, final Object key,<a name="line.390"></a>
<span class="sourceLineNo">391</span> final AvlKeyComparator&lt;TNode&gt; keyComparator) {<a name="line.391"></a>
<span class="sourceLineNo">392</span> current = null;<a name="line.392"></a>
<span class="sourceLineNo">393</span> height = 0;<a name="line.393"></a>
<span class="sourceLineNo">394</span><a name="line.394"></a>
<span class="sourceLineNo">395</span> TNode node = root;<a name="line.395"></a>
<span class="sourceLineNo">396</span> while (node != null) {<a name="line.396"></a>
<span class="sourceLineNo">397</span> if (keyComparator.compareKey(node, key) &gt;= 0) {<a name="line.397"></a>
<span class="sourceLineNo">398</span> if (node.avlLeft != null) {<a name="line.398"></a>
<span class="sourceLineNo">399</span> stack[height++] = node;<a name="line.399"></a>
<span class="sourceLineNo">400</span> node = (TNode)node.avlLeft;<a name="line.400"></a>
<span class="sourceLineNo">401</span> } else {<a name="line.401"></a>
<span class="sourceLineNo">402</span> current = node;<a name="line.402"></a>
<span class="sourceLineNo">403</span> return;<a name="line.403"></a>
<span class="sourceLineNo">404</span> }<a name="line.404"></a>
<span class="sourceLineNo">405</span> } else {<a name="line.405"></a>
<span class="sourceLineNo">406</span> if (node.avlRight != null) {<a name="line.406"></a>
<span class="sourceLineNo">407</span> stack[height++] = node;<a name="line.407"></a>
<span class="sourceLineNo">408</span> node = (TNode)node.avlRight;<a name="line.408"></a>
<span class="sourceLineNo">409</span> } else {<a name="line.409"></a>
<span class="sourceLineNo">410</span> if (height &gt; 0) {<a name="line.410"></a>
<span class="sourceLineNo">411</span> TNode parent = (TNode)stack[--height];<a name="line.411"></a>
<span class="sourceLineNo">412</span> while (node == parent.avlRight) {<a name="line.412"></a>
<span class="sourceLineNo">413</span> if (height == 0) {<a name="line.413"></a>
<span class="sourceLineNo">414</span> current = null;<a name="line.414"></a>
<span class="sourceLineNo">415</span> return;<a name="line.415"></a>
<span class="sourceLineNo">416</span> }<a name="line.416"></a>
<span class="sourceLineNo">417</span> node = parent;<a name="line.417"></a>
<span class="sourceLineNo">418</span> parent = (TNode)stack[--height];<a name="line.418"></a>
<span class="sourceLineNo">419</span> }<a name="line.419"></a>
<span class="sourceLineNo">420</span> current = parent;<a name="line.420"></a>
<span class="sourceLineNo">421</span> return;<a name="line.421"></a>
<span class="sourceLineNo">422</span> }<a name="line.422"></a>
<span class="sourceLineNo">423</span> current = null;<a name="line.423"></a>
<span class="sourceLineNo">424</span> return;<a name="line.424"></a>
<span class="sourceLineNo">425</span> }<a name="line.425"></a>
<span class="sourceLineNo">426</span> }<a name="line.426"></a>
<span class="sourceLineNo">427</span> }<a name="line.427"></a>
<span class="sourceLineNo">428</span> }<a name="line.428"></a>
<span class="sourceLineNo">429</span><a name="line.429"></a>
<span class="sourceLineNo">430</span> private void seekNext() {<a name="line.430"></a>
<span class="sourceLineNo">431</span> if (current == null) return;<a name="line.431"></a>
<span class="sourceLineNo">432</span> if (current.avlRight != null) {<a name="line.432"></a>
<span class="sourceLineNo">433</span> stack[height++] = current;<a name="line.433"></a>
<span class="sourceLineNo">434</span> current = (TNode)current.avlRight;<a name="line.434"></a>
<span class="sourceLineNo">435</span> while (current.avlLeft != null) {<a name="line.435"></a>
<span class="sourceLineNo">436</span> stack[height++] = current;<a name="line.436"></a>
<span class="sourceLineNo">437</span> current = (TNode)current.avlLeft;<a name="line.437"></a>
<span class="sourceLineNo">438</span> }<a name="line.438"></a>
<span class="sourceLineNo">439</span> } else {<a name="line.439"></a>
<span class="sourceLineNo">440</span> TNode node;<a name="line.440"></a>
<span class="sourceLineNo">441</span> do {<a name="line.441"></a>
<span class="sourceLineNo">442</span> if (height == 0) {<a name="line.442"></a>
<span class="sourceLineNo">443</span> current = null;<a name="line.443"></a>
<span class="sourceLineNo">444</span> return;<a name="line.444"></a>
<span class="sourceLineNo">445</span> }<a name="line.445"></a>
<span class="sourceLineNo">446</span> node = current;<a name="line.446"></a>
<span class="sourceLineNo">447</span> current = (TNode)stack[--height];<a name="line.447"></a>
<span class="sourceLineNo">448</span> } while (current.avlRight == node);<a name="line.448"></a>
<span class="sourceLineNo">449</span> }<a name="line.449"></a>
<span class="sourceLineNo">450</span> }<a name="line.450"></a>
<span class="sourceLineNo">451</span> }<a name="line.451"></a>
<span class="sourceLineNo">452</span><a name="line.452"></a>
<span class="sourceLineNo">453</span> /**<a name="line.453"></a>
<span class="sourceLineNo">454</span> * Helper class that allows to create and manipulate a linked list of AvlLinkedNodes<a name="line.454"></a>
<span class="sourceLineNo">455</span> */<a name="line.455"></a>
<span class="sourceLineNo">456</span> @InterfaceAudience.Private<a name="line.456"></a>
<span class="sourceLineNo">457</span> public static class AvlIterableList {<a name="line.457"></a>
<span class="sourceLineNo">458</span> /**<a name="line.458"></a>
<span class="sourceLineNo">459</span> * @param node the current node<a name="line.459"></a>
<span class="sourceLineNo">460</span> * @return the successor of the current node<a name="line.460"></a>
<span class="sourceLineNo">461</span> */<a name="line.461"></a>
<span class="sourceLineNo">462</span> public static &lt;TNode extends AvlLinkedNode&gt; TNode readNext(TNode node) {<a name="line.462"></a>
<span class="sourceLineNo">463</span> return (TNode)node.iterNext;<a name="line.463"></a>
<span class="sourceLineNo">464</span> }<a name="line.464"></a>
<span class="sourceLineNo">465</span><a name="line.465"></a>
<span class="sourceLineNo">466</span> /**<a name="line.466"></a>
<span class="sourceLineNo">467</span> * @param node the current node<a name="line.467"></a>
<span class="sourceLineNo">468</span> * @return the predecessor of the current node<a name="line.468"></a>
<span class="sourceLineNo">469</span> */<a name="line.469"></a>
<span class="sourceLineNo">470</span> public static &lt;TNode extends AvlLinkedNode&gt; TNode readPrev(TNode node) {<a name="line.470"></a>
<span class="sourceLineNo">471</span> return (TNode)node.iterPrev;<a name="line.471"></a>
<span class="sourceLineNo">472</span> }<a name="line.472"></a>
<span class="sourceLineNo">473</span><a name="line.473"></a>
<span class="sourceLineNo">474</span> /**<a name="line.474"></a>
<span class="sourceLineNo">475</span> * @param head the head of the linked list<a name="line.475"></a>
<span class="sourceLineNo">476</span> * @param node the node to add to the front of the list<a name="line.476"></a>
<span class="sourceLineNo">477</span> * @return the new head of the list<a name="line.477"></a>
<span class="sourceLineNo">478</span> */<a name="line.478"></a>
<span class="sourceLineNo">479</span> public static &lt;TNode extends AvlLinkedNode&gt; TNode prepend(TNode head, TNode node) {<a name="line.479"></a>
<span class="sourceLineNo">480</span> assert !isLinked(node) : node + " is already linked";<a name="line.480"></a>
<span class="sourceLineNo">481</span> if (head != null) {<a name="line.481"></a>
<span class="sourceLineNo">482</span> TNode tail = (TNode)head.iterPrev;<a name="line.482"></a>
<span class="sourceLineNo">483</span> tail.iterNext = node;<a name="line.483"></a>
<span class="sourceLineNo">484</span> head.iterPrev = node;<a name="line.484"></a>
<span class="sourceLineNo">485</span> node.iterNext = head;<a name="line.485"></a>
<span class="sourceLineNo">486</span> node.iterPrev = tail;<a name="line.486"></a>
<span class="sourceLineNo">487</span> } else {<a name="line.487"></a>
<span class="sourceLineNo">488</span> node.iterNext = node;<a name="line.488"></a>
<span class="sourceLineNo">489</span> node.iterPrev = node;<a name="line.489"></a>
<span class="sourceLineNo">490</span> }<a name="line.490"></a>
<span class="sourceLineNo">491</span> return node;<a name="line.491"></a>
<span class="sourceLineNo">492</span> }<a name="line.492"></a>
<span class="sourceLineNo">493</span><a name="line.493"></a>
<span class="sourceLineNo">494</span> /**<a name="line.494"></a>
<span class="sourceLineNo">495</span> * @param head the head of the linked list<a name="line.495"></a>
<span class="sourceLineNo">496</span> * @param node the node to add to the tail of the list<a name="line.496"></a>
<span class="sourceLineNo">497</span> * @return the new head of the list<a name="line.497"></a>
<span class="sourceLineNo">498</span> */<a name="line.498"></a>
<span class="sourceLineNo">499</span> public static &lt;TNode extends AvlLinkedNode&gt; TNode append(TNode head, TNode node) {<a name="line.499"></a>
<span class="sourceLineNo">500</span> assert !isLinked(node) : node + " is already linked";<a name="line.500"></a>
<span class="sourceLineNo">501</span> if (head != null) {<a name="line.501"></a>
<span class="sourceLineNo">502</span> TNode tail = (TNode)head.iterPrev;<a name="line.502"></a>
<span class="sourceLineNo">503</span> tail.iterNext = node;<a name="line.503"></a>
<span class="sourceLineNo">504</span> node.iterNext = head;<a name="line.504"></a>
<span class="sourceLineNo">505</span> node.iterPrev = tail;<a name="line.505"></a>
<span class="sourceLineNo">506</span> head.iterPrev = node;<a name="line.506"></a>
<span class="sourceLineNo">507</span> return head;<a name="line.507"></a>
<span class="sourceLineNo">508</span> }<a name="line.508"></a>
<span class="sourceLineNo">509</span> node.iterNext = node;<a name="line.509"></a>
<span class="sourceLineNo">510</span> node.iterPrev = node;<a name="line.510"></a>
<span class="sourceLineNo">511</span> return node;<a name="line.511"></a>
<span class="sourceLineNo">512</span> }<a name="line.512"></a>
<span class="sourceLineNo">513</span><a name="line.513"></a>
<span class="sourceLineNo">514</span> /**<a name="line.514"></a>
<span class="sourceLineNo">515</span> * @param head the head of the current linked list<a name="line.515"></a>
<span class="sourceLineNo">516</span> * @param otherHead the head of the list to append to the current list<a name="line.516"></a>
<span class="sourceLineNo">517</span> * @return the new head of the current list<a name="line.517"></a>
<span class="sourceLineNo">518</span> */<a name="line.518"></a>
<span class="sourceLineNo">519</span> public static &lt;TNode extends AvlLinkedNode&gt; TNode appendList(TNode head, TNode otherHead) {<a name="line.519"></a>
<span class="sourceLineNo">520</span> if (head == null) return otherHead;<a name="line.520"></a>
<span class="sourceLineNo">521</span> if (otherHead == null) return head;<a name="line.521"></a>
<span class="sourceLineNo">522</span><a name="line.522"></a>
<span class="sourceLineNo">523</span> TNode tail = (TNode)head.iterPrev;<a name="line.523"></a>
<span class="sourceLineNo">524</span> TNode otherTail = (TNode)otherHead.iterPrev;<a name="line.524"></a>
<span class="sourceLineNo">525</span> tail.iterNext = otherHead;<a name="line.525"></a>
<span class="sourceLineNo">526</span> otherHead.iterPrev = tail;<a name="line.526"></a>
<span class="sourceLineNo">527</span> otherTail.iterNext = head;<a name="line.527"></a>
<span class="sourceLineNo">528</span> head.iterPrev = otherTail;<a name="line.528"></a>
<span class="sourceLineNo">529</span> return head;<a name="line.529"></a>
<span class="sourceLineNo">530</span> }<a name="line.530"></a>
<span class="sourceLineNo">531</span><a name="line.531"></a>
<span class="sourceLineNo">532</span> /**<a name="line.532"></a>
<span class="sourceLineNo">533</span> * @param head the head of the linked list<a name="line.533"></a>
<span class="sourceLineNo">534</span> * @param node the node to remove from the list<a name="line.534"></a>
<span class="sourceLineNo">535</span> * @return the new head of the list<a name="line.535"></a>
<span class="sourceLineNo">536</span> */<a name="line.536"></a>
<span class="sourceLineNo">537</span> public static &lt;TNode extends AvlLinkedNode&gt; TNode remove(TNode head, TNode node) {<a name="line.537"></a>
<span class="sourceLineNo">538</span> assert isLinked(node) : node + " is not linked";<a name="line.538"></a>
<span class="sourceLineNo">539</span> if (node != node.iterNext) {<a name="line.539"></a>
<span class="sourceLineNo">540</span> node.iterPrev.iterNext = node.iterNext;<a name="line.540"></a>
<span class="sourceLineNo">541</span> node.iterNext.iterPrev = node.iterPrev;<a name="line.541"></a>
<span class="sourceLineNo">542</span> head = (head == node) ? (TNode)node.iterNext : head;<a name="line.542"></a>
<span class="sourceLineNo">543</span> } else {<a name="line.543"></a>
<span class="sourceLineNo">544</span> head = null;<a name="line.544"></a>
<span class="sourceLineNo">545</span> }<a name="line.545"></a>
<span class="sourceLineNo">546</span> node.iterNext = null;<a name="line.546"></a>
<span class="sourceLineNo">547</span> node.iterPrev = null;<a name="line.547"></a>
<span class="sourceLineNo">548</span> return head;<a name="line.548"></a>
<span class="sourceLineNo">549</span> }<a name="line.549"></a>
<span class="sourceLineNo">550</span><a name="line.550"></a>
<span class="sourceLineNo">551</span> /**<a name="line.551"></a>
<span class="sourceLineNo">552</span> * @param head the head of the linked list<a name="line.552"></a>
<span class="sourceLineNo">553</span> * @param base the node which we want to add the {@code node} before it<a name="line.553"></a>
<span class="sourceLineNo">554</span> * @param node the node which we want to add it before the {@code base} node<a name="line.554"></a>
<span class="sourceLineNo">555</span> */<a name="line.555"></a>
<span class="sourceLineNo">556</span> public static &lt;TNode extends AvlLinkedNode&gt; TNode prepend(TNode head, TNode base, TNode node) {<a name="line.556"></a>
<span class="sourceLineNo">557</span> assert !isLinked(node) : node + " is already linked";<a name="line.557"></a>
<span class="sourceLineNo">558</span> node.iterNext = base;<a name="line.558"></a>
<span class="sourceLineNo">559</span> node.iterPrev = base.iterPrev;<a name="line.559"></a>
<span class="sourceLineNo">560</span> base.iterPrev.iterNext = node;<a name="line.560"></a>
<span class="sourceLineNo">561</span> base.iterPrev = node;<a name="line.561"></a>
<span class="sourceLineNo">562</span> return head == base ? node : head;<a name="line.562"></a>
<span class="sourceLineNo">563</span> }<a name="line.563"></a>
<span class="sourceLineNo">564</span><a name="line.564"></a>
<span class="sourceLineNo">565</span> /**<a name="line.565"></a>
<span class="sourceLineNo">566</span> * @param node the node to check<a name="line.566"></a>
<span class="sourceLineNo">567</span> * @return true if the node is linked to a list, false otherwise<a name="line.567"></a>
<span class="sourceLineNo">568</span> */<a name="line.568"></a>
<span class="sourceLineNo">569</span> public static &lt;TNode extends AvlLinkedNode&gt; boolean isLinked(TNode node) {<a name="line.569"></a>
<span class="sourceLineNo">570</span> return node.iterPrev != null &amp;&amp; node.iterNext != null;<a name="line.570"></a>
<span class="sourceLineNo">571</span> }<a name="line.571"></a>
<span class="sourceLineNo">572</span> }<a name="line.572"></a>
<span class="sourceLineNo">573</span>}<a name="line.573"></a>
</pre>
</div>
</body>
</html>