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 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608
|
// run
// Copyright 2021 The Go Authors. All rights reserved.
// Use of this source code is governed by a BSD-style
// license that can be found in the LICENSE file.
// Package list provides a doubly linked list of some element type
// (generic form of the "container/list" package).
package main
import (
"fmt"
"strconv"
)
// _Element is an element of a linked list.
type _Element[T any] struct {
// Next and previous pointers in the doubly-linked list of elements.
// To simplify the implementation, internally a list l is implemented
// as a ring, such that &l.root is both the next element of the last
// list element (l.Back()) and the previous element of the first list
// element (l.Front()).
next, prev *_Element[T]
// The list to which this element belongs.
list *_List[T]
// The value stored with this element.
Value T
}
// Next returns the next list element or nil.
func (e *_Element[T]) Next() *_Element[T] {
if p := e.next; e.list != nil && p != &e.list.root {
return p
}
return nil
}
// Prev returns the previous list element or nil.
func (e *_Element[T]) Prev() *_Element[T] {
if p := e.prev; e.list != nil && p != &e.list.root {
return p
}
return nil
}
// _List represents a doubly linked list.
// The zero value for _List is an empty list ready to use.
type _List[T any] struct {
root _Element[T] // sentinel list element, only &root, root.prev, and root.next are used
len int // current list length excluding (this) sentinel element
}
// Init initializes or clears list l.
func (l *_List[T]) Init() *_List[T] {
l.root.next = &l.root
l.root.prev = &l.root
l.len = 0
return l
}
// New returns an initialized list.
func _New[T any]() *_List[T] { return new(_List[T]).Init() }
// Len returns the number of elements of list l.
// The complexity is O(1).
func (l *_List[_]) Len() int { return l.len }
// Front returns the first element of list l or nil if the list is empty.
func (l *_List[T]) Front() *_Element[T] {
if l.len == 0 {
return nil
}
return l.root.next
}
// Back returns the last element of list l or nil if the list is empty.
func (l *_List[T]) Back() *_Element[T] {
if l.len == 0 {
return nil
}
return l.root.prev
}
// lazyInit lazily initializes a zero _List value.
func (l *_List[_]) lazyInit() {
if l.root.next == nil {
l.Init()
}
}
// insert inserts e after at, increments l.len, and returns e.
func (l *_List[T]) insert(e, at *_Element[T]) *_Element[T] {
e.prev = at
e.next = at.next
e.prev.next = e
e.next.prev = e
e.list = l
l.len++
return e
}
// insertValue is a convenience wrapper for insert(&_Element[T]{Value: v}, at).
func (l *_List[T]) insertValue(v T, at *_Element[T]) *_Element[T] {
return l.insert(&_Element[T]{Value: v}, at)
}
// remove removes e from its list, decrements l.len, and returns e.
func (l *_List[T]) remove(e *_Element[T]) *_Element[T] {
e.prev.next = e.next
e.next.prev = e.prev
e.next = nil // avoid memory leaks
e.prev = nil // avoid memory leaks
e.list = nil
l.len--
return e
}
// move moves e to next to at and returns e.
func (l *_List[T]) move(e, at *_Element[T]) *_Element[T] {
if e == at {
return e
}
e.prev.next = e.next
e.next.prev = e.prev
e.prev = at
e.next = at.next
e.prev.next = e
e.next.prev = e
return e
}
// Remove removes e from l if e is an element of list l.
// It returns the element value e.Value.
// The element must not be nil.
func (l *_List[T]) Remove(e *_Element[T]) T {
if e.list == l {
// if e.list == l, l must have been initialized when e was inserted
// in l or l == nil (e is a zero _Element) and l.remove will crash
l.remove(e)
}
return e.Value
}
// PushFront inserts a new element e with value v at the front of list l and returns e.
func (l *_List[T]) PushFront(v T) *_Element[T] {
l.lazyInit()
return l.insertValue(v, &l.root)
}
// PushBack inserts a new element e with value v at the back of list l and returns e.
func (l *_List[T]) PushBack(v T) *_Element[T] {
l.lazyInit()
return l.insertValue(v, l.root.prev)
}
// InsertBefore inserts a new element e with value v immediately before mark and returns e.
// If mark is not an element of l, the list is not modified.
// The mark must not be nil.
func (l *_List[T]) InsertBefore(v T, mark *_Element[T]) *_Element[T] {
if mark.list != l {
return nil
}
// see comment in _List.Remove about initialization of l
return l.insertValue(v, mark.prev)
}
// InsertAfter inserts a new element e with value v immediately after mark and returns e.
// If mark is not an element of l, the list is not modified.
// The mark must not be nil.
func (l *_List[T]) InsertAfter(v T, mark *_Element[T]) *_Element[T] {
if mark.list != l {
return nil
}
// see comment in _List.Remove about initialization of l
return l.insertValue(v, mark)
}
// MoveToFront moves element e to the front of list l.
// If e is not an element of l, the list is not modified.
// The element must not be nil.
func (l *_List[T]) MoveToFront(e *_Element[T]) {
if e.list != l || l.root.next == e {
return
}
// see comment in _List.Remove about initialization of l
l.move(e, &l.root)
}
// MoveToBack moves element e to the back of list l.
// If e is not an element of l, the list is not modified.
// The element must not be nil.
func (l *_List[T]) MoveToBack(e *_Element[T]) {
if e.list != l || l.root.prev == e {
return
}
// see comment in _List.Remove about initialization of l
l.move(e, l.root.prev)
}
// MoveBefore moves element e to its new position before mark.
// If e or mark is not an element of l, or e == mark, the list is not modified.
// The element and mark must not be nil.
func (l *_List[T]) MoveBefore(e, mark *_Element[T]) {
if e.list != l || e == mark || mark.list != l {
return
}
l.move(e, mark.prev)
}
// MoveAfter moves element e to its new position after mark.
// If e or mark is not an element of l, or e == mark, the list is not modified.
// The element and mark must not be nil.
func (l *_List[T]) MoveAfter(e, mark *_Element[T]) {
if e.list != l || e == mark || mark.list != l {
return
}
l.move(e, mark)
}
// PushBackList inserts a copy of an other list at the back of list l.
// The lists l and other may be the same. They must not be nil.
func (l *_List[T]) PushBackList(other *_List[T]) {
l.lazyInit()
for i, e := other.Len(), other.Front(); i > 0; i, e = i-1, e.Next() {
l.insertValue(e.Value, l.root.prev)
}
}
// PushFrontList inserts a copy of an other list at the front of list l.
// The lists l and other may be the same. They must not be nil.
func (l *_List[T]) PushFrontList(other *_List[T]) {
l.lazyInit()
for i, e := other.Len(), other.Back(); i > 0; i, e = i-1, e.Prev() {
l.insertValue(e.Value, &l.root)
}
}
// Transform runs a transform function on a list returning a new list.
func _Transform[TElem1, TElem2 any](lst *_List[TElem1], f func(TElem1) TElem2) *_List[TElem2] {
ret := _New[TElem2]()
for p := lst.Front(); p != nil; p = p.Next() {
ret.PushBack(f(p.Value))
}
return ret
}
func checkListLen[T any](l *_List[T], len int) bool {
if n := l.Len(); n != len {
panic(fmt.Sprintf("l.Len() = %d, want %d", n, len))
return false
}
return true
}
func checkListPointers[T any](l *_List[T], es []*_Element[T]) {
root := &l.root
if !checkListLen(l, len(es)) {
return
}
// zero length lists must be the zero value or properly initialized (sentinel circle)
if len(es) == 0 {
if l.root.next != nil && l.root.next != root || l.root.prev != nil && l.root.prev != root {
panic(fmt.Sprintf("l.root.next = %p, l.root.prev = %p; both should both be nil or %p", l.root.next, l.root.prev, root))
}
return
}
// len(es) > 0
// check internal and external prev/next connections
for i, e := range es {
prev := root
Prev := (*_Element[T])(nil)
if i > 0 {
prev = es[i-1]
Prev = prev
}
if p := e.prev; p != prev {
panic(fmt.Sprintf("elt[%d](%p).prev = %p, want %p", i, e, p, prev))
}
if p := e.Prev(); p != Prev {
panic(fmt.Sprintf("elt[%d](%p).Prev() = %p, want %p", i, e, p, Prev))
}
next := root
Next := (*_Element[T])(nil)
if i < len(es)-1 {
next = es[i+1]
Next = next
}
if n := e.next; n != next {
panic(fmt.Sprintf("elt[%d](%p).next = %p, want %p", i, e, n, next))
}
if n := e.Next(); n != Next {
panic(fmt.Sprintf("elt[%d](%p).Next() = %p, want %p", i, e, n, Next))
}
}
}
func TestList() {
l := _New[string]()
checkListPointers(l, []*(_Element[string]){})
// Single element list
e := l.PushFront("a")
checkListPointers(l, []*(_Element[string]){e})
l.MoveToFront(e)
checkListPointers(l, []*(_Element[string]){e})
l.MoveToBack(e)
checkListPointers(l, []*(_Element[string]){e})
l.Remove(e)
checkListPointers(l, []*(_Element[string]){})
// Bigger list
l2 := _New[int]()
e2 := l2.PushFront(2)
e1 := l2.PushFront(1)
e3 := l2.PushBack(3)
e4 := l2.PushBack(600)
checkListPointers(l2, []*(_Element[int]){e1, e2, e3, e4})
l2.Remove(e2)
checkListPointers(l2, []*(_Element[int]){e1, e3, e4})
l2.MoveToFront(e3) // move from middle
checkListPointers(l2, []*(_Element[int]){e3, e1, e4})
l2.MoveToFront(e1)
l2.MoveToBack(e3) // move from middle
checkListPointers(l2, []*(_Element[int]){e1, e4, e3})
l2.MoveToFront(e3) // move from back
checkListPointers(l2, []*(_Element[int]){e3, e1, e4})
l2.MoveToFront(e3) // should be no-op
checkListPointers(l2, []*(_Element[int]){e3, e1, e4})
l2.MoveToBack(e3) // move from front
checkListPointers(l2, []*(_Element[int]){e1, e4, e3})
l2.MoveToBack(e3) // should be no-op
checkListPointers(l2, []*(_Element[int]){e1, e4, e3})
e2 = l2.InsertBefore(2, e1) // insert before front
checkListPointers(l2, []*(_Element[int]){e2, e1, e4, e3})
l2.Remove(e2)
e2 = l2.InsertBefore(2, e4) // insert before middle
checkListPointers(l2, []*(_Element[int]){e1, e2, e4, e3})
l2.Remove(e2)
e2 = l2.InsertBefore(2, e3) // insert before back
checkListPointers(l2, []*(_Element[int]){e1, e4, e2, e3})
l2.Remove(e2)
e2 = l2.InsertAfter(2, e1) // insert after front
checkListPointers(l2, []*(_Element[int]){e1, e2, e4, e3})
l2.Remove(e2)
e2 = l2.InsertAfter(2, e4) // insert after middle
checkListPointers(l2, []*(_Element[int]){e1, e4, e2, e3})
l2.Remove(e2)
e2 = l2.InsertAfter(2, e3) // insert after back
checkListPointers(l2, []*(_Element[int]){e1, e4, e3, e2})
l2.Remove(e2)
// Check standard iteration.
sum := 0
for e := l2.Front(); e != nil; e = e.Next() {
sum += e.Value
}
if sum != 604 {
panic(fmt.Sprintf("sum over l = %d, want 604", sum))
}
// Clear all elements by iterating
var next *_Element[int]
for e := l2.Front(); e != nil; e = next {
next = e.Next()
l2.Remove(e)
}
checkListPointers(l2, []*(_Element[int]){})
}
func checkList[T comparable](l *_List[T], es []interface{}) {
if !checkListLen(l, len(es)) {
return
}
i := 0
for e := l.Front(); e != nil; e = e.Next() {
le := e.Value
// Comparison between a generically-typed variable le and an interface.
if le != es[i] {
panic(fmt.Sprintf("elt[%d].Value = %v, want %v", i, le, es[i]))
}
i++
}
}
func TestExtending() {
l1 := _New[int]()
l2 := _New[int]()
l1.PushBack(1)
l1.PushBack(2)
l1.PushBack(3)
l2.PushBack(4)
l2.PushBack(5)
l3 := _New[int]()
l3.PushBackList(l1)
checkList(l3, []interface{}{1, 2, 3})
l3.PushBackList(l2)
checkList(l3, []interface{}{1, 2, 3, 4, 5})
l3 = _New[int]()
l3.PushFrontList(l2)
checkList(l3, []interface{}{4, 5})
l3.PushFrontList(l1)
checkList(l3, []interface{}{1, 2, 3, 4, 5})
checkList(l1, []interface{}{1, 2, 3})
checkList(l2, []interface{}{4, 5})
l3 = _New[int]()
l3.PushBackList(l1)
checkList(l3, []interface{}{1, 2, 3})
l3.PushBackList(l3)
checkList(l3, []interface{}{1, 2, 3, 1, 2, 3})
l3 = _New[int]()
l3.PushFrontList(l1)
checkList(l3, []interface{}{1, 2, 3})
l3.PushFrontList(l3)
checkList(l3, []interface{}{1, 2, 3, 1, 2, 3})
l3 = _New[int]()
l1.PushBackList(l3)
checkList(l1, []interface{}{1, 2, 3})
l1.PushFrontList(l3)
checkList(l1, []interface{}{1, 2, 3})
}
func TestRemove() {
l := _New[int]()
e1 := l.PushBack(1)
e2 := l.PushBack(2)
checkListPointers(l, []*(_Element[int]){e1, e2})
e := l.Front()
l.Remove(e)
checkListPointers(l, []*(_Element[int]){e2})
l.Remove(e)
checkListPointers(l, []*(_Element[int]){e2})
}
func TestIssue4103() {
l1 := _New[int]()
l1.PushBack(1)
l1.PushBack(2)
l2 := _New[int]()
l2.PushBack(3)
l2.PushBack(4)
e := l1.Front()
l2.Remove(e) // l2 should not change because e is not an element of l2
if n := l2.Len(); n != 2 {
panic(fmt.Sprintf("l2.Len() = %d, want 2", n))
}
l1.InsertBefore(8, e)
if n := l1.Len(); n != 3 {
panic(fmt.Sprintf("l1.Len() = %d, want 3", n))
}
}
func TestIssue6349() {
l := _New[int]()
l.PushBack(1)
l.PushBack(2)
e := l.Front()
l.Remove(e)
if e.Value != 1 {
panic(fmt.Sprintf("e.value = %d, want 1", e.Value))
}
if e.Next() != nil {
panic(fmt.Sprintf("e.Next() != nil"))
}
if e.Prev() != nil {
panic(fmt.Sprintf("e.Prev() != nil"))
}
}
func TestMove() {
l := _New[int]()
e1 := l.PushBack(1)
e2 := l.PushBack(2)
e3 := l.PushBack(3)
e4 := l.PushBack(4)
l.MoveAfter(e3, e3)
checkListPointers(l, []*(_Element[int]){e1, e2, e3, e4})
l.MoveBefore(e2, e2)
checkListPointers(l, []*(_Element[int]){e1, e2, e3, e4})
l.MoveAfter(e3, e2)
checkListPointers(l, []*(_Element[int]){e1, e2, e3, e4})
l.MoveBefore(e2, e3)
checkListPointers(l, []*(_Element[int]){e1, e2, e3, e4})
l.MoveBefore(e2, e4)
checkListPointers(l, []*(_Element[int]){e1, e3, e2, e4})
e2, e3 = e3, e2
l.MoveBefore(e4, e1)
checkListPointers(l, []*(_Element[int]){e4, e1, e2, e3})
e1, e2, e3, e4 = e4, e1, e2, e3
l.MoveAfter(e4, e1)
checkListPointers(l, []*(_Element[int]){e1, e4, e2, e3})
e2, e3, e4 = e4, e2, e3
l.MoveAfter(e2, e3)
checkListPointers(l, []*(_Element[int]){e1, e3, e2, e4})
e2, e3 = e3, e2
}
// Test PushFront, PushBack, PushFrontList, PushBackList with uninitialized _List
func TestZeroList() {
var l1 = new(_List[int])
l1.PushFront(1)
checkList(l1, []interface{}{1})
var l2 = new(_List[int])
l2.PushBack(1)
checkList(l2, []interface{}{1})
var l3 = new(_List[int])
l3.PushFrontList(l1)
checkList(l3, []interface{}{1})
var l4 = new(_List[int])
l4.PushBackList(l2)
checkList(l4, []interface{}{1})
}
// Test that a list l is not modified when calling InsertBefore with a mark that is not an element of l.
func TestInsertBeforeUnknownMark() {
var l _List[int]
l.PushBack(1)
l.PushBack(2)
l.PushBack(3)
l.InsertBefore(1, new(_Element[int]))
checkList(&l, []interface{}{1, 2, 3})
}
// Test that a list l is not modified when calling InsertAfter with a mark that is not an element of l.
func TestInsertAfterUnknownMark() {
var l _List[int]
l.PushBack(1)
l.PushBack(2)
l.PushBack(3)
l.InsertAfter(1, new(_Element[int]))
checkList(&l, []interface{}{1, 2, 3})
}
// Test that a list l is not modified when calling MoveAfter or MoveBefore with a mark that is not an element of l.
func TestMoveUnknownMark() {
var l1 _List[int]
e1 := l1.PushBack(1)
var l2 _List[int]
e2 := l2.PushBack(2)
l1.MoveAfter(e1, e2)
checkList(&l1, []interface{}{1})
checkList(&l2, []interface{}{2})
l1.MoveBefore(e1, e2)
checkList(&l1, []interface{}{1})
checkList(&l2, []interface{}{2})
}
// Test the Transform function.
func TestTransform() {
l1 := _New[int]()
l1.PushBack(1)
l1.PushBack(2)
l2 := _Transform(l1, strconv.Itoa)
checkList(l2, []interface{}{"1", "2"})
}
func main() {
TestList()
TestExtending()
TestRemove()
TestIssue4103()
TestIssue6349()
TestMove()
TestZeroList()
TestInsertBeforeUnknownMark()
TestInsertAfterUnknownMark()
TestTransform()
}
|