IEnumerable.average() method

IEnumerable->average($defValue) method

Computes the average of that sequence (s. Average()).

Syntax

public function average([ mixed $defValue = null ]) : mixed;

Parameters

Name	Type	Description
$defValue	mixed	[OPTIONAL] The value to return if sequence is empty.

$defValue

The default value.

Result

The average of the sequence or the default value.

Examples

use \System\Linq\Enumerable;

$seq1 = Enumerable::fromValues(1, 2, 3, 4, 5, 6);
$seq2 = Enumerable::fromValues();

// 3.5
$a1 = $seq1->average();

// 'TM', because sequence is empty
$a2 = $seq2->average('TM');