Matrix.Min Method

Overload List

#	Signature	Description
1	function Min: Double;	Minimum value.
	└ indexed: function Min(Index: Integer; Len: Integer): Double;
2	procedure Min(out AMin: Double; out AIndex: Integer);	Calculate the minimum value of all calling object elements.
3	procedure Min(out AMin: Double; Index: Integer; Len: Integer);	Calculate the minimum value from calling object elements [Index]..[Index+Len-1].
4	procedure Min(out AMin: Double; out AIndex: Integer; Index: Integer; Len: Integer);	Calculate the minimum value of calling object elements [Index]..[Index+Len-1].

Overload 1: function Min: Double;

Minimum value.

Returns: Double

Remarks:

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

Examples

var a: Matrix;
    b: double;
begin
    a.SetIt(2,2,False,[1,2,3,4]);
    b := a.Min; // b = 1
end;

var
    a: Matrix;
    result: double;
begin
    a := [[1.0, 2.0], [3.0, 4.0]];
    result := a.Min;
    if Abs(result - 1.0) > 1e-10 then
        raise Exception.Create('Matrix.Min: expected 1.0, got ' + result.ToString);
end;

See Also: Matrix.Max, Matrix.Minc

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

Calculate the minimum 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 Matrix.Complex property is true or array borders are overrun.

Overload 2: procedure Min(out AMin: Double; out AIndex: Integer);

Calculate the minimum value of all calling object elements.

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

Result: stored in self (calling object)

Remarks:

The AMin parameter returns the minimum value. The AIndex parameter returns the Index of minimum value. An exception is raised if calling object Matrix.Complex property is true.

Overload 3: procedure Min(out AMin: Double; Index: Integer; Len: Integer);

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

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

Result: stored in self (calling object)

Remarks:

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

Overload 4: procedure Min(out AMin: Double; out AIndex: Integer; Index: Integer; Len: Integer);

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

#	Name	Type	Description
1	AMin	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 minimum value. The AIndex parameter returns the Index of minimum value. An exception is raised if calling object Matrix.Complex property is true or array borders are overrud/underrun.