Graph:...:Chain(3pm)

💖 Graph:...:Chain(3pm) 💖

hiii bestie, this one's from the User Contributed Perl Documentation corner of the universe. It's Graph:...:Chain(3pm) and it's all about a chain of nodes for the layouter. Let's get into it ✨

---

✨ NAME ✨

Graph::Easy::Layout::Chain — chain of nodes for the layouter. That's it. That's the name. 💅

---

🌈 SYNOPSIS 🌈

okay so first thing: used internally, do not use directly. Not me warning you, the source said it. 🙈

        # used internally, do not use directly

        use Graph::Easy;
        use Graph::Easy::Layout::Chain;

        my $graph = Graph::Easy->new( );
        my ($node, $node2) = $graph->add_edge( 'A', 'B' );

        my $chain = Graph::Easy::Layout::Chain->new(
                start => $node,
                graph => $graph, );

        $chain->add_node( $node2 );

---

🦋 DESCRIPTION 🦋

A Graph::Easy::Layout::Chain object is literally a chain of nodes for the layouter. It's giving linked-list energy but for graph layout. 💖

---

👑 METHODS 👑

✨ new() ✨

my $chain = Graph::Easy::Layout::Chain->new( start => $node );

Create a new chain and set its starting node to $node. Slay.

🌸 length() 🌸

my $len = $chain->length();

Return the length of the chain, in nodes. Simple.

my $len = $chain->length( $node );

Given an optional $node as argument, returns the length from that node onwards. For the chain with the three nodes A, B and C would return 3, 2, and 1 for A, B and C, respectively.

Returns 0 if the passed node is not part of this chain. No cap.

🎀 nodes() 🎀

my @nodes = $chain->nodes();

Return all the node objects in the chain as list, in order. Periodt.

💅 add_node() 💅

$chain->add_node( $node );

Add $node to the end of the chain. Easy.

🫶 start() 🫶

my $node = $chain->start();

Return first node in the chain.

💜 end() 💜

my $node = $chain->end();

Return last node in the chain.

🔥 layout() 🔥

my $todo = $chain->layout();

Return an action stack as array ref, containing the nec. actions to layout the chain (nodes, plus interlinks in the chain).

Will recursively traverse all chains linked to this chain. It's giving recursion, bestie.

🌈 merge() 🌈

my $chain->merge ( $other_chain );
my $chain->merge ( $other_chain, $where );

Merge the other chain into ourselves, adding its nodes at our end. The other chain is emptied and must be deleted by the caller.

If $where is defined and a member of $other_chain, absorb only the nodes from $where onwards, instead of all of them. Important: caller cleanup, fr fr.

💀 error() 💀

$last_error = $node->error();

$node->error($error);                   # set new messages
$node->error('');                       # clear error

Returns the last error message, or '' for no error. Yep, the code says $node even in the chain page — copy it exactly, iykyk.

🍓 dump() 🍓

$chain->dump();

Dump the chain to STDERR, to aid debugging. When you need to see the tea. 🫖

---

🌟 EXPORT 🌟

None by default. That's it. Nothing exported. Iconic minimalism. ✨

---

🔗 SEE ALSO 🔗

• Graph::Easy
• Graph::Easy::Layout

---

📜 AUTHOR 📜

Copyright (C) 2004 - 2006 by Tels <http://bloodgate.com>.

See the LICENSE file for more details.

---

mwah 💋 this whole thing is perl v5.36.0, dated 2022-11-20, and it's the Graph:...:Chain(3pm) manual. bye bestie 🫶