NumberMap.php

Show:

inherited

Table of Contents

\Ulrichsg\Collections\NumberMap
jump to top

Package:

A map that contains only numeric values, and supports mathematical operations.

__construct(array $data = array(), mixed $default = 0) : void

Creates a new NumberMap with the given array as its contents. Omitting the argument creates an empty map.

Parameters

Name	Type	Description
$data	array
$default	mixed

Throws

Exception	Description
\InvalidArgumentException	if $default or one of the array values is not numeric

add(mixed $key, mixed $value) : void

Adds the given value to the one associated to the given key.

If the key is not in the map yet, put it in and assume the map-wide default value.

Parameters

Name	Type	Description
$key	mixed
$value	mixed

Throws

Exception	Description
\InvalidArgumentException	if $value is not numeric

set(mixed $key, mixed $value) : void

Puts the given key-value pair into the map.

Parameters

Name	Type	Description
$key	mixed
$value	mixed

Throws

Exception	Description
\InvalidArgumentException	if $value is not numeric

sum() : mixed

Returns the sum of all values in the map.

Returns

Type	Description
mixed