NAME

OBO::Util::SynonymTypeDefSet - A Set implementation of Synonym Types.

SYNOPSIS

use OBO::Util::SynonymTypeDefSet;

use OBO::Core::SynonymTypeDef;

use strict;

my $my_set = OBO::Util::SynonymTypeDefSet->new();

my @arr = $my_set->get_set();

my $n1 = OBO::Core::SynonymTypeDef->new();

my $n2 = OBO::Core::SynonymTypeDef->new();

my $n3 = OBO::Core::SynonymTypeDef->new();

$n1->id("CCO:P0000001");

$n2->id("CCO:P0000002");

$n3->id("CCO:P0000003");

$n1->name("One"); $n2->name("Two"); $n3->name("Three");

# remove from my_set $my_set->remove($n1); $my_set->add($n1); $my_set->remove($n1);

### set versions ### $my_set->add($n1); $my_set->add($n2); $my_set->add($n3);

my $n4 = OBO::Core::Synonym->new; my $n5 = OBO::Core::Synonym->new; my $n6 = OBO::Core::Synonym->new;

$n4->id("CCO:P0000004"); $n5->id("CCO:P0000005"); $n6->id("CCO:P0000006");

$n4->name("Four"); $n5->name("Five"); $n6->name("Six");

$my_set->add_all($n4, $n5, $n6);

$my_set->add_all($n4, $n5, $n6);

# remove from my_set $my_set->remove($n4);

my $n7 = $n4; my $n8 = $n5; my $n9 = $n6;

my $my_set2 = OBO::Util::SynonymSet->new;

$my_set->add_all($n4, $n5, $n6); $my_set2->add_all($n7, $n8, $n9, $n1, $n2, $n3);

$my_set2->clear();

DESCRIPTION

A set (OBO::Util::Set) of synonym type definitions (OBO::Core::SynonymTypeDef).

AUTHOR

Erick Antezana, <erant@psb.ugent.be>

COPYRIGHT AND LICENSE

Copyright (C) 2006, 2007, 2008 by Erick Antezana

This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself, either Perl version 5.8.7 or, at your option, any later version of Perl 5 you may have available.

add

  Usage    - $set->add()
  Returns  - true if the element was successfully added
  Args     - the element (OBO::Core::SynonymTypeDef) to be added
  Function - adds an element to this set
  

remove

  Usage    - $set->remove($element)
  Returns  - the removed element
  Args     - the element (OBO::Core::SynonymTypeDef) to be removed
  Function - removes an element from this set
  

contains

  Usage    - $set->contains()
  Returns  - true if this set contains the given element
  Args     - the element (OBO::Core::SynonymTypeDef) to be checked
  Function - checks if this set constains the given element
  

equals

  Usage    - $set->equals()
  Returns  - true or false
  Args     - the set (OBO::Util::SynonymTypeDefSet) to compare with
  Function - tells whether this set is equal to the given one
  

cpanm OBO::Util::Set

perl -MCPAN -e shell
install OBO::Util::Set