Empty

com.phasmidsoftware.lascala.tree.Empty
case object Empty extends AbstractEmpty

Empty object which is necessary for (non-ideal) BinaryTrees. There should be no need for a GeneralTree to reference an Empty but it might happen.

Attributes

Graph
Supertypes
trait Singleton
trait Product
trait Mirror
trait Serializable
trait Product
trait Equals
trait Tree[Nothing]
trait Node[Nothing]
class Object
trait Matchable
class Any
Show all
Self type
Empty.type

Members list

Type members

Inherited types

type MirroredElemLabels = EmptyTuple

The names of the product elements.

The names of the product elements.

Attributes

Inherited from:
Singleton
type MirroredElemTypes = EmptyTuple

Attributes

Inherited from:
Singleton
type MirroredMonoType = this.type

The mirrored *-type.

The mirrored *-type.

Attributes

Inherited from:
Singleton
type MirroredType = this.type

Attributes

Inherited from:
Singleton

Inherited and Abstract types

type MirroredLabel <: String

The name of the type.

The name of the type.

Attributes

Inherited from:
Mirror

Value members

Inherited methods

def +[B >: Nothing : TreeBuilder](b: B): Tree[B]

Method to add the given node to this node

Method to add the given node to this node

Type parameters

B

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

Value parameters

b

the value to add, as a Leaf

Attributes

Returns

the resulting tree

Inherited from:
Tree
def +[B >: Nothing : TreeBuilder](node: Node[B]): Tree[B]

Method to add the given node to this node.

Method to add the given node to this node.

Type parameters

B

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

Value parameters

node

the node to add

Attributes

Returns

the resulting tree

Inherited from:
Tree
def children: List[Tree[Nothing]]

Attributes

Returns

the immediate descendants (children) of this branch

Inherited from:
AbstractEmpty
def compareValues[B >: Nothing](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 depth: Int

NOTE: that this is NOT tail-recursive

NOTE: that this is NOT tail-recursive

NOTE: I don't think we can use Parent.traverse for depth. Could be wrong.

Attributes

Returns

the depth of the subtree

Inherited from:
Tree
def filter[B >: Nothing](p: Node[B] => Boolean): Iterator[Node[B]]

Attributes

Inherited from:
Tree
def find[B >: Nothing](p: Node[B] => Boolean): Option[Node[B]]

Type parameters

B

the type of b

Value parameters

p

the predicate to be applied to the value of each node in turn (depth first)

Attributes

Returns

Some(node) where node is the first node to be found that satisfies the predicate p

Inherited from:
Tree
def find[B >: Nothing](b: B): Option[Node[B]]

Type parameters

B

the type of b

Value parameters

b

value to be found, looking at the value of each node in turn (depth first)

Attributes

Returns

Some(node) where node is the first node to be found with value b

Inherited from:
Tree
def fromProduct(p: Product): MirroredMonoType

Creates a new instance of type T with elements taken from product p.

Creates a new instance of type T with elements taken from product p.

Attributes

Inherited from:
Singleton
def get: None.type

Attributes

Returns

the value of this node, if any

Inherited from:
AbstractEmpty
def includes[B >: Nothing](subtree: B, element: B): Boolean

Determine if this tree has a subtree matching b which includes c

Determine if this tree has a subtree matching b which includes c

Type parameters

B

the type of subtree and element

Value parameters

element

the value of the element to be found in the subtree

subtree

the value of the subtree to be searched

Attributes

Returns

true if value element is found in the sub-tree defined by subtree

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

Method to determine if this Tree includes the given node

Method to determine if this Tree includes the given node

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:
Tree
def includesValue[B >: Nothing](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 back to just includes (as it was previously)

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:
Tree
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 iterator(depthFirst: Boolean = ...): Iterator[Nothing]

Iterate on the values of this tree

Iterate on the values of this tree

Value parameters

depthFirst

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

Attributes

Returns

an iterator of values

Inherited from:
Tree
def like[B >: Nothing](node: Node[B]): Maybe

Method to determine if this subtree is "like" the given node (without recursion)

Method to determine if this subtree is "like" the given node (without recursion)

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:
Tree
def nodeIterator(depthFirst: Boolean): Iterator[Node[Nothing]]

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:
AbstractEmpty
def productElementNames: Iterator[String]

An iterator over the names of all the elements of this product.

An iterator over the names of all the elements of this product.

Attributes

Inherited from:
Product
def productIterator: Iterator[Any]

An iterator over all the elements of this product.

An iterator over all the elements of this product.

Attributes

Returns

in the default implementation, an Iterator[Any]

Inherited from:
Product
def replaceNode[B >: Nothing : 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
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:
Tree
def summary: String

Create a String which represents the value of this Node and the values of its immediate descendants

Create a String which represents the value of this Node and the values of its immediate descendants

Attributes

Returns

an appropriate String

Inherited from:
Tree