.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.43)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
.    \" fudge factors for nroff and troff
.if n \{\
.    ds #H 0
.    ds #V .8m
.    ds #F .3m
.    ds #[ \f1
.    ds #] \fP
.\}
.if t \{\
.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
.    ds #V .6m
.    ds #F 0
.    ds #[ \&
.    ds #] \&
.\}
.    \" simple accents for nroff and troff
.if n \{\
.    ds ' \&
.    ds ` \&
.    ds ^ \&
.    ds , \&
.    ds ~ ~
.    ds /
.\}
.if t \{\
.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
.    \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
.    \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
.    \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
.    ds : e
.    ds 8 ss
.    ds o a
.    ds d- d\h'-1'\(ga
.    ds D- D\h'-1'\(hy
.    ds th \o'bp'
.    ds Th \o'LP'
.    ds ae ae
.    ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "Graph::Easy::Layout::Chain 3pm"
.TH Graph::Easy::Layout::Chain 3pm "2022-11-20" "perl v5.36.0" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
Graph::Easy::Layout::Chain \- Chain of nodes for layouter
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\&        # 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( \*(AqA\*(Aq, \*(AqB\*(Aq );
\&
\&        my $chain = Graph::Easy::Layout::Chain\->new(
\&                start => $node,
\&                graph => $graph, );
\&
\&        $chain\->add_node( $node2 );
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
A \f(CW\*(C`Graph::Easy::Layout::Chain\*(C'\fR object represents a chain of nodes
for the layouter.
.SH "METHODS"
.IX Header "METHODS"
.SS "\fBnew()\fP"
.IX Subsection "new()"
.Vb 1
\&        my $chain = Graph::Easy::Layout::Chain\->new( start => $node );
.Ve
.PP
Create a new chain and set its starting node to \f(CW$node\fR.
.SS "\fBlength()\fP"
.IX Subsection "length()"
.Vb 1
\&        my $len = $chain\->length();
.Ve
.PP
Return the length of the chain, in nodes.
.PP
.Vb 1
\&        my $len = $chain\->length( $node );
.Ve
.PP
Given an optional \f(CW$node\fR 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.
.PP
Returns 0 if the passed node is not part of this chain.
.SS "\fBnodes()\fP"
.IX Subsection "nodes()"
.Vb 1
\&        my @nodes = $chain\->nodes();
.Ve
.PP
Return all the node objects in the chain as list, in order.
.SS "\fBadd_node()\fP"
.IX Subsection "add_node()"
.Vb 1
\&        $chain\->add_node( $node );
.Ve
.PP
Add \f(CW$node\fR to the end of the chain.
.SS "\fBstart()\fP"
.IX Subsection "start()"
.Vb 1
\&        my $node = $chain\->start();
.Ve
.PP
Return first node in the chain.
.SS "\fBend()\fP"
.IX Subsection "end()"
.Vb 1
\&        my $node = $chain\->end();
.Ve
.PP
Return last node in the chain.
.SS "\fBlayout()\fP"
.IX Subsection "layout()"
.Vb 1
\&        my $todo = $chain\->layout();
.Ve
.PP
Return an action stack as array ref, containing the nec. actions to
layout the chain (nodes, plus interlinks in the chain).
.PP
Will recursively traverse all chains linked to this chain.
.SS "\fBmerge()\fP"
.IX Subsection "merge()"
.Vb 2
\&        my $chain\->merge ( $other_chain );
\&        my $chain\->merge ( $other_chain, $where );
.Ve
.PP
Merge the other chain into ourselves, adding its nodes at our end.
The other chain is emptied and must be deleted by the caller.
.PP
If \f(CW$where\fR is defined and a member of \f(CW$other_chain\fR, absorb only the
nodes from \f(CW$where\fR onwards, instead of all of them.
.SS "\fBerror()\fP"
.IX Subsection "error()"
.Vb 1
\&        $last_error = $node\->error();
\&
\&        $node\->error($error);                   # set new messages
\&        $node\->error(\*(Aq\*(Aq);                       # clear error
.Ve
.PP
Returns the last error message, or '' for no error.
.SS "\fBdump()\fP"
.IX Subsection "dump()"
.Vb 1
\&        $chain\->dump();
.Ve
.PP
Dump the chain to \s-1STDERR,\s0 to aid debugging.
.SH "EXPORT"
.IX Header "EXPORT"
None by default.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
Graph::Easy, Graph::Easy::Layout.
.SH "AUTHOR"
.IX Header "AUTHOR"
Copyright (C) 2004 \- 2006 by Tels <http://bloodgate.com>.
.PP
See the \s-1LICENSE\s0 file for more details.