View Source UnrootedPolytree.Node (UnrootedPolytree v0.1.1)

A node in an UnrootedPolytree. Contains any value, and a unique string ID.

Link to this section Summary

id()

t()

Constructs a Node given an ID string and any value.

id(node)

Returns the ID string of this node.

value(node)

Returns the value of this node.

@type id() :: String.t()

@type t() :: %UnrootedPolytree.Node{id: id(), value: any()}

@spec from_id_and_value(id(), any()) :: t()

Constructs a Node given an ID string and any value.

iex> UnrootedPolytree.Node.from_id_and_value("a", %{foo: "bar"}) %UnrootedPolytree.Node{id: "a", value: %{foo: "bar"}}

@spec id(t()) :: id()

Returns the ID string of this node.

iex> UnrootedPolytree.Node.id(%UnrootedPolytree.Node{id: "a", value: %{foo: "bar"}}) "a"

@spec value(t()) :: any()

Returns the value of this node.

iex> UnrootedPolytree.Node.value(%UnrootedPolytree.Node{id: "a", value: %{foo: "bar"}}) %{foo: "bar"}