Jmw\Collection\Set\HashSet

Complexity

Total Complexity

11

Size/Duplication

Total Lines	114
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	4

Importance

Changes	1
Bugs	0	Features	0

9 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	6	1
A	add()	0	12	2
A	clear()	0	4	1
A	contains()	0	4	1
A	iterator()	0	4	1
A	remove()	0	10	2
A	size()	0	4	1
A	toArray()	0	4	1
A	getHash()	0	4	1

<?php
namespace Jmw\Collection\Set;

use Jmw\Collection\Map\HashMap;
use Jmw\Collection\Lists\ArrayList;

/**
 * This class implements the Set interface, backed by a hash table (actually a HashMap instance). 
 * It makes no guarantees as to the iteration order of the set; 
 * in particular, it does not guarantee that the order will remain constant over time. 
 * This class permits the null element.
 * @author john
 *
 */
class HashSet extends SetAbstract
{
	/**
	 * @var HashMap
	 */
	protected $map;
	
	/**
	 * Constructs a new HashSet instance
	 * It can be passed default values, and will implicitely remove
	 * any duplicates
	 * @param array
	 */
	public function __construct($array = [])
	{
		$this->clear();
		
		$this->addAll(new ArrayList($array));
	}
	
	/**
	 * Adds the specified element to this set if it is not already present. 
	 * More formally, adds the specified element e to this set if this set 
	 * contains no element e2 such that (e==null ? e2==null : e.equals(e2)). 
	 * If this set already contains the element, the call leaves the set unchanged 
	 * and returns false.
	 * @param multitype $element
	 * @return boolean
	 */
	public function add($element)
	{
		$changed = false;
		if(!$this->contains($element))
		{
			$key = $this->getHash($element);
			$this->map->put($key, $element);

$key is of type string, but the function expects a object<Jmw\Collection\Map\multitype>.

			$changed = true;
		}
		
		return $changed;
	}
	
	/**
	 * Removes all of the elements from this set. 
	 * The set will be empty after this call returns.
	 * @return void
	*/
	public function clear()
	{
		$this->map = new HashMap();
	}

	/**
	 * Returns true if this collection contains the specified element.
	 * @return boolean;

The doc-type boolean; could not be parsed: Expected "|" or "end of type", but got ";" at position 7. (view supported doc-types)

	 */
	public function contains($element)
	{
		return $this->map->containsKey($this->getHash($element));

$this->getHash($element) is of type string, but the function expects a object<Jmw\Collection\Map\multitype>.

	}
	
	/**
	 * Returns an iterator over the elements in this collection.
	 * @return IteratorInterface
	*/
	public function iterator()
	{
		return new SetIterator($this);
	}
	
	/**
	 * Removes a single instance of the specified element from this collection, if it is present (optional operation).
	 * @param multitype $element
	 * @return boolean
	*/
	public function remove($element)
	{
		$changed = false;
		if($this->contains($element))
		{
			$this->map->remove($this->getHash($element));

$this->getHash($element) is of type string, but the function expects a object<Jmw\Collection\Map\unknown>.

			$changed = true;
		}
		return $changed;
	}
	
	/**
	 * Returns the number of elements in this collection.
	 * @return int
	*/
	public function size()
	{
		return $this->map->size();
	}
	
	/**
	 * Returns an array containing all of the elements in this collection.
	 * @return array
	*/
	public function toArray()
	{
		return $this->map->values()->toArray();
	}
	
	/**
	 * Return a general hashing function for elements
	 * @param unknown $element
	 * @return string
	 */
	protected function getHash($element)
	{
		return hash('sha256', serialize($element));
	}
}