cmd/go2go: add List example

Change-Id: Id12b3489c2cd17f48d918563b002fe704db6a177
Reviewed-on: https://team-review.git.corp.google.com/c/golang/go2-dev/+/723255
Reviewed-by: Ian Lance Taylor <iant@google.com>
This commit is contained in:
Ian Lance Taylor 2020-04-20 16:53:29 -07:00 committed by Robert Griesemer
parent 4ba2f1d5fd
commit c2d160bafc
2 changed files with 598 additions and 0 deletions

View File

@ -0,0 +1,244 @@
// Copyright 2020 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.
package list
// FIXME: This should probably be in container/list,
// perhaps with different type names.
// Element is an element of a linked list.
type Element(type TElem) 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(TElem)
// The list to which this element belongs.
list *List(TElem)
// The value stored with this element.
Value TElem
}
// Next returns the next list element or nil.
func (e *Element(TElem)) Next() *Element(TElem) {
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(TElem)) Prev() *Element(TElem) {
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(type TElem) struct {
root Element(TElem) // 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(TElem)) Init() *List(TElem) {
l.root.next = &l.root
l.root.prev = &l.root
l.len = 0
return l
}
// New returns an initialized list.
func New(type TElem)() *List(TElem) { return new(List(TElem)).Init() }
// Len returns the number of elements of list l.
// The complexity is O(1).
func (l *List(TElem)) Len() int { return l.len }
// Front returns the first element of list l or nil if the list is empty.
func (l *List(TElem)) Front() *Element(TElem) {
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(TElem)) Back() *Element(TElem) {
if l.len == 0 {
return nil
}
return l.root.prev
}
// lazyInit lazily initializes a zero List value.
func (l *List(TElem)) lazyInit() {
if l.root.next == nil {
l.Init()
}
}
// insert inserts e after at, increments l.len, and returns e.
func (l *List(TElem)) insert(e, at *Element(TElem)) *Element(TElem) {
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(TElem){Value: v}, at).
func (l *List(TElem)) insertValue(v TElem, at *Element(TElem)) *Element(TElem) {
return l.insert(&Element(TElem){Value: v}, at)
}
// remove removes e from its list, decrements l.len, and returns e.
func (l *List(TElem)) remove(e *Element(TElem)) *Element(TElem) {
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(TElem)) move(e, at *Element(TElem)) *Element(TElem) {
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(TElem)) Remove(e *Element(TElem)) TElem {
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(TElem)) PushFront(v TElem) *Element(TElem) {
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(TElem)) PushBack(v TElem) *Element(TElem) {
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(TElem)) InsertBefore(v TElem, mark *Element(TElem)) *Element(TElem) {
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(TElem)) InsertAfter(v TElem, mark *Element(TElem)) *Element(TElem) {
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(TElem)) MoveToFront(e *Element(TElem)) {
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(TElem)) MoveToBack(e *Element(TElem)) {
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(TElem)) MoveBefore(e, mark *Element(TElem)) {
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(TElem)) MoveAfter(e, mark *Element(TElem)) {
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(TElem)) PushBackList(other *List(TElem)) {
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(TElem)) PushFrontList(other *List(TElem)) {
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(type TElem1, TElem2)(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
}

View File

@ -0,0 +1,354 @@
// Copyright 2020 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
import (
"strconv"
"testing"
)
func checkListLen(type TElem)(t *testing.T, l *List(TElem), len int) bool {
if n := l.Len(); n != len {
t.Errorf("l.Len() = %d, want %d", n, len)
return false
}
return true
}
func checkListPointers(type TElem)(t *testing.T, l *List(TElem), es []*Element(TElem)) {
root := &l.root
if !checkListLen(t, 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 {
t.Errorf("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(TElem))(nil)
if i > 0 {
prev = es[i-1]
Prev = prev
}
if p := e.prev; p != prev {
t.Errorf("elt[%d](%p).prev = %p, want %p", i, e, p, prev)
}
if p := e.Prev(); p != Prev {
t.Errorf("elt[%d](%p).Prev() = %p, want %p", i, e, p, Prev)
}
next := root
Next := (*Element(TElem))(nil)
if i < len(es)-1 {
next = es[i+1]
Next = next
}
if n := e.next; n != next {
t.Errorf("elt[%d](%p).next = %p, want %p", i, e, n, next)
}
if n := e.Next(); n != Next {
t.Errorf("elt[%d](%p).Next() = %p, want %p", i, e, n, Next)
}
}
}
func TestList(t *testing.T) {
l := New(string)()
checkListPointers(t, l, []*(Element(string)){})
// Single element list
e := l.PushFront("a")
checkListPointers(t, l, []*(Element(string)){e})
l.MoveToFront(e)
checkListPointers(t, l, []*(Element(string)){e})
l.MoveToBack(e)
checkListPointers(t, l, []*(Element(string)){e})
l.Remove(e)
checkListPointers(t, 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(t, l2, []*(Element(int)){e1, e2, e3, e4})
l2.Remove(e2)
checkListPointers(t, l2, []*(Element(int)){e1, e3, e4})
l2.MoveToFront(e3) // move from middle
checkListPointers(t, l2, []*(Element(int)){e3, e1, e4})
l2.MoveToFront(e1)
l2.MoveToBack(e3) // move from middle
checkListPointers(t, l2, []*(Element(int)){e1, e4, e3})
l2.MoveToFront(e3) // move from back
checkListPointers(t, l2, []*(Element(int)){e3, e1, e4})
l2.MoveToFront(e3) // should be no-op
checkListPointers(t, l2, []*(Element(int)){e3, e1, e4})
l2.MoveToBack(e3) // move from front
checkListPointers(t, l2, []*(Element(int)){e1, e4, e3})
l2.MoveToBack(e3) // should be no-op
checkListPointers(t, l2, []*(Element(int)){e1, e4, e3})
e2 = l2.InsertBefore(2, e1) // insert before front
checkListPointers(t, l2, []*(Element(int)){e2, e1, e4, e3})
l2.Remove(e2)
e2 = l2.InsertBefore(2, e4) // insert before middle
checkListPointers(t, l2, []*(Element(int)){e1, e2, e4, e3})
l2.Remove(e2)
e2 = l2.InsertBefore(2, e3) // insert before back
checkListPointers(t, l2, []*(Element(int)){e1, e4, e2, e3})
l2.Remove(e2)
e2 = l2.InsertAfter(2, e1) // insert after front
checkListPointers(t, l2, []*(Element(int)){e1, e2, e4, e3})
l2.Remove(e2)
e2 = l2.InsertAfter(2, e4) // insert after middle
checkListPointers(t, l2, []*(Element(int)){e1, e4, e2, e3})
l2.Remove(e2)
e2 = l2.InsertAfter(2, e3) // insert after back
checkListPointers(t, 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 {
t.Errorf("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(t, l2, []*(Element(int)){})
}
func checkList(type TElem comparable)(t *testing.T, l *List(TElem), es []interface{}) {
if !checkListLen(t, l, len(es)) {
return
}
i := 0
for e := l.Front(); e != nil; e = e.Next() {
le := e.Value
if le != es[i] {
t.Errorf("elt[%d].Value = %v, want %v", i, le, es[i])
}
i++
}
}
func TestExtending(t *testing.T) {
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(t, l3, []interface{}{1, 2, 3})
l3.PushBackList(l2)
checkList(t, l3, []interface{}{1, 2, 3, 4, 5})
l3 = New(int)()
l3.PushFrontList(l2)
checkList(t, l3, []interface{}{4, 5})
l3.PushFrontList(l1)
checkList(t, l3, []interface{}{1, 2, 3, 4, 5})
checkList(t, l1, []interface{}{1, 2, 3})
checkList(t, l2, []interface{}{4, 5})
l3 = New(int)()
l3.PushBackList(l1)
checkList(t, l3, []interface{}{1, 2, 3})
l3.PushBackList(l3)
checkList(t, l3, []interface{}{1, 2, 3, 1, 2, 3})
l3 = New(int)()
l3.PushFrontList(l1)
checkList(t, l3, []interface{}{1, 2, 3})
l3.PushFrontList(l3)
checkList(t, l3, []interface{}{1, 2, 3, 1, 2, 3})
l3 = New(int)()
l1.PushBackList(l3)
checkList(t, l1, []interface{}{1, 2, 3})
l1.PushFrontList(l3)
checkList(t, l1, []interface{}{1, 2, 3})
}
func TestRemove(t *testing.T) {
l := New(int)()
e1 := l.PushBack(1)
e2 := l.PushBack(2)
checkListPointers(t, l, []*(Element(int)){e1, e2})
e := l.Front()
l.Remove(e)
checkListPointers(t, l, []*(Element(int)){e2})
l.Remove(e)
checkListPointers(t, l, []*(Element(int)){e2})
}
func TestIssue4103(t *testing.T) {
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 {
t.Errorf("l2.Len() = %d, want 2", n)
}
l1.InsertBefore(8, e)
if n := l1.Len(); n != 3 {
t.Errorf("l1.Len() = %d, want 3", n)
}
}
func TestIssue6349(t *testing.T) {
l := New(int)()
l.PushBack(1)
l.PushBack(2)
e := l.Front()
l.Remove(e)
if e.Value != 1 {
t.Errorf("e.value = %d, want 1", e.Value)
}
if e.Next() != nil {
t.Errorf("e.Next() != nil")
}
if e.Prev() != nil {
t.Errorf("e.Prev() != nil")
}
}
func TestMove(t *testing.T) {
l := New(int)()
e1 := l.PushBack(1)
e2 := l.PushBack(2)
e3 := l.PushBack(3)
e4 := l.PushBack(4)
l.MoveAfter(e3, e3)
checkListPointers(t, l, []*(Element(int)){e1, e2, e3, e4})
l.MoveBefore(e2, e2)
checkListPointers(t, l, []*(Element(int)){e1, e2, e3, e4})
l.MoveAfter(e3, e2)
checkListPointers(t, l, []*(Element(int)){e1, e2, e3, e4})
l.MoveBefore(e2, e3)
checkListPointers(t, l, []*(Element(int)){e1, e2, e3, e4})
l.MoveBefore(e2, e4)
checkListPointers(t, l, []*(Element(int)){e1, e3, e2, e4})
e2, e3 = e3, e2
l.MoveBefore(e4, e1)
checkListPointers(t, l, []*(Element(int)){e4, e1, e2, e3})
e1, e2, e3, e4 = e4, e1, e2, e3
l.MoveAfter(e4, e1)
checkListPointers(t, l, []*(Element(int)){e1, e4, e2, e3})
e2, e3, e4 = e4, e2, e3
l.MoveAfter(e2, e3)
checkListPointers(t, l, []*(Element(int)){e1, e3, e2, e4})
e2, e3 = e3, e2
}
// Test PushFront, PushBack, PushFrontList, PushBackList with uninitialized List
func TestZeroList(t *testing.T) {
var l1 = new(List(int))
l1.PushFront(1)
checkList(t, l1, []interface{}{1})
var l2 = new(List(int))
l2.PushBack(1)
checkList(t, l2, []interface{}{1})
var l3 = new(List(int))
l3.PushFrontList(l1)
checkList(t, l3, []interface{}{1})
var l4 = new(List(int))
l4.PushBackList(l2)
checkList(t, 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(t *testing.T) {
var l List(int)
l.PushBack(1)
l.PushBack(2)
l.PushBack(3)
l.InsertBefore(1, new(Element(int)))
checkList(t, &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(t *testing.T) {
var l List(int)
l.PushBack(1)
l.PushBack(2)
l.PushBack(3)
l.InsertAfter(1, new(Element(int)))
checkList(t, &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(t *testing.T) {
var l1 List(int)
e1 := l1.PushBack(1)
var l2 List(int)
e2 := l2.PushBack(2)
l1.MoveAfter(e1, e2)
checkList(t, &l1, []interface{}{1})
checkList(t, &l2, []interface{}{2})
l1.MoveBefore(e1, e2)
checkList(t, &l1, []interface{}{1})
checkList(t, &l2, []interface{}{2})
}
// Test the Transform function.
func TestTransform(t *testing.T) {
l1 := New(int)()
l1.PushBack(1)
l1.PushBack(2)
l2 := Transform(l1, strconv.Itoa)
checkList(t, l2, []interface{}{"1", "2"})
}