Matrix.CopyToArray Method

Overload List

#SignatureDescription
1function CopyToArray(var Dst: TCplxArray): TMtxVec;Copy values to an array.
└ indexed: function CopyToArray(var Dst: TCplxArray; DstIndex: Integer; Index: Integer; Len: Integer): TMtxVec;
2procedure CopyToArray(var Dst: T2DCplxArray);Copies all matrix values to a 2D array.
3function CopyToArray(var Dst: TByteArray; Rounding: TRounding): TMtxVec;Copies values from the calling object to the Dst array and converts floating point data to 1 byte unsigned integer numbers.
└ indexed: function CopyToArray(var Dst: TByteArray; Rounding: TRounding; DstIndex: Integer; Index: Integer; Len: Integer): TMtxVec;
4function CopyToArray(var Dst: TDoubleArray): TMtxVec;Copy values to Dst array.
└ indexed: function CopyToArray(var Dst: TDoubleArray; DstIndex: Integer; Index: Integer; Len: Integer): TMtxVec;
5procedure CopyToArray(var Dst: T2DDoubleArray);Copies matrix values to a 2D array.
6function CopyToArray(var Dst: TSmallIntArray; Rounding: TRounding): TMtxVec;Copies values from the calling object to the Dst array and converts floating point data to 2 byte signed integer numbers.
└ indexed: function CopyToArray(var Dst: TSmallIntArray; Rounding: TRounding; DstIndex: Integer; Index: Integer; Len: Integer): TMtxVec;
7function CopyToArray(var Dst: TIntegerArray; Rounding: TRounding): TMtxVec;Copies values from the calling object to the Dst array and converts floating point data to integer numbers.
└ indexed: function CopyToArray(var Dst: TIntegerArray; Rounding: TRounding; DstIndex: Integer; Index: Integer; Len: Integer): TMtxVec;
8function CopyToArray(var Dst: TSingleArray): TMtxVec;Copies the calling object data to an array of single precision floating point data.
└ indexed: function CopyToArray(var Dst: TSingleArray; DstIndex: Integer; Index: Integer; Len: Integer): TMtxVec;

Overload 1: function CopyToArray(var Dst: TCplxArray): TMtxVec;

Copy values to an array.

#NameTypeDescription
1DstTCplxArray

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

Remarks:

Copy complex values to Dst array. The size of the array is set automatically. If the calling object is not complex an exception will be raised.

See Also: Matrix.Copy, Matrix.CopyTo, Matrix.Round, Matrix.Trunc, Matrix.CopyFromArray

Indexed: function CopyToArray(var Dst: TCplxArray; DstIndex: Integer; Index: Integer; Len: Integer): TMtxVec;

Copy complex values from the calling object [Index]..[Index+len-1] to the Dst array at positions [DstIndex]...[DstIndex+Len-1].

#NameTypeDescription
1DstTCplxArray
2DstIndexIntegerdestination start index
3IndexIntegerstart index
4LenIntegerelement count

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

Remarks:

The size of the Dst array is not changed.

Overload 2: procedure CopyToArray(var Dst: T2DCplxArray);

Copies all matrix values to a 2D array.

#NameTypeDescription
1DstT2DCplxArray

Result: stored in self (calling object)

Overload 3: function CopyToArray(var Dst: TByteArray; Rounding: TRounding): TMtxVec;

Copies values from the calling object to the Dst array and converts floating point data to 1 byte unsigned integer numbers.

#NameTypeDescription
1DstTByteArray
2RoundingTRounding

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

Remarks:

The rounding method used is specified with the Rounding parameter.

Indexed: function CopyToArray(var Dst: TByteArray; Rounding: TRounding; DstIndex: Integer; Index: Integer; Len: Integer): TMtxVec;

Copy real or complex values from the calling object [Index]..[Index+len-1] to the Dst integer array at positions [DstIndex]...[DstIndex+Len-1].

#NameTypeDescription
1DstTByteArray
2RoundingTRounding
3DstIndexIntegerdestination start index
4IndexIntegerstart index
5LenIntegerelement count

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

Remarks:

The size of the Dst array is not changed. If the calling object is complex, the Index and Len parameters define the number of complex elements. The method converts floating point values to integers. Values exceeding the range of 1 byte unsigned integer type are clipped.

Overload 4: function CopyToArray(var Dst: TDoubleArray): TMtxVec;

Copy values to Dst array.

#NameTypeDescription
1DstTDoubleArray

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

Remarks:

The size of the array is set automatically. If the calling object is complex, the size of the Dst array will be equal to 2*Matrix.Length. If the calling object is not complex an exception will be raised.

Indexed: function CopyToArray(var Dst: TDoubleArray; DstIndex: Integer; Index: Integer; Len: Integer): TMtxVec;

Copy real or complex values from the calling object [Index]..[Index+len-1] to the Dst array at positions [DstIndex]...[DstIndex+Len-1].

#NameTypeDescription
1DstTDoubleArray
2DstIndexIntegerdestination start index
3IndexIntegerstart index
4LenIntegerelement count

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

Remarks:

The size of the Dst array is not changed. If the calling object is complex, the Index and Len parameters define the number of complex elements.

Overload 5: procedure CopyToArray(var Dst: T2DDoubleArray);

Copies matrix values to a 2D array.

#NameTypeDescription
1DstT2DDoubleArray

Result: stored in self (calling object)

Remarks:

Copies all matrix values to a 2D array. The rows of the array will have two times as many columns, if the calling matrix object is Complex.

Overload 6: function CopyToArray(var Dst: TSmallIntArray; Rounding: TRounding): TMtxVec;

Copies values from the calling object to the Dst array and converts floating point data to 2 byte signed integer numbers.

#NameTypeDescription
1DstTSmallIntArray
2RoundingTRounding

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

Remarks:

The rounding method used is specified with the Rounding parameter.

Indexed: function CopyToArray(var Dst: TSmallIntArray; Rounding: TRounding; DstIndex: Integer; Index: Integer; Len: Integer): TMtxVec;

Copy real or complex values from the calling object [Index]..[Index+len-1] to the Dst integer array at positions [DstIndex]...[DstIndex+Len-1].

#NameTypeDescription
1DstTSmallIntArray
2RoundingTRounding
3DstIndexIntegerdestination start index
4IndexIntegerstart index
5LenIntegerelement count

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

Remarks:

The size of the Dst array is not changed. If the calling object is complex, the Index and Len parameters define the number of complex elements. The method converts floating point values to integers. Values exceeding the range of a 2 byte signed integer type are clipped.

Overload 7: function CopyToArray(var Dst: TIntegerArray; Rounding: TRounding): TMtxVec;

Copies values from the calling object to the Dst array and converts floating point data to integer numbers.

#NameTypeDescription
1DstTIntegerArray
2RoundingTRounding

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

Remarks:

The rounding method used is specified with the Rounding parameter.

Indexed: function CopyToArray(var Dst: TIntegerArray; Rounding: TRounding; DstIndex: Integer; Index: Integer; Len: Integer): TMtxVec;

Copy real or complex values from the calling object [Index]..[Index+len-1] to the Dst integer array at positions [DstIndex]...[DstIndex+Len-1].

#NameTypeDescription
1DstTIntegerArray
2RoundingTRounding
3DstIndexIntegerdestination start index
4IndexIntegerstart index
5LenIntegerelement count

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

Remarks:

The size of the Dst array is not changed. If the calling object is complex, the Index and Len parameters define the number of complex elements. The method converts floating point values to integer. Values exceeding the range of the integer type are clipped.

Overload 8: function CopyToArray(var Dst: TSingleArray): TMtxVec;

Copies the calling object data to an array of single precision floating point data.

#NameTypeDescription
1DstTSingleArray

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

Remarks:

Any values exceeding the range are clipped.

Indexed: function CopyToArray(var Dst: TSingleArray; DstIndex: Integer; Index: Integer; Len: Integer): TMtxVec;

Copy real or complex values from the calling object [Index]..[Index+len-1] to the Dst single precision floating point array at positions [DstIndex]...[DstIndex+Len-1].

#NameTypeDescription
1DstTSingleArray
2DstIndexIntegerdestination start index
3IndexIntegerstart index
4LenIntegerelement count

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

Remarks:

The size of the Dst array is not changed. If the calling object is complex, the Index and Len parameters define the number of complex elements.