/usr/share/perl5/Algorithm/Dependency/Weight.pm is in libalgorithm-dependency-perl 1.110-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 | package Algorithm::Dependency::Weight;
=pod
=head1 NAME
Algorithm::Dependency::Weight - Calculate dependency 'weights'
=head1 SYNOPSIS
# Create a source from a file
my $Source = Algorithm::Dependency::Source->new( 'file.txt' );
# Create a Weight algorithm object
my $alg = Algorithm::Dependency::Weight->new( source => $Source );
# Find the weight for a single item
my $weight = $alg->weight('foo');
print "The weight of 'foo' is $weight\n";
# Or a group
my $hash = $alg->weight_hash('foo', 'bar', 'baz');
print "The weight of 'foo', 'bar', and 'bar' are $hash->{foo},"
. " $hash->{bar} and $hash->{baz} respectively\n";
# Or all of the items
my $all = $alg->weight_all;
print "The following is a list from heaviest to lightest:\n";
foreach ( sort { $all->{$b} <=> $all->{$a} } keys %$all ) {
print "$_: $all->{$_}\n";
}
=head1 DESCRIPTION
In dependency systems, it can often be very useful to calculate
an aggregate or sum for one or all items. For example, to find
the "naive install weight" of a Perl distribution (where "naive"
means you treat each distribution equally), you would want the
distribtion (1) + all its dependencies (n) + all B<their>
dependencies (n2) recursively downwards.
If calculated using a normal L<Algorithm::Dependency> object, the
result would be (in a simple systems) equal to:
# Create your normal (non-ordered alg:dep)
my $dependency = Algorithm::Dependency->new( ... );
# Find the naive weight for an item
my $weight = scalar($dependency->schedule('itemname'));
C<Algorithm::Dependency::Weight> provides a way of doing this
with a little more sophistication, and in a way that should work
reasonable well across all the L<Algorithm::Dependency> family.
Please note that the this might be a little (or more than a little)
slower than it could be for the limited case of generating weights
for all of the items at once in a dependency system with no selected
items and no circular dependencies. BUT you can at least rely on
this class to do the job properly regardless of the particulars of
the situation, which is probably more important.
=head2 METHODS
=cut
use 5.005;
use strict;
use List::Util ();
use Algorithm::Dependency ();
use Params::Util qw{_INSTANCE _STRING};
use vars qw{$VERSION};
BEGIN {
$VERSION = '1.110';
}
#####################################################################
# Constructor and Accessors
=pod
=head2 new @params
The C<new> constructor creates a new C<Algorithm::Dependency::Weight>
object. It takes a number of key/value pairs as parameters (although
at the present time only one).
=over 4
=item source => $Source
The C<source> param is mostly the same as for L<Algorithm::Dependency>.
The one addition is that as a source you can provide an
L<Algorithm::Dependency> object, and the L<Algorithm::Dependency::Source>
for that will be used.
=back
Returns a new C<Algorithm::Dependency::Weight> object, or C<undef> on error.
=cut
sub new {
my $class = shift;
my %args = @_;
# Get the source object, or derive it from an existing alg-dep
my $source = _INSTANCE($args{source}, 'Algorithm::Dependency')
? $args{source}->source
: _INSTANCE($args{source}, 'Algorithm::Dependency::Source')
or return undef;
# Build the alg-dep object we use
my $algdep = Algorithm::Dependency->new(
source => $source,
ignore_orphans => 1,
) or return undef;
# Create the basic object
my $self = bless {
source => $source,
algdep => $algdep,
weight => {},
}, $class;
$self;
}
=pod
=head2 source
The C<source> accessor returns the source used for the weight calculations.
This will be either the one passed to the constructor, or the source from
inside the C<Algorithm::Dependency> object passed as the C<source> param
(B<not> the object itself, B<its> source).
=cut
sub source {
$_[0]->{source}
}
#####################################################################
# Algorithm::Dependency::Weight Methods
=pod
=head2 weight $name
The C<weight> method takes the name of a single item and calculates its
weight based on the configuration of the C<Algorithm::Dependency::Weight>
object.
Returns the weight as a scalar (which in the naive case will be an
integer, but in more complex uses may be any real number), or C<undef>
on error.
=cut
sub weight {
my $self = shift;
my $id = defined(_STRING($_[0])) ? shift : return undef;
$self->{weight}->{$id} or
$self->{weight}->{$id} = $self->_weight($id);
}
sub _weight {
my $self = shift;
my $items = $self->{algdep}->schedule($_[0]) or return undef;
scalar(@$items);
}
=pod
=head2 weight_merged @names
The C<weight_merged> method takes the name of a set of items and
calculates an aggregated weight for the whole set.
Returns the weight as a scalar, or C<undef> on error.
=cut
sub weight_merged {
my $self = shift;
my $items = $self->{algdep}->schedule(@_) or return undef;
scalar(@$items);
}
=pod
=head2 weight_hash @names
The C<weight_hash> method takes a list of item names, and calculates
their weights.
Returns a reference to a C<HASH> with the item names as keys and weights
as values, or C<undef> on error.
=cut
sub weight_hash {
my $self = shift;
my @names = @_;
# Iterate over the list
my %hash = ();
foreach my $name ( @names ) {
if ( $self->{weight}->{$name} ) {
$hash{$name} = $self->{weight}->{$name};
next;
}
$hash{$name} = $self->weight($name) or return undef;
}
\%hash;
}
=pod
=head2 weight_all
The C<weight_all> method provides the one-shot method for getting the
weights of all items at once. Please note that this does not do
anything different or special, but is slightly faster than iterating
yourself.
Returns a reference to a C<HASH> with the item names as keys and weights
as values, or C<undef> on error.
=cut
sub weight_all {
my $self = shift;
my @items = $self->source->items;
defined $items[0] or return undef;
$self->weight_hash( map { $_->id } @items );
}
1;
=pod
=head1 TO DO
- Add support for non-naive weights via either custom code or method name
=head1 SUPPORT
Bugs should be submitted via the CPAN bug tracker, located at
L<http://rt.cpan.org/NoAuth/ReportBug.html?Queue=Algorithm-Dependency>
For general comments, contact the author.
=head1 AUTHOR
Adam Kennedy E<lt>adamk@cpan.orgE<gt>
=head1 SEE ALSO
L<Algorithm::Dependency>, L<Algorithm::Dependency::Source>
=head1 COPYRIGHT
Copyright 2003 - 2009 Adam Kennedy.
This program is free software; you can redistribute
it and/or modify it under the same terms as Perl itself.
The full text of the license can be found in the
LICENSE file included with this module.
=cut
|