Module: Rambling::Trie::Comparable

Included in:

Nodes::Node

Defined in:

lib/rambling/trie/comparable.rb,
sig/lib/rambling/trie/comparable.rbs

Overview

Provides the comparable behavior for the trie data structure.

Instance Method Summary

• #==(other) ⇒ Boolean

  Compares two nodes.

• #children_tree ⇒ Hash[Symbol, Nodes::Node[TValue]]
• #letter ⇒ Symbol^?
• #terminal? ⇒ Boolean
• #value ⇒ TValue^?

Instance Method Details

#==(other) ⇒ Boolean

Compares two nodes.

Parameters:

• other (Nodes::Node) —

  the node to compare against.

• (Nodes::Node[TValue])

Returns:

• (Boolean) —

  true if the nodes' #letter, #terminal?, #value, and #children_tree are all equal, false otherwise.

# File 'lib/rambling/trie/comparable.rb', line 12

def == other
  letter == other.letter &&
    terminal? == other.terminal? &&
    value == other.value &&
    children_tree == other.children_tree
end

#children_tree ⇒ Hash[Symbol, Nodes::Node[TValue]]

Returns:

• (Hash[Symbol, Nodes::Node[TValue]])

# File 'sig/lib/rambling/trie/comparable.rbs', line 16

def children_tree: -> Hash[Symbol, Nodes::Node[TValue]]

#letter ⇒ Symbol^?

Returns:

• (Symbol, nil)

# File 'sig/lib/rambling/trie/comparable.rbs', line 10

def letter: -> Symbol?

#terminal? ⇒ Boolean

Returns:

• (Boolean)

# File 'sig/lib/rambling/trie/comparable.rbs', line 14

def terminal?: -> bool

#value ⇒ TValue^?

Returns:

• (TValue, nil)

# File 'sig/lib/rambling/trie/comparable.rbs', line 12

def value: -> TValue?