Matrix::Min Method

Overload List

#	Signature	Description
1	double Min() const;	Minimum value.
2	double Min(int Index, int Len) const;	Calculate the minimum value from calling object elements [Index]..[Index+Len-1].
3	void Min(double &AMin, int Index, int Len) const;	Calculate the minimum value from calling object elements [Index]..[Index+Len-1].
4	void Min(double &AMin, int &AIndex, int Index, int Len) const;	Calculate the minimum value of calling object elements [Index]..[Index+Len-1].
5	void Min(double &AMin, int &AIndex) const;	Calculate the minimum value of all calling object elements.

Overload 1: double Min() const;

Minimum value.

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

#include "MtxExpr.h"
#include "Units.Math387.h"

using namespace Dew;
using namespace Dew::Math;
using namespace Dew::Math::Units::Math387;

void Example()
{
    Matrix a;
    a.SetIt(2, 2, false, DewArray<double>{ 1.0, 2.0, 3.0, 4.0 });
    double result = a.Min();
    if (Abs(result - 1.0) > 1e-10)
        throw tException(DewString("Matrix.Min: expected 1.0, got ") + SampleToStr(result));
}

#include "MtxExpr.h"

using namespace Dew;
using namespace Dew::Math;

void Example()
{
    Matrix a;
    double b;

    a.SetIt(2, 2, false, DewArray<double>{1, 2, 3, 4});
    b = a.Min(); // b = 1
}

See Also: Matrix::Max, Matrix::Minc

Declared in Dew::Math::Matrix · Dew.Math/MtxExpr.h · Cross-compiler

Overload 2: double Min(int Index, int Len) const;

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

#	Name	Type	Description
1	Index	int
2	Len	int

Remarks:

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

Examples

#include "MtxExpr.h"

using namespace Dew;
using namespace Dew::Math;

void Example()
{
    Matrix a;
    double b;

    a = {{1, 2}, {3, 4}};
    b = a.Min(); // b = 1
}

Declared in Dew::Math::Matrix · Dew.Math/MtxExpr.h · Cross-compiler

Overload 3: void Min(double &AMin, int Index, int Len) const;

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

#	Name	Type
1	AMin	double &
2	Index	int
3	Len	int

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.

Declared in Dew::Math::Matrix · Dew.Math/MtxExpr.h · Cross-compiler

Overload 4: void Min(double &AMin, int &AIndex, int Index, int Len) const;

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

#	Name	Type
1	AMin	double &
2	AIndex	int &
3	Index	int
4	Len	int

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.

Declared in Dew::Math::Matrix · Dew.Math/MtxExpr.h · Cross-compiler

Overload 5: void Min(double &AMin, int &AIndex) const;

Calculate the minimum value of all calling object elements.

#	Name	Type	Description
1	AMin	double &
2	AIndex	int &

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.

Declared in Dew::Math::Matrix · Dew.Math/MtxExpr.h · Cross-compiler