blib/lib/Statistics/Diversity/Shannon.pm

filter: Statementstmt 100% 47 / 47 Branchbran 75.0% 9 / 12 Conditioncond n/a MC/DCmcdc n/a Subroutinesub 100% 11 / 11 Podpod n/a totaltotal 95.7% 67 / 70 CC 9 SCAR 7.3
CC
9
Cov
95%
_build_N
3.0
_build_sum
3.0
__ANON__
2.1
CRAP 2.1
↑ Summary
1 package Statistics::Diversity::Shannon;
2 2 our $AUTHORITY = 'cpan:GENE';
3  
4 # ABSTRACT: Compute the Shannon diversity
5  
6 2 ▶use Moo;
Subroutine BEGIN: called CC=1 SCAR=0.0
7 2 ▶use strictures 2;
Subroutine BEGIN: called CC=1 SCAR=0.0
8 2 ▶use namespace::clean;
Subroutine BEGIN: called CC=1 SCAR=0.0
9  
10 2 ▶use List::Util 1.30 qw(sum0);
Subroutine BEGIN: called CC=1 SCAR=0.0
11  
12 2 our $VERSION = '0.0102';
13  
14  
15 has data => (
16 is => 'ro',
17 2 ▶ isa => sub { die 'Not an array reference' unless ref($_[0]) eq 'ARRAY' },
Subroutine __ANON__: called CC=2 SCAR=6.9
Branch: 1 branch
BranchTrueFalseTotal
unless ref $_[0] eq "ARRAY" 1 1 2
18 2 );
19  
20 has freq => (
21 is => 'ro',
22 3 ▶ isa => sub { die 'Not an array reference' unless ref($_[0]) eq 'ARRAY' },
Subroutine __ANON__: called CC=2 SCAR=7.6
Branch: 1 branch
BranchTrueFalseTotal
unless ref $_[0] eq "ARRAY" 0 3 3
23 2 builder => 1,
24 lazy => 1,
25 );
26  
27 2 has N => (
28 is => 'ro',
29 builder => 1,
30 lazy => 1,
31 );
32  
33 2 has sum => (
34 is => 'ro',
35 builder => 1,
36 lazy => 1,
37 );
38  
39 2 has index => (
40 is => 'ro',
41 builder => 1,
42 lazy => 1,
43 );
44  
45 2 has evenness => (
46 is => 'ro',
47 builder => 1,
48 lazy => 1,
49 );
50  
51  
52 3 ▶sub _build_N {
Subroutine _build_N: called CC=3 SCAR=11.0
53 3 my $self = shift;
54 3 ▶ my $n = $self->data ? scalar @{ $self->data } : $self->freq ? scalar @{ $self->freq } : 0;
Branch: 2 branches
BranchTrueFalseTotal
$self->data ? : 1 2 3
$self->freq ? : 2 0 2
55 3 return $n;
56 }
57  
58 3 ▶sub _build_sum {
Subroutine _build_sum: called CC=3 SCAR=11.0
59 3 my $self = shift;
60 3 ▶ my $sum = $self->data ? sum0 @{ $self->data } : $self->freq ? sum0 @{ $self->freq } : 0;
Branch: 2 branches
BranchTrueFalseTotal
$self->data ? : 1 2 3
$self->freq ? : 2 0 2
61 3 return $sum;
62 }
63  
64 1 ▶sub _build_freq {
Subroutine _build_freq: called CC=2 SCAR=6.9
65 1 my $self = shift;
66  
67 1 my @freq;
68  
69 1 for my $datum ( @{ $self->data } ) {
70 5 push @freq, $datum / $self->sum;
71 }
72  
73 1 return \@freq;
74 }
75  
76  
77 3 ▶sub _build_index {
Subroutine _build_index: called CC=2 SCAR=6.9
78 3 my $self = shift;
79  
80 3 my @index;
81  
82 3 for my $datum ( @{ $self->freq } ) {
83 13 push @index, $datum * log($datum);
84 }
85  
86 3 return -1 * sum0 @index;
87 }
88  
89  
90 3 ▶sub _build_evenness {
Subroutine _build_evenness: called CC=1 SCAR=0.0
91 3 my $self = shift;
92 3 return $self->index / log( $self->N );
93 }
94  
95 2 1;
96  
97 __END__
↑ Summary