TMtxByte.Size Method

Overload List

#	Signature	Description
1	function Size(ARows: Integer; ACols: Integer): TMtxInt;	Specifies size of an integer matrix.
2	function Size(ARows: Integer; ACols: Integer; aPrecision: TIntPrecision): TMtxInt;	Sets the size of matrix.
3	function Size(const Src: TMtxVecBase): TMtxVecInt;	Size the object.
4	function Size(const Src: TMtxVecBase; aPrecision: TIntPrecision): TMtxVecInt;	Allows the IntPrecision property of the calling object to become of aPrecision value instead of Src.IntPrecision value.

Overload 1: function Size(ARows: Integer; ACols: Integer): TMtxInt;

Specifies size of an integer matrix.

#	Name	Type	Description
1	ARows	Integer
2	ACols	Integer

Result: stored in self (calling object), returns self for chaining

Remarks:

The Value of IntPrecision property is preserved.

Overload 2: function Size(ARows: Integer; ACols: Integer; aPrecision: TIntPrecision): TMtxInt;

Sets the size of matrix.

#	Name	Type
1	ARows	Integer
2	ACols	Integer
3	aPrecision	TIntPrecision

Result: stored in self (calling object), returns self for chaining

Remarks:

Set the calling matrix properties:

TMtxInt.Rows = ARows,
TMtxInt.Cols = ACols

Calling the Size method does not preserve the contents of the matrix. Use the Resize method, if you want to preserve existing values.

Note
The Size method performs an out-of-memory safe resize, if the matrix already has memory allocated. This prevents out of memory message for example when redefining the size of the matrix from single column to single row:

A.Rows := 10000; // matrix size = 0
A.Cols := 1;     // matrix size = 10000
// ...
A.Cols := 10000; // matrix size = 100 000 000 (problems here)
A.Rows := 1;     // matrix size = 10 000

Examples

var  A: TMtxInt;
begin
    CreateIt(A);
    try
        A.Size(2,1); // 2x1 integer matrix
        A.SetZero;
        // A becomes:
        // [0]
        // [0]
    finally
        FreeIt(A);
    end;
end;

Overload 3: function Size(const Src: TMtxVecBase): TMtxVecInt;

Size the object.

#	Name	Type	Description
1	Src	TMtxVecBase	source TVec, TMtx, TVecInt or TMtxInt

Result: stored in self (calling object), returns self for chaining

Remarks:

Assignes the size of the Src object to the calling object. If the calling object is a TVecInt object then the Src can be of any type, otherwise TMtxInt can only obtain size from a TMtxInt object and TSparseMtx can only obtain size from a TSparseMtx object.

If the calling object and Src are of different types and both objects have a matching TMtxVecBase.Length property only the IntPrecision property of the calling object will changed, while all other properties describing the size of the object (rows, cols, length) will be preserved.

Examples

A.Rows := 10000; // matrix size = 0
A.Cols := 1;     // matrix size = 10000
// ...
A.Cols := 10000; // matrix size = 100 000 000 (problems here)
A.Rows := 1;     // matrix size = 10 000

Overload 4: function Size(const Src: TMtxVecBase; aPrecision: TIntPrecision): TMtxVecInt;

Allows the IntPrecision property of the calling object to become of aPrecision value instead of Src.IntPrecision value.

#	Name	Type	Description
1	Src	TMtxVecBase	source TVec, TMtx, TVecInt or TMtxInt
2	aPrecision	TIntPrecision

Result: stored in self (calling object), returns self for chaining

Remarks:

It is also possible to pass the calling object as the Src with a different IntPrecision value. The value of the IntPrecision property can be changed without knowing the actual type of the object.