Matrix.Meanc Method

Overload List

#SignatureDescription
1function Meanc: TCplx;Mean value (complex).
└ indexed: function Meanc(Index: Integer; Len: Integer): TCplx;
2procedure Meanc(out AMean: TCplx);Calculate the mean value from all calling object complex elements.
└ indexed: procedure Meanc(out AMean: TCplx; Index: Integer; Len: Integer);

Overload 1: function Meanc: TCplx;

Mean value (complex).

Returns: TCplx (complex)

Remarks:

Returns the mean value of all calling object complex elements. The result is a complex value. An exception is raised is calling object Matrix.Complex is False.

See Also: Matrix.Mean

Indexed: function Meanc(Index: Integer; Len: Integer): TCplx;

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

#NameTypeDescription
1IndexIntegerstart index
2LenIntegerelement count

Returns: TCplx (complex)

Remarks:

An exception is raised if calling object Matrix.Complex property is False or array borders are overrun/underrun.

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

Calculate the mean value from all calling object complex elements.

#NameTypeDescription
1AMeanTCplxpre-computed mean

Result: stored in self (calling object)

Remarks:

The result AMean is a complex value. An exception is raised if calling object Matrix.Complex property is False.

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

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

#NameTypeDescription
1AMeanTCplxpre-computed mean
2IndexIntegerstart index
3LenIntegerelement count

Result: stored in self (calling object)

Remarks:

The result AMean is a complex value. An exception is raised if calling object Matrix.Complex property is False or array borders are overrun/underrun.