TreeOps

TreeOps is a type class for abstracting over arbitrary trees, allowing traversal and data access. In general, it assumes that we can quickly access the children and label of any given node.

There are some convenience implicit methods added onto trees and nodes that can be accessed by importing tree ops. For instance, say we wanted to add an implicit method to any type of tree that let's us find some node in a tree.

implicit class NodeFinder[T](tree: T)(implicit treeOps: TreeOps[T]) {

// Brings in Node/Label types, and implicit classes.
import treeOps._

// Returns the first node (DFS) where the predicate is true.
def find(f: Label => Boolean): Option[Node] = {
  def recur(node: Node): Option[Node] = {
    // treeOps.TreeNodeOps brings in the Node#label implicit method.
    if (f(node.label)) {
      node
    } else {
      // treeOps.TreeNodeOps also brings in Node#children implicit method.
      node.children.iterator.map(recur).find(_.isDefined).flatten
    }
  }

  // treeOps.TreeTreeOps brings in T#root.
  recur(tree.root)
}
}

Self Type: TreeOps[Tree, Label]

Linear Supertypes

AnyRef, Any

Known Subclasses

FullBinaryTreeOps

Type Members

abstract type Node

The type of the nodes in the tree.
implicit class OpsForNode extends AnyRef
implicit class OpsForTree extends AnyRef

Abstract Value Members

abstract def children(node: Node): Iterable[Node]

Returns all the direct children of the given node.
Returns all the direct children of the given node. The order may or may not matter. TreeOps does not provide any guarantees here.
abstract def label(node: Node): Label

Returns the label attached to the given node.
abstract def root(t: Tree): Option[Node]

Returns the root node of the tree.

Concrete Value Members

final def !=(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def !=(arg0: Any): Boolean

Definition Classes
Any
final def ##(): Int

Definition Classes
AnyRef → Any
final def ==(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def ==(arg0: Any): Boolean

Definition Classes
Any
final def asInstanceOf[T0]: T0

Definition Classes
Any
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def equals(arg0: Any): Boolean

Definition Classes
AnyRef → Any
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
def fold[A](tree: Tree)(f: (Label, Iterable[Node]) ⇒ A): Option[A]
def fold[A](node: Node)(f: (Label, Iterable[Node]) ⇒ A): A
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
def hashCode(): Int

Definition Classes
AnyRef → Any
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
def reduce[A](tree: Tree)(f: (Label, Iterable[A]) ⇒ A): Option[A]
def reduce[A](node: Node)(f: (Label, Iterable[A]) ⇒ A): A
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toString(): String

Definition Classes
AnyRef → Any
final def wait(): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long, arg1: Int): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )

trait TreeOps[Tree, Label] extends AnyRef

Type Members

abstract type Node

implicit class OpsForNode extends AnyRef

implicit class OpsForTree extends AnyRef

Abstract Value Members

abstract def children(node: Node): Iterable[Node]

abstract def label(node: Node): Label

abstract def root(t: Tree): Option[Node]

Concrete Value Members

final def !=(arg0: AnyRef): Boolean

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: AnyRef): Boolean

final def ==(arg0: Any): Boolean

final def asInstanceOf[T0]: T0

def clone(): AnyRef

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def finalize(): Unit

def fold[A](tree: Tree)(f: (Label, Iterable[Node]) ⇒ A): Option[A]

def fold[A](node: Node)(f: (Label, Iterable[Node]) ⇒ A): A

final def getClass(): Class[_]

def hashCode(): Int

final def isInstanceOf[T0]: Boolean

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

def reduce[A](tree: Tree)(f: (Label, Iterable[A]) ⇒ A): Option[A]

def reduce[A](node: Node)(f: (Label, Iterable[A]) ⇒ A): A

final def synchronized[T0](arg0: ⇒ T0): T0

def toString(): String

final def wait(): Unit

final def wait(arg0: Long, arg1: Int): Unit

final def wait(arg0: Long): Unit

Inherited from AnyRef

Inherited from Any

Ungrouped