summaryrefslogtreecommitdiff
path: root/test/files/scalacheck/avl.scala
blob: 4cfacaf407c6e6024eca2d5062719e011a78cccf (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
import org.scalacheck.Gen
import org.scalacheck.Prop.forAll
import org.scalacheck.Properties

package scala.collection.mutable {

  /**
   * Property of an AVL Tree : Any node of the tree has a balance value beetween in [-1; 1]
   */
  abstract class AVLTreeTest(name: String) extends Properties(name) {

    def `2^`(n: Int) = (1 to n).fold(1)((a, b) => b*2)

    def capacityMax(depth: Int): Int = `2^`(depth+1) - 1

    def minDepthForCapacity(x: Int): Int = {
      var depth = 0
      while(capacityMax(depth) < x)
        depth += 1
      depth
    }

    def numberOfElementsInLeftSubTree(n: Int): collection.immutable.IndexedSeq[Int] = {
      val mid = n/2 + n%2
      ((1 until mid)
        .filter { i => math.abs(minDepthForCapacity(i) - minDepthForCapacity(n-i)) < 2 }
          .flatMap { i => Seq(i, n-(i+1)) }).toIndexedSeq.distinct
    }

    def makeAllBalancedTree[A](elements: List[A]): List[AVLTree[A]] = elements match {
      case Nil => Leaf::Nil
      case first::Nil => Node(first, Leaf, Leaf)::Nil
      case first::second::Nil => Node(second, Node(first, Leaf, Leaf), Leaf)::Node(first, Leaf, Node(second, Leaf, Leaf))::Nil
      case first::second::third::Nil => Node(second, Node(first, Leaf, Leaf), Node(third, Leaf, Leaf))::Nil
      case _ => {
        val combinations = for {
          left <- numberOfElementsInLeftSubTree(elements.size)
          root = elements(left)
          right = elements.size - (left + 1)
        } yield (root, left, right)
        (combinations.flatMap(triple => for {
          l <- makeAllBalancedTree(elements.take(triple._2))
          r <- makeAllBalancedTree(elements.takeRight(triple._3))
        } yield Node(triple._1, l, r))).toList
      }
    }

    def genInput: org.scalacheck.Gen[(Int, List[AVLTree[Int]])] = for {
      size <- org.scalacheck.Gen.choose(20, 25)
      elements <- org.scalacheck.Gen.listOfN(size, org.scalacheck.Gen.choose(0, 1000))
      selected <- org.scalacheck.Gen.choose(0, 1000)
    } yield {
      // selected mustn't be in elements already
      val list = makeAllBalancedTree(elements.sorted.distinct.map(_*2))
      (selected*2+1, list)
    }

    def genInputDelete: org.scalacheck.Gen[(Int, List[AVLTree[Int]])] = for {
      size <- org.scalacheck.Gen.choose(20, 25)
      elements <- org.scalacheck.Gen.listOfN(size, org.scalacheck.Gen.choose(0, 1000))
      e = elements.sorted.distinct
      selected <- org.scalacheck.Gen.choose(0, e.size-1)
    } yield {
      // selected must be in elements already
      val list = makeAllBalancedTree(e)
      (e(selected), list)
    }
  }

  trait AVLInvariants {
    self: AVLTreeTest =>

    def isBalanced[A](t: AVLTree[A]): Boolean = t match {
      case node: Node[A] => math.abs(node.balance) < 2 && (List(node.left, node.right) forall isBalanced)
      case Leaf => true
    }

    def setup(invariant: AVLTree[Int] => Boolean) = forAll(genInput) {
      case (selected: Int, trees: List[AVLTree[Int]]) =>
      trees.map(tree => invariant(tree)).fold(true)((a, b) => a && b)
    }

    property("Every tree is initially balanced.") = setup(isBalanced)
  }

  object TestInsert extends AVLTreeTest("Insert") with AVLInvariants {
    import math.Ordering.Int
    property("`insert` creates a new tree containing the given element. The tree remains balanced.") = forAll(genInput) {
      case (selected: Int, trees: List[AVLTree[Int]]) =>
      trees.map(tree => {
        val modifiedTree = tree.insert(selected, Int)
        modifiedTree.contains(selected, Int) && isBalanced(modifiedTree)
      }).fold(true)((a, b) => a && b)
    }
  }

  object TestRemove extends AVLTreeTest("Remove") with AVLInvariants {
    import math.Ordering.Int
    property("`remove` creates a new tree without the given element. The tree remains balanced.") = forAll(genInputDelete) {
      case (selected: Int, trees: List[AVLTree[Int]]) =>
      trees.map(tree => {
        val modifiedTree = tree.remove(selected, Int)
        tree.contains(selected, Int) && !modifiedTree.contains(selected, Int) && isBalanced(modifiedTree)
      }).fold(true)((a, b) => a && b)
    }
  }
}

object Test extends Properties("AVL") {
  include(scala.collection.mutable.TestInsert)
  include(scala.collection.mutable.TestRemove)
}