clMatrix.Max Method

Overload List

#	Signature	Description
1	function Max: Double;	Maximum value.
	└ indexed: function Max(Index: Integer; Len: Integer): Double;
2	procedure Max(out AMax: Double; out AIndex: Integer);	Calculate the maximum value of all calling object elements.
3	function Max(out AMax: TCplx; Index: Integer; Len: Integer): Integer;	Same as clMatrix.Maxc method.
4	procedure Max(out AMax: Double; Index: Integer; Len: Integer);	Calculate the maximum value from calling object elements [Index]..[Index+Len-1].
5	procedure Max(out AMax: Double; out AIndex: Integer; Index: Integer; Len: Integer);	Calculate the maximum value of calling object elements [Index]..[Index+Len-1].

Overload 1: function Max: Double;

Maximum value.

Returns: Double - the maximum value of all calling object elements. The result is a real value.

Remarks:

An exception is raised is calling object clMatrix.Complex is true.

Examples

var a: clMatrix;
    b: double;
begin
    a.Size(2,2, TclFloatPrecision.clFloat, false);
    a.CopyFromArray(TDoubleArray.Create(1,2,3,4));
    b := a.Max; // b = 4
end;

See Also: clMatrix.Min, clMatrix.Maxc, clMatrix.MaxMin

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

Returns the maximum 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:

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

Overload 2: procedure Max(out AMax: Double; out AIndex: Integer);

Calculate the maximum value of all calling object elements.

#	Name	Type	Description
1	AMax	Double
2	AIndex	Integer	start index

Result: stored in self (calling object)

Remarks:

The AMax parameter returns the maximum value. The AIndex parameter returns the index of maximum value. An exception is raised if calling object clMatrix.Complex property is true.

Overload 3: function Max(out AMax: TCplx; Index: Integer; Len: Integer): Integer;

Same as clMatrix.Maxc method.

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

Returns: Int32

Overload 4: procedure Max(out AMax: Double; Index: Integer; Len: Integer);

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

#	Name	Type	Description
1	AMax	Double
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 clMatrix.Complex property is true or array borders are overrun.

Overload 5: procedure Max(out AMax: Double; out AIndex: Integer; Index: Integer; Len: Integer);

Calculate the maximum value of calling object elements [Index]..[Index+Len-1].

#	Name	Type	Description
1	AMax	Double
2	AIndex	Integer	start index
3	Index	Integer	start index
4	Len	Integer	element count

Result: stored in self (calling object)

Remarks:

The AMax parameter returns the maximum value. The AIndex parameter returns the index of maximum value. An exception is raised if calling object clMatrix.Complex property is true or array borders are overrud/underrun.