Algae.Tree.BinarySearch (Algae v1.3.1) View Source

Represent a BinarySearch tree.

Examples

iex> alias Algae.Tree.BinarySearch, as: BSTree
...>
...> BSTree.Node.new(
...>   42,
...>   BSTree.Node.new(77),
...>   BSTree.Node.new(
...>     1234,
...>     BSTree.Node.new(98),
...>     BSTree.Node.new(32)
...>   )
...> )
%Algae.Tree.BinarySearch.Node{
  node: 42,
  left: %Algae.Tree.BinarySearch.Node{
    node:  77,
    left:  %Algae.Tree.BinarySearch.Empty{},
    right: %Algae.Tree.BinarySearch.Empty{}
  },
  right: %Algae.Tree.BinarySearch.Node{
    node:  1234,
    left:  %Algae.Tree.BinarySearch.Node{
      node:  98,
      left:  %Algae.Tree.BinarySearch.Empty{},
      right: %Algae.Tree.BinarySearch.Empty{}
    },
    right: %Algae.Tree.BinarySearch.Node{
      node:  32,
      left:  %Algae.Tree.BinarySearch.Empty{},
      right: %Algae.Tree.BinarySearch.Empty{}
    }
  }
}

Link to this section Summary

Types

t()

Functions

delete(tree, orderable)

Remove an element from a tree by value.

from_list(list)

Build a BinarySearch tree from a list.

from_list(list, seed)

Build a BinarySearch tree from a list and attach to an existing tree.

insert(tree, value)

Insert a new element into a tree.

new()

Create an empty tree.

new(value)

Bring a value into an otherwise empty tree.

to_list(tree)

Flatten a tree into a list.

to_ordered_list(tree)

Flatten a tree into a list with elements sorted.

Link to this section Types

t()

Specs

t() :: Algae.Tree.BinarySearch.Node.t() | Algae.Tree.BinarySearch.Empty.t()

Link to this section Functions

delete(tree, orderable)

Specs

delete(t(), any()) :: t()

Remove an element from a tree by value.

Examples

iex> alias Algae.Tree.BinarySearch, as: BSTree
...>
...> BSTree.Node.new(
...>   42,
...>   BSTree.Node.new(77),
...>   BSTree.Node.new(
...>     1234,
...>     BSTree.Node.new(98),
...>     BSTree.Node.new(32)
...>   )
...> ) |> delete(98)
%Algae.Tree.BinarySearch.Node{
  node: 42,
  left: %Algae.Tree.BinarySearch.Node{
    node: 77
  },
  right: %Algae.Tree.BinarySearch.Node{
    node: 1234,
    right: %Algae.Tree.BinarySearch.Node{
      node: 32
    }
  }
}

from_list(list)

Specs

from_list(list()) :: t()

Build a BinarySearch tree from a list.

Examples

iex> Algae.Tree.BinarySearch.from_list([42, 77, 1234, 98, 32])
%Algae.Tree.BinarySearch.Node{
  node: 42,
  left: %Algae.Tree.BinarySearch.Node{
    node:  32
  },
  right: %Algae.Tree.BinarySearch.Node{
    node: 77,
    right: %Algae.Tree.BinarySearch.Node{
      node: 1234,
      left: %Algae.Tree.BinarySearch.Node{
        node:  98
      }
    }
  }
}

from_list(list, seed)

Specs

from_list(list(), t()) :: t()

Build a BinarySearch tree from a list and attach to an existing tree.

Examples

iex> Algae.Tree.BinarySearch.from_list([42, 77, 1234, 98, 32], new(-9))
%Algae.Tree.BinarySearch.Node{
  node:  -9,
  right: %Algae.Tree.BinarySearch.Node{
    left: %Algae.Tree.BinarySearch.Node{
      node:  32
    },
    node: 42,
    right: %Algae.Tree.BinarySearch.Node{
      node: 77,
      right: %Algae.Tree.BinarySearch.Node{
        node: 1234,
        left: %Algae.Tree.BinarySearch.Node{
          node: 98
        },
        right: %Algae.Tree.BinarySearch.Empty{}
      }
    }
  }
}

insert(tree, value)

Specs

insert(t(), any()) :: t()

Insert a new element into a tree.

Examples

iex> insert(new(42), 43)
%Algae.Tree.BinarySearch.Node{
  node: 42,
  right: %Algae.Tree.BinarySearch.Node{
    node: 43
  }
}

new()

Specs

new() :: t()

new() :: Algae.Tree.BinarySearch.Empty.t()

Create an empty tree.

Examples

iex> new()
%Algae.Tree.BinarySearch.Empty{}

new(value)

Specs

new(any()) :: Algae.Tree.BinarySearch.Node.t()

Bring a value into an otherwise empty tree.

Examples

iex> new(42)
%Algae.Tree.BinarySearch.Node{
  node:  42,
  left:  %Algae.Tree.BinarySearch.Empty{},
  right: %Algae.Tree.BinarySearch.Empty{}
}

to_list(tree)

Specs

to_list(t()) :: list()

Flatten a tree into a list.

Examples

iex> alias Algae.Tree.BinarySearch, as: BSTree
...>
...> BSTree.Node.new(
...>   42,
...>   BSTree.Node.new(77),
...>   BSTree.Node.new(
...>     1234,
...>     BSTree.Node.new(98),
...>     BSTree.Node.new(32)
...>   )
...> )
...> |> BSTree.to_list()
[42, 77, 1234, 98, 32]

to_ordered_list(tree)

Specs

to_ordered_list(t()) :: list()

Flatten a tree into a list with elements sorted.

Examples

iex> alias Algae.Tree.BinarySearch, as: BSTree
...>
...> BSTree.Node.new(
...>   42,
...>   BSTree.Node.new(77),
...>   BSTree.Node.new(
...>     1234,
...>     BSTree.Node.new(98),
...>     BSTree.Node.new(32)
...>   )
...> )
...> |> BSTree.to_ordered_list()
[32, 42, 77, 98, 1234]