.\" Automatically generated by Pod::Man 2.1801 (Pod::Simple 3.05)
.\"
.\" 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" ''
'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 turned on, 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.
.ie \nF \{\
.    de IX
.    tm Index:\\$1\t\\n%\t"\\$2"
..
.    nr % 0
.    rr F
.\}
.el \{\
.    de IX
..
.\}
.\"
.\" 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 "Cycle 3pm"
.TH Cycle 3pm "2006-08-07" "perl v5.10.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"
Test::Memory::Cycle \- Check for memory leaks and circular memory references
.SH "VERSION"
.IX Header "VERSION"
Version 1.04
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
Perl's garbage collection has one big problem: Circular references
can't get cleaned up.  A circular reference can be as simple as two
reference that refer to each other:
.PP
.Vb 3
\&    my $mom = {
\&        name => "Marilyn Lester",
\&    };
\&
\&    my $me = {
\&        name => "Andy Lester",
\&        mother => $mom,
\&    };
\&    $mom\->{son} = $me;
.Ve
.PP
\&\f(CW\*(C`Test::Memory::Cycle\*(C'\fR is built on top of \f(CW\*(C`Devel::Cycle\*(C'\fR to give
you an easy way to check for these circular references.
.PP
.Vb 1
\&    use Test::Memory::Cycle;
\&
\&    my $object = new MyObject;
\&    # Do stuff with the object.
\&    memory_cycle_ok( $object );
.Ve
.PP
You can also use \f(CW\*(C`memory_cycle_exists()\*(C'\fR to make sure that you have a
cycle where you expect to have one.
.SH "FUNCTIONS"
.IX Header "FUNCTIONS"
.ie n .SS """memory_cycle_ok( \fI$reference\fP, \fI$msg\fP )"""
.el .SS "\f(CWmemory_cycle_ok( \fP\f(CI$reference\fP\f(CW, \fP\f(CI$msg\fP\f(CW )\fP"
.IX Subsection "memory_cycle_ok( $reference, $msg )"
Checks that \fI\f(CI$reference\fI\fR doesn't have any circular memory references.
.ie n .SS """memory_cycle_exists( \fI$reference\fP, \fI$msg\fP )"""
.el .SS "\f(CWmemory_cycle_exists( \fP\f(CI$reference\fP\f(CW, \fP\f(CI$msg\fP\f(CW )\fP"
.IX Subsection "memory_cycle_exists( $reference, $msg )"
Checks that \fI\f(CI$reference\fI\fR \fBdoes\fR have any circular memory references.
.ie n .SS """weakened_memory_cycle_ok( \fI$reference\fP, \fI$msg\fP )"""
.el .SS "\f(CWweakened_memory_cycle_ok( \fP\f(CI$reference\fP\f(CW, \fP\f(CI$msg\fP\f(CW )\fP"
.IX Subsection "weakened_memory_cycle_ok( $reference, $msg )"
Checks that \fI\f(CI$reference\fI\fR doesn't have any circular memory references, but unlike 
\&\f(CW\*(C`memory_cycle_ok\*(C'\fR this will also check for weakened cycles produced with 
Scalar::Util's \f(CW\*(C`weaken\*(C'\fR.
.ie n .SS """weakened_memory_cycle_exists( \fI$reference\fP, \fI$msg\fP )"""
.el .SS "\f(CWweakened_memory_cycle_exists( \fP\f(CI$reference\fP\f(CW, \fP\f(CI$msg\fP\f(CW )\fP"
.IX Subsection "weakened_memory_cycle_exists( $reference, $msg )"
Checks that \fI\f(CI$reference\fI\fR \fBdoes\fR have any circular memory references, but unlike 
\&\f(CW\*(C`memory_cycle_exists\*(C'\fR this will also check for weakened cycles produced with 
Scalar::Util's \f(CW\*(C`weaken\*(C'\fR.
.SH "AUTHOR"
.IX Header "AUTHOR"
Written by Andy Lester, \f(CW\*(C`<andy @ petdance.com>\*(C'\fR.
.SH "BUGS"
.IX Header "BUGS"
Please report any bugs or feature requests to
\&\f(CW\*(C`bug\-test\-memory\-cycle at rt.cpan.org\*(C'\fR, or through the web interface at
<http://rt.cpan.org/NoAuth/ReportBug.html?Queue=Test\-Memory\-Cycle>.
I will be notified, and then you'll automatically be notified of progress on
your bug as I make changes.
.SH "SUPPORT"
.IX Header "SUPPORT"
You can find documentation for this module with the perldoc command.
.PP
.Vb 1
\&    perldoc Test::Memory::Cycle
.Ve
.PP
You can also look for information at:
.IP "\(bu" 4
AnnoCPAN: Annotated \s-1CPAN\s0 documentation
.Sp
<http://annocpan.org/dist/Test\-Memory\-Cycle>
.IP "\(bu" 4
\&\s-1CPAN\s0 Ratings
.Sp
<http://cpanratings.perl.org/d/Test\-Memory\-Cycle>
.IP "\(bu" 4
\&\s-1RT:\s0 \s-1CPAN\s0's request tracker
.Sp
<http://rt.cpan.org/NoAuth/Bugs.html?Dist=Test\-Memory\-Cycle>
.IP "\(bu" 4
Search \s-1CPAN\s0
.Sp
<http://search.cpan.org/dist/Test\-Memory\-Cycle>
.SH "ACKNOWLEDGEMENTS"
.IX Header "ACKNOWLEDGEMENTS"
Thanks to the contributions of Stevan Little, and to Lincoln Stein for writing Devel::Cycle.
.SH "COPYRIGHT"
.IX Header "COPYRIGHT"
Copyright 2006, Andy Lester, All Rights Reserved.
.PP
You may use, modify, and distribute this package under the
same terms as Perl itself.