FilesExpand file tree

 master

/

Average.php

Copy path

Blame

More file actions

Blame

More file actions

Latest commit

 

History

History

History

53 lines (47 loc) · 1.75 KB

 master

/

Average.php

Copy path

Top

File metadata and controls

• Code
• Blame

53 lines (47 loc) · 1.75 KB

Raw

Copy raw file

Download raw file

Open symbols panel

Edit and raw actions

1

2

3

4

5

6

7

8

9

10

11

12

13

14

15

16

17

18

19

20

21

22

23

24

25

26

27

28

29

30

31

32

33

34

35

36

37

38

39

40

41

42

43

44

45

46

47

48

49

50

51

52

53

<?php

/**

* Copyright (C) 2011-2017 by Lars Strojny <lstrojny@php.net>

*

* Permission is hereby granted, free of charge, to any person obtaining a copy

* of this software and associated documentation files (the "Software"), to deal

* in the Software without restriction, including without limitation the rights

* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell

* copies of the Software, and to permit persons to whom the Software is

* furnished to do so, subject to the following conditions:

*

* The above copyright notice and this permission notice shall be included in

* all copies or substantial portions of the Software.

*

* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR

* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,

* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE

* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER

* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,

* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN

* THE SOFTWARE.

*/

namespace Functional;

use Functional\Exceptions\InvalidArgumentException;

use Traversable;

/**

* Returns the average of all numeric values in the array or null if no numeric value was found

*

* @param Traversable|array $collection

* @return null|float|int

*/

function average($collection)

{

InvalidArgumentException::assertCollection($collection, __FUNCTION__, 1);

$sum = null;

$divisor = 0;

foreach ($collection as $element) {

if (\is_numeric($element)) {

$sum += $element;

++$divisor;

}

}

if ($sum === null) {

return null;

}

return $sum / $divisor;

}