Tie::Array::Boolean - A memory efficient array of boolean values.


Tie-Array-Boolean documentation  | view source Contained in the Tie-Array-Boolean distribution.

Index


NAME

Top

Tie::Array::Boolean - A memory efficient array of boolean values.

VERSION

Top

This document describes Tie::Array::Boolean version 0.0.1

SYNOPSIS

Top

    use Tie::Array::Boolean;

    tie my @t, 'Tie::Array::Boolean';

    # how many 'true' values are in the array
    my $true_count = tied(@t)->get_truth_count();

DESCRIPTION

Top

This module implements an array as a scalar with each element represented as one bit. Every element of the array can be only 0 or 1.

INTERFACE

Top

After an array has been tied to the module, it has the same interface as a normal array. Every value set to 0, undef, the string '0', or the empty string will be 0. Every value set to anything else will be 1.

METHODS

Top

get_truth_count

Call this method on the object returned by tie or tied. It will return the number of elements in the array that are true. This is more efficient than counting values through the array interface.

DIAGNOSTICS

Top

None.

CONFIGURATION AND ENVIRONMENT

Top

Tie::Array::Boolean requires no configuration files or environment variables.

DEPENDENCIES

Top

Tie::Array::Boolean uses only the core module, Tie::Array.

INCOMPATIBILITIES

Top

None reported.

BUGS AND LIMITATIONS

Top

Please report any bugs or feature requests to bug-tie-array-boolean@rt.cpan.org, or through the web interface at http://rt.cpan.org.

AUTHOR

Top

Kyle Hasselbacher <kyleha@gmail.com>

LICENCE AND COPYRIGHT

Top

DISCLAIMER OF WARRANTY

Top

BECAUSE THIS SOFTWARE IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY FOR THE SOFTWARE, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE SOFTWARE "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE SOFTWARE IS WITH YOU. SHOULD THE SOFTWARE PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR, OR CORRECTION.

IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR REDISTRIBUTE THE SOFTWARE AS PERMITTED BY THE ABOVE LICENCE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE SOFTWARE (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE SOFTWARE TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.


Tie-Array-Boolean documentation  | view source Contained in the Tie-Array-Boolean distribution.