.\" 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 "Devel::MAT::Graph 3pm" .TH Devel::MAT::Graph 3pm "2023-03-26" "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" "Devel::MAT::Graph" \- a set of references between related SVs .SH "DESCRIPTION" .IX Header "DESCRIPTION" Instances of this class represent an entire graph of references between related SVs, as a helper method for return values from various Devel::MAT methods, which might be used for some sort of screen layout or other analysis tasks. .SH "CONSTRUCTOR" .IX Header "CONSTRUCTOR" .SS "new" .IX Subsection "new" .Vb 1 \& $graph = Devel::MAT::Graph\->new( $dumpfile ) .Ve .PP Constructs a new \f(CW\*(C`Devel::MAT::Graph\*(C'\fR instance backed by the given dumpfile (which is only actually used to make the \f(CW\*(C`$node\->sv\*(C'\fR method work). .SH "MUTATION METHODS" .IX Header "MUTATION METHODS" .SS "add_sv" .IX Subsection "add_sv" .Vb 1 \& $graph\->add_sv( $sv ) .Ve .PP Makes the graph aware of the given Devel::MAT::SV. This is not strictly necessary before calling \f(CW\*(C`add_ref\*(C'\fR or \f(CW\*(C`add_root\*(C'\fR, but ensures that \f(CW\*(C`has_sv\*(C'\fR will return true immediately after it, and so can be used as a sentinel for recursion control. .SS "add_ref" .IX Subsection "add_ref" .Vb 1 \& $graph\->add_ref( $from_sv, $to_sv, $desc ) .Ve .PP Adds an edge to the graph, from and to the given SVs, with the given description. .SS "add_root" .IX Subsection "add_root" .Vb 1 \& $graph\->add_root( $from_sv, $desc ) .Ve .PP Adds a root edge to the graph, at the given \s-1SV\s0 with the given description. .SH "QUERY METHODS" .IX Header "QUERY METHODS" .SS "has_sv" .IX Subsection "has_sv" .Vb 1 \& $bool = $graph\->has_sv( $sv ) .Ve .PP Returns true if the graph has edges or roots for the given \s-1SV,\s0 or it has at least been given to \f(CW\*(C`add_sv\*(C'\fR. .SS "get_sv_node" .IX Subsection "get_sv_node" .Vb 1 \& $node = $graph\->get_sv_node( $sv ) .Ve .PP Returns a \f(CW\*(C`Node\*(C'\fR object for the given \s-1SV.\s0 .SS "get_root_nodes" .IX Subsection "get_root_nodes" .Vb 1 \& @desc_nodes = $graph\->get_root_nodes .Ve .PP Returns an even-sized list of pairs, containing root descriptions and the nodes having those roots, in no particular order. .SH "NODE OBJECTS" .IX Header "NODE OBJECTS" The values returned by \f(CW\*(C`get_sv_node\*(C'\fR respond to the following methods: .SS "graph" .IX Subsection "graph" .Vb 1 \& $graph = $node\->graph .Ve .PP Returns the containing \f(CW\*(C`Devel::MAT::Graph\*(C'\fR instance. .SS "addr" .IX Subsection "addr" .Vb 1 \& $addr = $node\->addr .Ve .PP Returns the address of the \s-1SV\s0 represented by this node. .SS "sv" .IX Subsection "sv" .Vb 1 \& $sv = $node\->sv .Ve .PP Returns the \s-1SV\s0 object itself, as taken from the dumpfile instance. .SS "roots" .IX Subsection "roots" .Vb 1 \& @roots = $node\->roots .Ve .PP Returns any root descriptions given (by calls to \f(CW\*(C`$graph\->add_root\*(C'\fR for the \s-1SV\s0 at this node. .PP .Vb 1 \& $graph\->add_root( $sv, $desc ); \& \& ( $desc, ... ) = $graph\->get_sv_node( $sv )\->roots .Ve .SS "edges_out" .IX Subsection "edges_out" .Vb 1 \& @edges = $node\->edges_out .Ve .PP Returns an even-sized list of any edge descriptions and more \f(CW\*(C`Node\*(C'\fR objects given as references (by calls to \f(CW\*(C`$graph\->add_ref\*(C'\fR) from the \s-1SV\s0 at this node. .PP .Vb 1 \& $graph\->add_ref( $from_sv, $to_sv, $desc ) \& \& ( $desc, $to_edge, ... ) = $graph\->get_sv_node( $from_sv )\->edges_out .Ve .SS "edges_out (scalar)" .IX Subsection "edges_out (scalar)" .Vb 1 \& $n_edges = $node\->edges_out .Ve .PP In scalar context, returns the \fInumber of edges\fR that exist; i.e. half the size of the pairlist that would be returned in list context. .SS "edges_in" .IX Subsection "edges_in" .Vb 1 \& @edges = $node\->edges_in .Ve .PP Similar to \f(CW\*(C`edges_out\*(C'\fR, but returns edges in the opposite direction; i.e. edges of references to this node. .PP .Vb 1 \& $graph\->add_ref( $from_sv, $to_sv, $desc ) \& \& ( $desc, $from_edge, ... ) = $graph\->get_sv_node( $to_sv )\->edges_in .Ve .SS "edges_in (scalar)" .IX Subsection "edges_in (scalar)" .Vb 1 \& $n_edges = $node\->edges_out .Ve .PP In scalar context, returns the \fInumber of edges\fR that exist; i.e. half the size of the pairlist that would be returned in list context. .SH "AUTHOR" .IX Header "AUTHOR" Paul Evans