VectorInt Record

type VectorInt = record;

Integer vector class for operator overloading (Delphi 2006 and later).

Declare VectorInt instead of TVecInt to take advantage ofoperator overloading. Be carefull to declare VectorInt only for local variables with short lifetime. Call the Create method for VectorInt, if the variable is a global variable or a variable with a longer life. It also makes sense to continue to use TVecInt for global vars. If the Create method (constuctor) is not called, the VectorInt record obtains TVecInt object from object cache (fastest create). If the Create mehod is called, the TVecInt object is created in the usual way (slower). Object cache has limited size.

Examples

delphi

var b, c: VectorInt;
    bv: TVecInt;
begin
    b := VectorInt(TIntegerArray.Create(1,1,1,1)); //b = [1,1,1,1];
    bv := b;   //b and bv point to same data object

    bv.Multiply(2);
    bv.Bits[76] := true;  //set 76th bit in the array to 1
    TVecInt(b).Multiply(2);  //an alternative way to scale
    c := b*2 + 3; //c := b*2 + 2 + 3i

    c := b*bv; //mix VectorInt and TVecInt

    bv.Add(c); //pass VectorInt type and implicitely convert to TVecInt pointer
    b.PackBits(c); // store bit 1 in b for all elements in c which are different from zero. Bit 0 otherwise.
end;

Constructors

Name	Description
Create (4)	Uses TVecInt object as internal storage.

Properties

Name	Type	Description
BitCount	Int64	Allows sizing the internal storage to accomodate desired number of bits.
BlockEnd	Boolean	Returns true, if the currrent subrange of the vector was also the last subrange in the VectorInt.
Capacity	Int64	Sizing the object will not allocate less than Capacity samples.
CapacityStep	Double	Specifies increment step for the Capacity property.
Caption	string	Vector Caption.
ConditionCheck	Boolean	Enables/disable inline condition checking.
First	Integer	First element in object Values array.
IntegerValues	string	Returns data for inspection by the debugger.
IntPrecision	TIntPrecision	Defines internal storage precision which can be either 32, 16 or 8 bit.
IsSubRange	Boolean	Set to true after the SetSubIndex or SetSubRange call.
Last	Integer	Last element in object Values array.
Length	Integer	Defines the length in number of samples.
ScaleFactor	Integer	Specifies the power of two for the scale factor used by some methods.
Tag	Integer	Stores an integer value as a part of the object.

Methods

Name	Description
Abs (4)	Absolute values.
Add (12)	Add Src elements to calling vector elements.
AddAndMul (26)	Compute (X + Y)*Z
AddScaled (10)	Compute X + Y + Z*zScale
AddScaledC (4)	Compute X + Y*yScale + zScalar
AddScaledSqr (4)	Compute sqr(X + Y*yScale)
Adopt	Adopts TVecInt object.
BinaryAnd (8)	Apply binary "and" between coresponding elements in Src and Self.
BinaryNot (4)	Applies binary "not" operation to elements stored in the object.
BinaryOr (8)	Apply binary "or" between coresponding elements in Src and Self.
BinarySearch (2)	Finds a match for X in object values using binary search.
BinaryXor (8)	Apply binary "xor" between coresponding elements in Src and Self.
BitPack (2)	Converts Src to packed bit storage.
BitShift (4)	Apply binary shift by number of Bits to the left (positive) or right (negative) to elements in Src.
BitShiftLeft (4)	Apply binary shift by number of Bits to the left to elements in Src.
BitShiftRight (4)	Apply binary shift by number of Bits to the right to elements in Src.
BitUnpack (2)	Converts Src to packed bit storage.
BlockFinish	Deinitializes block processing before the final block is processed.
BlockInit (4)	Initializes block processing.
BlockNext	Obtains the next subrange of the data.
Clear	Sets vector size to zero.
Concat (2)	Concatenates an array of TVecInt objects.
CondDisable	Saves the current value of ConditionCheck property and sets it to false.
CondEnable	Sets the ConditionCheck property to whatever it was before the CondDisable was used.
Convert (2)	Copy each of Vec elements to the calling object.
Copy (2)	Copy object values.
CopyFromArray (14)	Copies values from a real Src array.
CopyToArray (14)	Copies values from the calling object to the Dst array and converts data to double precision numbers.
CountInRange (2)	Returns number of values within the interval.
CumSum (4)	Cumulative sum.
Diag	Copies the k-th diagonal from the TMtxInt object.
Difference (3)	Calculate the difference for all Vec elements.
DisableSelect	Prevents calls to MtxExprInt.Select.
DisableSubrange	Prevents calls to VectorInt.SetSubRange.
Distinct	Stores distinct values from Src in to Dst.
DivAndAdd (12)	Compute X/Y + Z
DivAndSub (12)	Compute X/Y - Z
Divide (12)	Divide calling object elements with Src elements.
DivideBy (4)	Divide Value with calling vector elements.
DivideC (2)	Compute X / (Y*zScale)
EnableSelect	Enables calls to MtxExprInt.Select.
EnableSubrange	Enables calls to VectorInt.SetSubRange.
Find	Finds a match for X in object values.
FindAndGather (2)	The b parameter is of TMtxVecInt type.
FindAndSplit (3)	The b parameter is of TCplx type.
FindIndexes (5)	Fills the calling vector with indexes, where the logical expression is true.
FindIndexesAndLength (2)	The b parameter is of TMtxVecInt type.
FindMask (5)	Finds a vector mask.
Gather	Gather vector elements.
GatherByIncr	Gathers elements from X starting at Offset and with Increment to the calling object.
GatherByIndex	Gathers elements from X specified by indices stored in Indexes the calling object.
GatherByMask	Gathers elements from X specified by non-zero values stored in the Mask to the calling object.
GetCol (3)	Copies a column from matrix.
GetRow (3)	Copies a row from matrix.
IsEqual (4)	Compares two objects.
LoadFromFile	Reads the header information and the values array content from the file.
LogicalNot (4)	Applies logical "not" operation to elements stored in the object.
Max (4)	Maximum value.
MaxEvery (4)	Vectorised maximum.
MaxMin (2)	Calculate minimum and maximum in one procedure call.
MaxMinIdx (2)	Calculate minimum, maximum and their indices in one procedure call.
Median (4)	Applies median filter with size Mask to data in Src and stores the result in the calling vector.
Min (4)	Minimum value.
MinEvery (4)	Vectorised minimum.
Mul (4)	Compute XYZ
MulAndAdd (14)	Compute X*Y + Z
MulAndDiv (6)	Compute X * Y / Z
MulAndSub (14)	Compute X*Y - Z
Multiply (8)	Multiply Src elements with calling vector elements.
Parse	Parses string content as vector.
PBValues	Obtains a pointer to the integer value of the vector at Index.
PIValues	Obtains a pointer to the integer value of the vector at Index.
PSValues	Obtains a pointer to the integer value of the vector at Index.
PValues	Obtains a pointer to the integer value of the vector at Index.
Ramp (3)	Fills the calling vector with a series following linear rule.
RandomRamp	Fills the calling vector elements with linear rule and randomly shuffles the indexes.
RandomShuffle	Randomly shuffles the content of the vector.
ReadHeader	Reads the header information from a stream to object.
ReadValues	Read values content from stream to object.
RemDiv (6)	Divide all Src elements with Value elements and store result of division in the calling object and reminder in RemDst.
Resize (2)	Resizes vector size while preserving values.
Reverse (4)	Reverse vector elements.
Rotate (4)	A cyclic shift on vector elements in range.
SaveToFile	Write object header and values to a file.
Scatter	Scatter object elements.
ScatterByIncr	Scatters Src elements starting at Offset and with Increment to the calling object.
ScatterByIndexes	Scatters Src elements defined with indices stored in Indexes to the calling object.
ScatterByMask	Scatters Src elements defined with the Mask to the calling object.
SelectAll	Resets any defined selection.
SetFullRange	Resets any defined subrange.
SetFullRangeLevel	Resets last defined subrange and pops the subrange stack.
SetIt (2)	Sets object values.
SetSubIndex (2)	Defines a subarray.
SetSubRange (4)	Sets the subarray size to full size.
SetSubRangeLevel (2)	Defines a sub vector/matrix of Src and pushes any previous subranges on to a stack.
SetVal (2)	Set calling object element Index to Value.
SetZero (2)	Set all calling vector elements to zero.
Shift (4)	Do a shift on vector elements in range.
Size (3)	Size the object.
SizeFromArray (6)	Sets the size of the vector to match an array.
SizeToArray (7)	Sizes complex array.
SortAscend (3)	Sort all calling vector elements in ascending order in-place.
SortDescend (3)	Sort all calling vector elements in descending order in-place.
SqrAddScaled (4)	Compute sqr(X) + sqr(Y)*yScale
StringsToValues (2)	Convert strings in aList to integers.
Sub (4)	Compute X - Y - Z
SubAndMul (26)	Compute (X - Y)*Z
SubScaled (6)	Compute X - Y - Z*zScale
SubScaledC (4)	Compute X - Y*yScale - zScalar
Subtract (8)	Subtract all Src elements from calling vector elements.
SubtractFrom (4)	Subtract all calling vector elements from integer Value.
Sum (2)	Sums vector values.
ThreshAbsGT (4)	Perform threshold operation on all Src object values.
ThreshAbsLT (4)	Perform threshold operation on all Src object values.
ThreshBottom (4)	Perform threshold operation on all Src object values.
ThresholdGT_LT (4)	Threshold greater than and less than operation.
ThreshTop (4)	Perform threshold operation on all Src object values.
ToString	Returns content as a string.
ValuesToStrings (2)	Converts the content of the Values array of the calling vector to a list of strings.
ValuesToText (2)	Convert all vector elements to text.
WriteHeader	Writes the header information for the calling vector to a stream.
WriteValues	Writes object Values content to a stream.

Operators

Name	Description
Add (5)	Add coresponding elements in Left and Right.
BitwiseAnd (3)	Computes bitwise "and" between Left and right.
BitwiseOr (3)	Computes bitwise "or" between Left and right.
BitwiseXor (3)	Performs logical "xor" between Left and Right.
Divide (5)	Divide all elements in Left with coresponding elements in Right.
Equal (5)	Returns true, if Left and Right are of equal Length and Values.
Explicit (9)	Explicitely convert array of complex values to VectorInt.
GreaterThan (3)	Returns true, if coresponding elements in ALeft are greater than coresponding elements in ARight.
GreaterThanOrEqual (3)	Returns true, if coresponding elements in ALeft are greater or equal from coresponding elements in ARight.
Implicit (8)	Implicit type conversion from VectorInt to TMtxVecBase.
LeftShift	Performs bitwise left shift of aValue.
LessThan (3)	Returns true, if coresponding elements in ALeft are greater than coresponding elements in ARight.
LessThanOrEqual (3)	Returns true, if coresponding elements in ALeft are smaller than or equal from coresponding elements in ARight.
LogicalNot	Performs logical (and bitwise) "not" on the Value.
Multiply (5)	Multiply all elements in Left with corresponding elements in Right.
Negative	Negates all values inside AValue.
NotEqual (5)	Returns true, if Left and Right do not have equal Length and Values.
RightShift	Performs bitwise right shift of aValue.
Subtract (5)	Subtract coresponding elements in Right from Left.