VectorInt Record

Source: MtxExprInt.cs · Assembly: Dew.Math

public struct VectorInt

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

csharp
VectorInt b;
VectorInt c;
TVecInt bv;
b = VectorInt(TIntegerArray.Create(1,1,1,1)); //b = new double[] {1,1,1,1};
bv = b;   //b and bv point to same data object

bv.Multiply(2);
bv.Bitsnew double[] {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.

Properties

NameTypeDescription
BitCountInt64Allows sizing the internal storage to accomodate desired number of bits.
BlockEndBooleanReturns true, if the currrent subrange of the vector was also the last subrange in the VectorInt.
CapacityInt64Sizing the object will not allocate less than Capacity samples.
CapacityStepDoubleSpecifies increment step for the Capacity property.
CaptionStringVector Caption.
ConditionCheckBooleanEnables/disable inline condition checking.
FirstInt32First element in object Values array.
IntegerValuesStringReturns data for inspection by the debugger.
IntPrecisionTIntPrecisionDefines internal storage precision which can be either 32, 16 or 8 bit.
IsSubRangeBooleanSet to true after the SetSubIndex or SetSubRange call.
ItemInt32Allows setting/getting the real value at position Indx.
LastInt32Last element in object Values array.
LengthInt32Defines the length in number of samples.
ScaleFactorInt32Specifies the power of two for the scale factor used by some methods.
TagInt32Stores an integer value as a part of the object.

Methods

NameDescription
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)
AdoptAdopts 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.
BlockFinishDeinitializes block processing before the final block is processed.
BlockInit (4)Initializes block processing.
BlockNextObtains the next subrange of the data.
ClearSets vector size to zero.
Concat (2)Concatenates an array of TVecInt objects.
CondDisableSaves the current value of ConditionCheck property and sets it to false.
CondEnableSets 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.
ctor (4)Uses TVecInt object as internal storage.
CumSum (4)Cumulative sum.
DiagCopies the k-th diagonal from the TMtxInt object.
Difference (3)Calculate the difference for all Vec elements.
DisableSelectPrevents calls to Dew.Math.Units.MtxExprInt.Select.
DisableSubrangePrevents calls to Dew.Math.VectorInt.SetSubRange.
DistinctStores 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)
EnableSelectEnables calls to Dew.Math.Units.MtxExprInt.Select.
EnableSubrangeEnables calls to Dew.Math.VectorInt.SetSubRange.
FindFinds a match for X in object values.
FindAndGather (2)The b parameter is of Dew.Math.TMtxVecInt type.
FindAndSplit (3)The b parameter is of Dew.Math.TCplx type.
FindIndexes (5)Fills the calling vector with indexes, where the logical expression is true.
FindIndexesAndLength (2)The b parameter is of Dew.Math.TMtxVecInt type.
FindMask (5)Finds a vector mask.
GatherGather vector elements.
GatherByIncrGathers elements from X starting at Offset and with Increment to the calling object.
GatherByIndexGathers elements from X specified by indices stored in Indexes the calling object.
GatherByMaskGathers 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.
GetSchemaReturns null.
IsEqual (4)Compares two objects.
LoadFromFileReads 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 X*Y*Z
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.
ParseParses string content as vector.
PBValuesObtains a pointer to the integer value of the vector at Index.
PIValuesObtains a pointer to the integer value of the vector at Index.
PSValuesObtains a pointer to the integer value of the vector at Index.
PValuesObtains a pointer to the integer value of the vector at Index.
Ramp (3)Fills the calling vector with a series following linear rule.
RandomRampFills the calling vector elements with linear rule and randomly shuffles the indexes.
RandomShuffleRandomly shuffles the content of the vector.
ReadHeaderReads the header information from a stream to object.
ReadValuesRead values content from stream to object.
ReadXmlRead the object from the .NET XML stream.
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.
SaveToFileWrite object header and values to a file.
ScatterScatter object elements.
ScatterByIncrScatters Src elements starting at Offset and with Increment to the calling object.
ScatterByIndexesScatters Src elements defined with indices stored in Indexes to the calling object.
ScatterByMaskScatters Src elements defined with the Mask to the calling object.
SelectAllResets any defined selection.
SetFullRangeResets any defined subrange.
SetFullRangeLevelResets 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.
ToStringReturns 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.
WriteHeaderWrites the header information for the calling vector to a stream.
WriteValuesWrites object Values content to a stream.
WriteXmlWrite the object to the .NET XML stream.

Operators

NameDescription
op_Addition (5)Add coresponding elements in Left and Right.
op_BitwiseAnd (3)Computes bitwise "and" between Left and right.
op_BitwiseOr (3)Computes bitwise "or" between Left and right.
op_Division (5)Divide all elements in Left with coresponding elements in Right.
op_Equality (5)Returns true, if Left and Right are of equal Length and Values.
op_ExclusiveOr (3)Performs logical "xor" between Left and Right.
op_Explicit (9)Explicitely convert array of complex values to VectorInt.
op_GreaterThan (3)Returns true, if coresponding elements in ALeft are greater than coresponding elements in ARight.
op_GreaterThanOrEqual (3)Returns true, if coresponding elements in ALeft are greater or equal from coresponding elements in ARight.
op_Implicit (8)Implicit type conversion from VectorInt to TMtxVecBase.
op_Inequality (5)Returns true, if Left and Right do not have equal Length and Values.
op_LeftShiftPerforms bitwise left shift of aValue.
op_LessThan (3)Returns true, if coresponding elements in ALeft are greater than coresponding elements in ARight.
op_LessThanOrEqual (3)Returns true, if coresponding elements in ALeft are smaller than or equal from coresponding elements in ARight.
op_Multiply (5)Multiply all elements in Left with corresponding elements in Right.
op_OnesComplementPerforms logical (and bitwise) "not" on the Value.
op_RightShiftPerforms bitwise right shift of aValue.
op_Subtraction (5)Subtract coresponding elements in Right from Left.
op_UnaryNegationNegates all values inside AValue.