clVector.Mean Method

Overload List

#	Signature	Description
1	function Mean: Double;	Mean value.
	└ indexed: function Mean(Index: Integer; Len: Integer): Double;
2	procedure Mean(out AMean: TCplx);	Same as clVector.Meanc.
	└ indexed: procedure Mean(out AMean: TCplx; Index: Integer; Len: Integer);
3	procedure Mean(out AMean: Double; Index: Integer; Len: Integer);	Calculate the mean value from calling object elements [Index]..[Index+Len-1].

Overload 1: function Mean: Double;

Mean value.

Returns: Double

Remarks:

Calculate the mean value of all calling object elements. The result is a real value. An exception is raised if calling object clVector.Complex property is true.

Examples

var a: clVector;
b: double;
begin
    a.CopyFromArray(TDoubleArray.Create(1,2,3,4));
    b := a.Mean; // b = 2.5
end;

See Also: clVector.Sum, clVector.Meanc

Indexed: function Mean(Index: Integer; Len: Integer): Double;

Returns real mean value from calling object elements [Index]..[Index+Len-1].

#	Name	Type	Description
1	Index	Integer	start index
2	Len	Integer	element count

Returns: Double

Remarks:

An exception is raised if calling object clVector.Complex property is true or array borders are overrun.

Overload 2: procedure Mean(out AMean: TCplx);

Same as clVector.Meanc.

#	Name	Type	Description
1	AMean	TCplx	pre-computed mean

Result: stored in self (calling object)

Indexed: procedure Mean(out AMean: TCplx; Index: Integer; Len: Integer);

Same as clVector.Meanc.

#	Name	Type	Description
1	AMean	TCplx	pre-computed mean
2	Index	Integer	start index
3	Len	Integer	element count

Result: stored in self (calling object)

Overload 3: procedure Mean(out AMean: Double; Index: Integer; Len: Integer);

Calculate the mean value from calling object elements [Index]..[Index+Len-1].

#	Name	Type	Description
1	AMean	Double	pre-computed mean
2	Index	Integer	start index
3	Len	Integer	element count

Result: stored in self (calling object)

Remarks:

The result AMean is a real value. An exception is raised if calling object clVector.Complex property is true or array borders are overrun/underrun.