https://github.com/iboard/tree_map

An Elixir module to handle a tree of data
https://github.com/iboard/tree_map

Last synced: about 1 year ago
JSON representation

An Elixir module to handle a tree of data

• Host: GitHub
• URL: https://github.com/iboard/tree_map
• Owner: iboard
• License: other
• Created: 2023-09-15T11:48:02.000Z (almost 3 years ago)
• Default Branch: main
• Last Pushed: 2023-09-18T06:12:26.000Z (almost 3 years ago)
• Last Synced: 2025-04-04T08:08:51.466Z (about 1 year ago)
• Language: Elixir
• Size: 11.7 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE.md

Awesome Lists containing this project

README

          
# README 

## TreeMap 0.1

[![Elixir CI](https://github.com/iboard/tree_map/actions/workflows/elixir.yml/badge.svg)](https://github.com/iboard/tree_map/actions/workflows/elixir.yml)

[![Package version](http://img.shields.io/hexpm/v/tree_map.svg?style=flat)](https://hex.pm/packages/tree_map)

[![Package documentation](http://img.shields.io/badge/hex.pm-docs-green.svg?style=flat)](https://hexdocs.pm/tree_map)

A module to maintain a tree of the structure `TreeMap.Node` and to start root-nodes as 

supervised children of `TreeMap.RootServer`.

### Node Structure

```elixir

  %Node{ key: ..., value: ..., children: [%Node{},...]}

```

### Function to traverse `%Node{}`

```elixir

 root =

   TreeMap.new("1", "Root")

   |> TreeMap.add_child("1.1", "Sub One", [TreeMap.new("1.1.1", "SomeSubSub")])

   |> TreeMap.add_child("1.2", "Sub Two", [TreeMap.new("1.2.1", "Some other SubSub")])

 expected = ["1", "1.1", "1.1.1", "1.2", "1.2.1"]

 received =

   TreeMap.transduce(root, [], fn a, x -> a ++ [x] end, fn n, acc -> [n | acc] end)

   |> Enum.map(& &1.key)

 assert expected == received

```

### RootServer

`TreeMap.RootServer` is a `DynamicSupervisor` that can be used to maintain a tree of `TreeMap` nodes.

    iex> TreeMap.start_root_node("A", "Root")

    {:ok, pid}

    iex> TreeMap.list_roots()

    [%Node{}, ...]

    iex> TreeMap.find("key")

    %Node{}

    iex> TreeMap.drop_all()

    [:ok, ...]

## Installation

[Available in Hex](https://hex.pm/packages/tree_map), the package can be 

installed by adding `tree_map` to your list of dependencies in `mix.exs`:

```elixir

def deps do

  [

    {:tree_map, "~> 0.1.0"}

  ]

end

```