The Perl Toolchain Summit needs more sponsors. If your company depends on Perl, please support this very important event.

NAME

Data::Multihash - A hash table that supports multiple values per key.

SYNOPSIS

  use Data::Multihash;

  my $multihash = Data::Multihash->new();
  $multihash->insert(key => 'value', key => 'other_value');
  $multihash->insert(other_key => 'value');

  print 'There are ' . $multihash->size . ' elements in the multihash.';

DESCRIPTION

This module implements a multihash, which maps keys to sets of values. Multihashes are unordered.

CONSTRUCTORS

new()

Create a new empty multihash.

INSTANCE METHODS

insert(%pairs)

Insert key-value pairs.

remove_key(@keys), remove_keys(@keys)

Remove all given keys and their values.

remove_value(@values), remove_values(@values)

Remove all given values from the multihash.

remove_pair(%pairs), remove_pairs(%pairs)

Remove all given (key, value) pairs from the multiset.

elements($key)

Return all elements associated with a key.

values

Return all values in the multihash as a list.

size

Return the number of values in the multihash.

THREAD SAFETY

It is not safe to access a single multihash from multiple threads.

LICENSE

Copyright (c) 2014, Radek Slupik All rights reserved.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

  • Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.

  • Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.

  • Neither the name of nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.