StructuralNode

com.phasmidsoftware.lascala.tree.StructuralNode
sealed trait StructuralNode[K, +A] extends Node[A]

Defines a Node in a tree where the value of any node determines its place within the tree.

CONSIDER do we really need A to be covariant?

Type parameters

A

the underlying type of the tree/node

K

the key type

Attributes

Graph
Supertypes
trait Node[A]
class Object
trait Matchable
class Any
Known subtypes
trait StructuralTree[K, A]
class KVTree[K, V]
class GeneralKVTree[K, V]

Members list

Value members

Concrete methods

def key[B >: A](implicit vo: ValueOps[K, B]): Option[K]

Method to get the key for this StructuralNode

Method to get the key for this StructuralNode

Type parameters

B

the underlying type of the node to be added (and the tree to be returned)

Value parameters

vo

the (implicit) ValueOps that is used to determine the proper tree position of this node

Attributes

Returns

the key based on value rather than tree position

Inherited methods

def compareValues[B >: A](n: Node[B]): Maybe

Method to determine if this Node's value is equal to node n's value WITHOUT any recursion.

Method to determine if this Node's value is equal to node n's value WITHOUT any recursion.

Type parameters

B

the underlying type of n

Value parameters

n

the node to be compared

Attributes

Returns

true if this is "like" n

Inherited from:
Node
def isLeaf: Boolean

Method to determine if this Node is a leaf or a branch node

Method to determine if this Node is a leaf or a branch node

Attributes

Returns

true if this Node is a leaf

Inherited from:
Node
def replaceNode[B >: A : TreeBuilder](x: Node[B], y: Node[B])(f: (Node[B], Node[B]) => Boolean): Tree[B]

Method to replace a particular node in this tree with another node, but otherwise return a copy of this tree.

Method to replace a particular node in this tree with another node, but otherwise return a copy of this tree.

CONSIDER moving this into Tree since it isn't really a Node method

Type parameters

B

the underlying type of the new node (and the resulting tree)

Value parameters

f

function to determine if two nodes are the same

x

the node to be replaced with y

y

the node to replace x

Attributes

Returns

the resulting tree

Inherited from:
Node

Inherited and Abstract methods

def depth: Int

Method to determine the depth of the tree headed by this Node. Ideally, we would put this method into Tree, but because of the specific (non-tail-recursive) implementation, it is actually more logical to declare it here.

Method to determine the depth of the tree headed by this Node. Ideally, we would put this method into Tree, but because of the specific (non-tail-recursive) implementation, it is actually more logical to declare it here.

Attributes

Returns

the maximum depth of the tree headed by this Node

Inherited from:
Node
def get: Option[A]

Attributes

Returns

the value of this node, if any

Inherited from:
Node
def includes[B >: A](node: Node[B]): Boolean

Method to determine if this Node includes the given node in its subtree (if any)

Method to determine if this Node includes the given node in its subtree (if any)

Type parameters

B

the underlying type of n

Value parameters

node

the node to be searched for

Attributes

Returns

true if node n is found in the sub-tree defined by this

Inherited from:
Node
def includesValue[B >: A](b: B): Boolean

Determine if this subtree includes a value equal to b

Determine if this subtree includes a value equal to b

CONSIDER renaming this as includes

Type parameters

B

the type of b

Value parameters

b

the value to be searched

Attributes

Returns

true if value b is found in the sub-tree defined by this

Inherited from:
Node
def nodeIterator(depthFirst: Boolean = ...): Iterator[Node[A]]

Iterate on the nodes which are the descendants of this node (including this node at start or end of result)

Iterate on the nodes which are the descendants of this node (including this node at start or end of result)

Value parameters

depthFirst

if true then we iterate depth-first, else breadth-first (defaults to true)

Attributes

Returns

an iterator of nodes

Inherited from:
Node
def size: Int

Calculate the size of this node's subtree

Calculate the size of this node's subtree

Attributes

Returns

the size of the subtree

Inherited from:
Node