package Sub::Nary;
-use 5.008001;
+use 5.008_001;
use strict;
use warnings;
-use Carp qw/croak/;
+use Carp qw<croak>;
-use B qw/class ppname svref_2object OPf_KIDS/;
+use B qw<class ppname svref_2object OPf_KIDS>;
=head1 NAME
use Sub::Nary;
- my $sn = Sub::Nary->new();
+ my $sn = Sub::Nary->new;
my $r = $sn->nary(\&hlagh);
=head1 DESCRIPTION
-This module uses the L<B> framework to walk into subroutines and try to guess how many scalars are likely to be returned in list context. It's not always possible to give a definitive answer to this question at compile time, so the results are given in terms of "probability of return" (to be understood in a sense described below).
+This module uses the L<B> framework to walk into subroutines and try to guess how many scalars are likely to be returned in list context.
+It's not always possible to give a definitive answer to this question at compile time, so the results are given in terms of "probability of return" (to be understood in a sense described below).
=head1 METHODS
=head2 C<new>
-The usual constructor. Currently takes no argument.
+ my $sn = Sub::Nary->new;
-=head2 C<nary $coderef>
+The usual constructor.
+Currently takes no argument.
-Takes a code reference to a named or anonymous subroutine, and returns a hash reference whose keys are the possible numbers of returning scalars, and the corresponding values the "probability" to get them. The special key C<'list'> is used to denote a possibly infinite number of returned arguments. The return value hence would look at
+=head2 C<nary>
+
+ my $res = $sn->nary($coderef);
+
+Takes a reference to a named or anonymous subroutine, and returns a hash reference whose keys are the possible numbers of returning scalars, and the corresponding values the "probability" to get them.
+The special key C<'list'> is used to denote a possibly infinite number of returned arguments.
+The return value hence would look at
{ 1 => 0.2, 2 => 0.4, 4 => 0.3, list => 0.1 }
-that is, we should get C<1> scalar C<1> time over C<5> and so on. The sum of all values is C<1>. The returned result, and all the results obtained from intermediate subs, are cached into the object.
+that is, we should get C<1> scalar C<1> time over C<5> and so on.
+The sum of all values is C<1>.
+The returned result, and all the results obtained from intermediate subs, are cached into the object.
=head2 C<flush>
-Flushes the L<Sub::Nary> object cache. Returns the object itself.
+Flushes the L<Sub::Nary> object cache.
+Returns the object itself.
=head1 PROBABILITY OF RETURN
If a core function may return different numbers of scalars, each kind is considered equally possible.
-For example, C<stat> returns C<13> elements on success and C<0> on error. The according probability will then be C<< { 0 => 0.5, 13 => 0.5 } >>.
+For example, C<stat> returns C<13> elements on success and C<0> on error.
+The according probability will then be C<< { 0 => 0.5, 13 => 0.5 } >>.
=item *
my %ops;
$ops{$_} = 1 for scalops;
-$ops{$_} = 0 for qw/stub nextstate pushmark iter unstack/;
-$ops{$_} = 1 for qw/padsv/;
-$ops{$_} = 'list' for qw/padav/;
-$ops{$_} = 'list' for qw/padhv rv2hv/;
-$ops{$_} = 'list' for qw/padany/;
-$ops{$_} = 'list' for qw/match entereval readline/;
+$ops{$_} = 0 for qw<stub nextstate pushmark iter unstack>;
+$ops{$_} = 1 for qw<padsv>;
+$ops{$_} = 'list' for qw<padav>;
+$ops{$_} = 'list' for qw<padhv rv2hv>;
+$ops{$_} = 'list' for qw<padany>;
+$ops{$_} = 'list' for qw<match entereval readline>;
$ops{each} = { 0 => 0.5, 2 => 0.5 };
$ops{stat} = { 0 => 0.5, 13 => 0.5 };
$ops{localtime} = do { my @a = localtime; scalar @a };
$ops{gmtime} = do { my @a = gmtime; scalar @a };
-$ops{$_} = { 0 => 0.5, 10 => 0.5 } for map "gpw$_", qw/nam uid ent/;
-$ops{$_} = { 0 => 0.5, 4 => 0.5 } for map "ggr$_", qw/nam gid ent/;
-$ops{$_} = 'list' for qw/ghbyname ghbyaddr ghostent/;
-$ops{$_} = { 0 => 0.5, 4 => 0.5 } for qw/gnbyname gnbyaddr gnetent/;
-$ops{$_} = { 0 => 0.5, 3 => 0.5 } for qw/gpbyname gpbynumber gprotoent/;
-$ops{$_} = { 0 => 0.5, 4 => 0.5 } for qw/gsbyname gsbyport gservent/;
+$ops{$_} = { 0 => 0.5, 10 => 0.5 } for map "gpw$_", qw<nam uid ent>;
+$ops{$_} = { 0 => 0.5, 4 => 0.5 } for map "ggr$_", qw<nam gid ent>;
+$ops{$_} = 'list' for qw<ghbyname ghbyaddr ghostent>;
+$ops{$_} = { 0 => 0.5, 4 => 0.5 } for qw<gnbyname gnbyaddr gnetent>;
+$ops{$_} = { 0 => 0.5, 3 => 0.5 } for qw<gpbyname gpbynumber gprotoent>;
+$ops{$_} = { 0 => 0.5, 4 => 0.5 } for qw<gsbyname gsbyport gservent>;
sub enter {
my ($self, $cv) = @_;
$next = $next->sibling;
}
$n = name($op)
- } while ($op->flags & OPf_KIDS and { map { $_ => 1 } qw/null leave/ }->{$n});
- return 'list', undef unless { map { $_ => 1 } qw/gv refgen/ }->{$n};
+ } while ($op->flags & OPf_KIDS and { map { $_ => 1 } qw<null leave> }->{$n});
+ return 'list', undef unless { map { $_ => 1 } qw<gv refgen> }->{$n};
local $self->{sub} = 1;
my ($rc, $lc) = $self->inspect($op);
return $r, scale $c, $lc;
L<perl> 5.8.1.
-L<Carp> (standard since perl 5), L<B> (since perl 5.005) and L<XSLoader> (since perl 5.006).
+A C compiler.
+This module may happen to build with a C++ compiler as well, but don't rely on it, as no guarantee is made in this regard.
+
+L<Carp> (standard since perl 5), L<B> (since perl 5.005) and L<XSLoader> (since perl 5.6.0).
=head1 AUTHOR
=head1 BUGS
-Please report any bugs or feature requests to C<bug-sub-nary at rt.cpan.org>, or through the web interface at L<http://rt.cpan.org/NoAuth/ReportBug.html?Queue=Sub-Nary>. I will be notified, and then you'll automatically be notified of progress on your bug as I make changes.
+Please report any bugs or feature requests to C<bug-sub-nary at rt.cpan.org>, or through the web interface at L<http://rt.cpan.org/NoAuth/ReportBug.html?Queue=Sub-Nary>.
+I will be notified, and then you'll automatically be notified of progress on your bug as I make changes.
=head1 SUPPORT