X-Git-Url: http://git.vpit.fr/?a=blobdiff_plain;f=lib%2FScalar%2FVec%2FUtil.pm;h=784890c2c0cba78c5c8109740e0ee3b538ec942a;hb=42a284a5c8c2f7eff2e75013e9c3bb451d1abe61;hp=1435972a64b3c2ab4beeb2de254dc932a2728ed0;hpb=82dcef98c2b9fa6b67b9912a6f4e566b4fd7e155;p=perl%2Fmodules%2FScalar-Vec-Util.git diff --git a/lib/Scalar/Vec/Util.pm b/lib/Scalar/Vec/Util.pm index 1435972..784890c 100644 --- a/lib/Scalar/Vec/Util.pm +++ b/lib/Scalar/Vec/Util.pm @@ -3,7 +3,7 @@ package Scalar::Vec::Util; use strict; use warnings; -use Carp qw/croak/; +use Carp qw; =head1 NAME @@ -11,13 +11,13 @@ Scalar::Vec::Util - Utility routines for vec strings. =head1 VERSION -Version 0.06 +Version 0.07 =cut our $VERSION; BEGIN { - $VERSION = '0.06'; + $VERSION = '0.07'; eval { require XSLoader; XSLoader::load(__PACKAGE__, $VERSION); @@ -33,42 +33,45 @@ BEGIN { =head1 SYNOPSIS - use Scalar::Vec::Util qw/vfill vcopy veq/; + use Scalar::Vec::Util qw; my $s; vfill $s, 0, 100, 1; # Fill with 100 bits 1 starting at 0. my $t; vcopy $s, 20, $t, 10, 30; # Copy 30 bits from $s, starting at 20, # to $t, starting at 10. - vcopy $t, 10, $t, 20, 30; # Overalapping areas DWIM. + vcopy $t, 10, $t, 20, 30; # Overlapping areas DWIM. if (veq $t, 10, $t, 20, 30) { ... } # Yes, they are equal now. =head1 DESCRIPTION -A set of utilities to manipulate bits in vec strings. -Highly optimized XS routines are used when available, but straightforward pure perl replacements are also provided for platforms without a C compiler. +This module provides a set of utility routines that efficiently manipulate bits in vec strings. +Highly optimized XS functions are used whenever possible, but straightforward pure Perl replacements are also available for platforms without a C compiler. -This module doesn't reimplement bit vectors. -It can be used on the very same scalars that C builds, or actually on any Perl string (C). +Note that this module does not aim at reimplementing bit vectors : all its functions can be used on any Perl string, just like L. =head1 CONSTANTS =head2 C -True when pure perl fallbacks are used instead of XS functions. +True when pure Perl fallbacks are used instead of XS functions. =head2 C -Size in bits of the unit used for moves. +The size (in bits) of the unit used for bit operations. The higher this value is, the faster the XS functions are. -It's usually C, except on non-little-endian architectures where it currently falls back to C (e.g. SPARC). +It is usually C, except on non-little-endian architectures where it currently falls back to C (e.g. SPARC). =head1 FUNCTIONS -=head2 C +=head2 C -Starting at C<$start> in C<$vec>, fills C<$length> bits with C<$bit>. -Grows C<$vec> if necessary. + vfill $vec, $start, $length, $bit; + +Starting at C<$start> in C<$vec>, fills C<$length> bits with ones if C<$bit> is true and with zeros if C<$bit> is false. + +C<$vec> is upgraded to a string and extended if necessary. +Bits that are outside of the specified area are left untouched. =cut @@ -90,12 +93,21 @@ sub vfill_pp ($$$$) { } } -=head2 C<< vcopy $from => $from_start, $to => $to_start, $length >> +=head2 C + + vcopy $from => $from_start, $to => $to_start, $length; Copies C<$length> bits starting at C<$from_start> in C<$from> to C<$to_start> in C<$to>. -If C<$from_start + $length> is too long for C<$from>, zeros are copied past C<$length>. -Grows C<$to> if necessary. -Doesn't need to allocate any extra memory. + +C<$from> and C<$to> are allowed to be the same scalar, and the given areas can rightfully overlap. + +C<$from> is upgraded to a string if it isn't one already. +If C<$from_start + $length> goes out of the bounds of C<$from>, then the extra bits are treated as zeros. +C<$to> is upgraded to a string and extended if necessary. +The content of C<$from> is not modified, except when it is equal to C<$to>. +Bits that are outside of the specified area are left untouched. + +This function does not need to allocate any extra memory. =cut @@ -105,19 +117,26 @@ sub vcopy_pp ($$$$$) { croak 'Invalid negative offset' if $fs < 0 or $ts < 0; croak 'Invalid negative length' if $l < 0; my $step = $ts - $fs; - if ($step <= 0) { + if ($step <= 0) { vec($_[2], $_ + $step, 1) = vec($_[0], $_, 1) for $fs .. $fs + $l - 1; } else { # There's a risk of overwriting if $_[0] and $_[2] are the same SV. vec($_[2], $_ + $step, 1) = vec($_[0], $_, 1) for reverse $fs .. $fs + $l - 1; } } -=head2 C<< vshift $v, $start, $length => $bits [, $insert ] >> +=head2 C + + vshift $v, $start, $length => $bits, $insert; In the area starting at C<$start> and of length C<$length> in C<$v>, shift bits C positions left if C<< $bits > 0 >> and right otherwise. -If C<$insert> is defined, also fills the resulting gap with ones if C<$insert> is true and zeros if it's false. -Bits outside of the specified area are left untouched. -Doesn't need to allocate any extra memory. + +When C<$insert> is defined, the resulting gap is also filled with ones if C<$insert> is true and with zeros if C<$insert> is false. + +C<$v> is upgraded to a string if it isn't one already. +If C<$start + $length> goes out of the bounds of C<$v>, then the extra bits are treated as zeros. +Bits that are outside of the specified area are left untouched. + +This function does not need to allocate any extra memory. =cut @@ -145,11 +164,17 @@ sub vshift ($$$$;$) { } } -=head2 C<< vrot $v, $start, $length, $bits >> +=head2 C + + vrot $v, $start, $length, $bits; In the area starting at C<$start> and of length C<$length> in C<$v>, rotates bits C positions left if C<< $bits > 0 >> and right otherwise. -Bits outside of the specified area are left untouched. -Currently allocates an extra buffer of size C. + +C<$v> is upgraded to a string if it isn't one already. +If C<$start + $length> goes out of the bounds of C<$v>, then the extra bits are treated as zeros. +Bits that are outside of the specified area are left untouched. + +This function currently allocates an extra buffer of size C. =cut @@ -178,10 +203,16 @@ sub vrot ($$$$) { } } -=head2 C<< veq $v1 => $v1_start, $v2 => $v2_start, $length >> +=head2 C + + veq $v1 => $v1_start, $v2 => $v2_start, $length; Returns true if the C<$length> bits starting at C<$v1_start> in C<$v1> and C<$v2_start> in C<$v2> are equal, and false otherwise. -If needed, C<$length> is decreased to fit inside C<$v1> and C<$v2> boundaries. + +C<$v1> and C<$v2> are upgraded to strings if they aren't already, but their contents are never modified. +If C<$v1_start + $length> (respectively C<$v2_start + $length>) goes out of the bounds of C<$v1> (respectively C<$v2>), then the extra bits are treated as zeros. + +This function does not need to allocate any extra memory. =cut @@ -207,12 +238,12 @@ They are all exported by the tags C<':consts'> and C<':all'>. =cut -use base qw/Exporter/; +use base qw; our @EXPORT = (); our %EXPORT_TAGS = ( - 'funcs' => [ qw/vfill vcopy vshift vrot veq/ ], - 'consts' => [ qw/SVU_PP SVU_SIZE/ ] + 'funcs' => [ qw ], + 'consts' => [ qw ] ); our @EXPORT_OK = map { @$_ } values %EXPORT_TAGS; $EXPORT_TAGS{'all'} = [ @EXPORT_OK ]; @@ -224,7 +255,9 @@ The C<_pp> entries are the pure Perl versions, whereas C<_bv> are L =over 4 -=item This is for perl 5.8.8 on a Core 2 Duo 2.66GHz machine (unit is 64 bits). +=item * + +This is for perl 5.8.8 on a Core 2 Duo 2.66GHz machine (unit is 64 bits). Filling bits at a given position : Rate vfill_pp vfill_bv vfill @@ -250,7 +283,9 @@ The C<_pp> entries are the pure Perl versions, whereas C<_bv> are L veq_bv 32777/s 35241% -- -94% veq 505828/s 545300% 1443% -- -=item This is for perl 5.10.0 on a Pentium 4 3.0GHz (unit is 32 bits). +=item * + +This is for perl 5.10.0 on a Pentium 4 3.0GHz (unit is 32 bits). Rate vfill_pp vfill_bv vfill vfill_pp 185/s -- -100% -100% @@ -272,7 +307,9 @@ The C<_pp> entries are the pure Perl versions, whereas C<_bv> are L veq_bv 17518/s 51190% -- -91% veq 192181/s 562591% 997% -- -=item This is for perl 5.10.0 on an UltraSPARC-IIi (unit is 8 bits). +=item * + +This is for perl 5.10.0 on an UltraSPARC-IIi (unit is 8 bits). Rate vfill_pp vfill vfill_bv vfill_pp 4.23/s -- -100% -100% @@ -303,6 +340,11 @@ I'll add exceptions for them. =head1 DEPENDENCIES +L 5.6. + +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, L (core modules since perl 5), L (since perl 5.006). =head1 SEE ALSO @@ -330,7 +372,7 @@ Tests code coverage report is available at L