aboutsummaryrefslogtreecommitdiffstats
path: root/src/datastructures/linkedlists/template
blob: 07ceb6000d53de9e0e6fc93502ed288350ab1d04 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
/* -*- java -*- */
/**
 * Copyright © 2014  Mattias Andrée (maandree@member.fsf.org)
 * 
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 * 
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Affero General Public License for more details.
 * 
 * You should have received a copy of the GNU Affero General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */
{
    /**
     * Node for the list
     */
    public class Node
    {
	/**
	 * Constructor
	 * 
	 * @param  value  The value to store in the list
	 */
	public Node(T value)
	{
	    this.value = value;
	}
	
	
	
	/**
	 * The value stored in the list by this node
	 */
	public T value;
	
	/**
	 * The next node in the list
	 */
	public Node next = null;
	
£>if (( with_prev )); then
	/**
	 * The previous node in the list
	 */
	public Node previous = null;
£>fi
	
    }
    
    
    
£>if (( with_head )); then
    /**
     * The first node in the list
     */
    public Node head = null;
£>fi
    
£>if (( with_tail )); then
    /**
     * The last node in the list
     */
    public Node tail = null;
£>fi
    
    

£>if (( 1 - with_head )) && (( 1 - with_tail )); then
    /**
     * Creates the initial node in a circularly linked list
     * 
     * @param   value  The value of the initial node
     * @return         The node that has been created and inserted
     */
    public Node create(T value)
    {
	Node node = new Node(value);
£>(( with_prev )) &&
	node.previous = node;
	return node.next = node;
    }
£>fi
    
£>if (( with_head )); then
    /**
     * Insert a value in the beginning of the list
     * 
     * @param   value  The value to insert
     * @return         The node that has been created and inserted
     */
    public Node insertBeginning(T value)
    {
	Node node = new Node(value);
	node.next = this.head;
£>if (( with_prev )); then
	if (node.next != null)
	    node.next.previous = node;
£>fi
£>if (( with_tail )); then
	if (this.head == null)
	    this.tail = node;
£>fi
	this.head = node;
	return node;
    }
    
    /**
     * Remove the node at the beginning of the list
     * 
     * @return  The node that has been removed
     */
    public Node removeBeginning()
    {
	Node node = this.head;
	if (node != null)
	    this.head = this.head.next;
£>if (( with_prev )); then
	if (this.head != null)
	    this.head.previous = null;
£>fi
£>if (( with_tail )); then
	if (this.tail == node)
	    this.tail = null;
£>fi
	return node;
    }
£>fi
    
    /**
     * Insert a value after a specified, reference, node
     * 
     * @param   value        The value to insert
     * @param   predecessor  The reference node
     * @return               The node that has been created and inserted
     */
    public Node insertAfter(T value, Node predecessor)
    {
	Node node = new Node(value);
	node.next = predecessor.next;
	predecessor.next = node;
£>if (( with_prev )); then
	node.previous = predecessor;
	if (node.next != null)
	    node.next.previous = node;
£>fi
£>if (( with_tail )); then
	if (this.tail == predecessor)
	    this.tail = node;
£>fi
	return node;
    }
    
    /**
     * Remove the node after a specified, reference, node
     * 
     * @param   predecessor  The reference node
     * @return               The node that has been removed
     */
    public Node removeAfter(Node predecessor)
    {
	Node node = predecessor.next;
	if (node == null)
	    predecessor.next = node.next;
£>if (( with_prev )); then
	else if (node.next != null)
	    node.next.previous = predecessor;
£>fi
£>if (( with_tail )); then
	if (this.tail == node)
	    this.tail = predecessor;
£>fi
	return node;
    }

£>if (( with_prev )); then
    /**
     * Insert a value before a specified, reference, node
     * 
     * @param   value      The value to insert
     * @param   successor  The reference node
     * @return             The node that has been created and inserted
     */
    public Node insertBefore(T value, Node successor)
    {
	Node node = new Node(value);
	node.previous = successor.previous;
	successor.previous = node;
	node.next = successor;
	if (node.previous != null)
	    node.previous.next = node;
£>if (( with_head )); then
	if (this.head == successor)
	    this.head = node;
£>fi
	return node;
    }
    
    /**
     * Remove the node before a specified, reference, node
     * 
     * @param   successor  The reference node
     * @return             The node that has been removed
     */
    public Node removeBefore(Node successor)
    {
	Node node = successor.previous;
	if (node == null)
	    successor.previous = node.previous;
	else if (node.previous != null)
	    node.previous.next = successor;
£>if (( with_head )); then
	if (this.head == node)
	    this.head = successor;
£>fi
	return node;
    }
    
    /**
     * Remove the node from the list
     * 
     * @param  node  The node to remove
     */
    public void remove(Node node)
    {
	if (node.previous != null)
	    node.previous.next = node.next;
£>if (( with_head )); then
	else
	    this.head = node.next;
£>fi	
	if (node.next != null)
	    node.next.previous = node.previous;
£>if (( with_tail )); then
	else
	    this.tail = node.previous;
£>fi
    }
£>fi
    
£>if (( with_tail )); then
    /**
     * Insert a value in the end of the list
     * 
     * @param   value  The value to insert
     * @return         The node that has been created and inserted
     */
    public Node insertEnd(T value)
    {
	if (this.tail == null)
£>(( with_head )) &&
	    return insertBeginning(value);
£>(( with_head )) ||
	    return this.tail = new Node(value);
	return insertAfter(value, this.tail);
    }

£>if (( with_prev )); then
    /**
     * Remove the node at the end of the list
     * 
     * @return  The node that has been removed
     */
    public Node removeEnd()
    {
	Node node = this.tail;
	if (node != null)
	    (this.tail = node.previous).next = null;
	return node;
    }
£>fi
£>fi
    
}