Matrix.Min Method

Overload List

#	Signature	Description
1	Double Min	Minimum value.
	└ indexed: Double Min(Int32 Index, Int32 Len)
2	void Min(ref Double AMin, ref Int32 AIndex)	Calculate the minimum value of all calling object elements.
3	void Min(ref Double AMin, Int32 Index, Int32 Len)	Calculate the minimum value from calling object elements [Index]..[Index+Len-1].
4	void Min(ref Double AMin, ref Int32 AIndex, Int32 Index, Int32 Len)	Calculate the minimum value of calling object elements [Index]..[Index+Len-1].

Overload 1: Double Min

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 Dew.Math.Matrix.Complex property is true.

Examples

Matrix a = new Matrix();
a.SetIt(2, 2, false, new double[] { 1.0, 2.0, 3.0, 4.0 });
double result = a.Min();
if (Math.Abs(result - 1.0) > 1e-10)
    throw new Exception("Matrix.Min: expected 1.0, got " + result);

Matrix a;
double b;
a.SetIt(2,2,false,new double[] {1,2,3,4});
b = a.Min; // b = 1

See Also: Matrix.Max, Matrix.Minc

Indexed: Double Min(Int32 Index, Int32 Len)

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

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

Returns: Double

Remarks:

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

Overload 2: void Min(ref Double AMin, ref Int32 AIndex)

Calculate the minimum value of all calling object elements.

#	Name	Type	Description
1	AMin	Double (ref)	output
2	AIndex	Int32 (ref)	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 Dew.Math.Matrix.Complex property is true.

Overload 3: void Min(ref Double AMin, Int32 Index, Int32 Len)

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

#	Name	Type	Description
1	AMin	Double (ref)	output
2	Index	Int32	start index
3	Len	Int32	element count

Result: stored in self (calling object)

Remarks:

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

Overload 4: void Min(ref Double AMin, ref Int32 AIndex, Int32 Index, Int32 Len)

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

#	Name	Type	Description
1	AMin	Double (ref)	output
2	AIndex	Int32 (ref)	start index
3	Index	Int32	start index
4	Len	Int32	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 Dew.Math.Matrix.Complex property is true or array borders are overrud/underrun.