class TMtxByte : public TMtxInt;
Class for 8bit two dimensional integer arrays.
Class for accessing and manipulating 8bit two dimensional arrays. It handles memory allocation and basic vector arithmetics.
Constructors
| Name | Description |
|---|---|
| TMtxByte (2) |
Properties
| Name | Type | Description |
|---|---|---|
| ActualSize | long long | For internal use only. Read to get the amount of memory allocated in number of doubles (8byte packs). |
| BlockEnd | bool | Returns true, if the currrent subrange of the vector was also the last subrange in the vector. |
| CacheIndex | int | For internal use only. Read to get the index of this object in object cache. |
| Capacity | long long | Sizing the object will not allocate less than Capacity. |
| CapacityInBytes | long long | Sizing the object will not allocate less than CapacityInBytes. |
| CapacityInElements | long long | Sizing the object will not allocate less than CapacityInElements. |
| CapacityStep | double | Specifies increment step for the Capacity property. |
| Caption | DewString | Caption. |
| Cols | int | Defines the number of matrix columns. |
| ColsBitCount | int | Defines number of bits stored in one row. |
| ConditionCheck | bool | Enables/disable inline condition checking. |
| First | int | First element in object Values array. |
| IntegerValues | DewString | Returns content as a string suitable for display as a tooltip. |
| IntPrecision | TIntPrecision | Defines internal storage precision which can be either 32, 16 or 8 bit. |
| IntPrecisionLock | bool | Prevents change to IntPrecision if Lock = True. |
| IsDouble | bool | Defines the precision (single or double) of the floating point operations. |
| IsSubRange | bool | Set to true after the SetSubIndex or SetSubRange call. |
| Last | int | Last element in object Values array. |
| LeadingCols | int | Defines the number of leading columns. |
| Length | int | Defines the length in number of samples. |
| MtxVecType | TMtxVecType | |
| OnSetSize | TMtxNotifyEvent | Called when object size changes. |
| PoolIndex | int | Internal. |
| Rows | int | Defines the number of matrix rows. |
| ScaleFactor | int | Specifies the power of two for the scale factor used by some methods. |
| Tag | int | Stores an integer value as part of a TMtxVec object. |
Methods
| Name | Description |
|---|---|
| Abs (4) | Absolute values. |
| Add (12) | Add coresponding elements in Src2 to Src1. |
| AddAndMul (26) | Compute (X + Y)*Z |
| AddRef | |
| AddScaled (10) | Compute X + Y*yScale |
| AddScaledC (4) | Compute X + Y*yScale + zScalar |
| AddScaledSqr (4) | Compute sqr(X + Y*yScale) |
| Adopt | Adopts a pointer to one dimensional array. |
| Assign | |
| BinaryAnd (8) | Apply binary "and" between coresponding elements in Src1 and Src2. |
| BinaryNot (4) | Applies binary "not" operation to elements stored in the object. |
| BinaryOr (8) | Apply binary "or" between coresponding elements in Src1 and Src2. |
| BinarySearch (4) | Finds a match for X in object values using binary search. |
| BinaryXor (8) | Apply binary "xor" between elements in the calling object and Value. |
| BitPack (2) | Converts Src to packed bit storage. |
| Bits | |
| BitShift (4) | Apply binary shift by number of Bits to the left (positive) or right (negative) for all elements in the calling object. |
| BitShiftLeft (4) | Apply binary shift by number of Bits to the left for all elements in the calling object. |
| BitShiftRight (4) | Apply binary shift by number of Bits to the right for all elements in the calling object. |
| BitSize | Sizes the matrix according to bit storage required. |
| BitUnpack (2) | Converts Src to unpacked 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. |
| BlockSubRangeLevel | Returns the current subrange stack level used by block processing functions. |
| BValues (2) | |
| BValues1D | |
| Clear | |
| ColExchange | Exchange matrix columns. |
| ColPermute | Permute the columns of the Src matrix. |
| Concat | Concatenate an array of matrices to single matrix. |
| ConcatHorz (2) | Concenates an array of matrices horizontally. |
| ConcatVert (2) | Concenates an array of matrices vertically. |
| 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 (4) | Copy object values. |
| CopyFromArray (24) | Copies values from a real Src array. |
| CopyToArray (19) | Copies values from the calling object to the Dst array and converts values to to 2 byte signed integer numbers. |
| CopyVec (2) | Copies values from vector to a matrix. |
| CountInRange (2) | Returns number of values within the interval. |
| CreateCached | |
| CreateFromCache | Obtain a pointer to a matrix from object cache. |
| CumSum (4) | Cumulative sum. |
| DataIndex (4) | |
| DefArray | |
| DefaultArray | |
| Diag | Sets the matrix diagonal to values from the vector. |
| Difference | Difference. |
| DisableSelect | Prevents calls to TMtxByte::Select. |
| DisableSubrange | Prevents calls to TMtxByte::SetSubRange. |
| Disown (2) | Disowns a pointer to an array from matrix Values1D. |
| DivAndAdd (12) | Compute X/Y + Z |
| DivAndSub (12) | Compute X/Y - Z |
| Divide (12) | Divides coresponding elements in Src1 with Src2. |
| DivideBy (4) | Divide Value with calling vector elements. |
| DivideC (2) | Compute X / (Y*zScale) |
| EnableSelect | Enables calls to TMtxByte::Select. |
| EnableSubrange | Enables calls to TMtxByte::SetSubRange. |
| Equal | Compares two matrices. |
| Eye | Constructs an eye matrix. |
| Find (2) | Finds a match for X in object values. |
| FindIndexes (2) | Finds matching indexes. The b parameter is of integer type. |
| FindIndexesAndLength (2) | Finds matching indexes and returns their count. The b parameter is of integer type. |
| FindMask (4) | Finds a vector mask. |
| FlipHor (2) | Flips the matrix elements horizontally. |
| FlipVer (2) | Flips the matrix elements vertically |
| FreeCached | |
| FreeToCache | |
| get_BValues (2) | |
| get_BValues1D | |
| get_DefaultArray | |
| get_IValues (2) | |
| get_IValues1D | |
| get_SValues (2) | |
| get_SValues1D | |
| GetBits | |
| GetCapacity | |
| GetCapacityInElements | |
| GetObjectToByteArray | Copies object to an array of bytes. |
| IndexOf | Returns the 1D index in to the matrix. |
| IsEqual (4) | Compares Value with all calling object elements. |
| IValues (2) | |
| IValues1D | |
| Kron | The Kronecker product between two vectors. |
| LoadFromFile | Reads the header information and the values array content from the file. |
| LoadFromStream | Load the list from a stream. |
| LogicalNot (4) | Applies logical "not" operation to elements stored in the object. |
| LowerTriangle | Constructs lower triangular matrix. |
| Max (4) | Maximum value. |
| MaxCols | Compute maximum of each column. |
| MaxEvery (4) | Vectorised maximum. |
| MaxMin (2) | Calculate minimum and maximum in one procedure call. |
| MaxMinCols | Compute maximum and minimum of each column. |
| MaxMinIdx (2) | Calculate minimum, maximum and their indices in one procedure call. |
| MaxMinRows | Compute maximum and minimum of each row. |
| MaxRows | Compute maximum of each row. |
| Median (4) | Applies median filter with size Mask to the calling vector elements [Index.. Index+Len-1]. |
| Min (4) | Minimum value. |
| MinCols | Compute minimum of each column. |
| MinEvery (4) | Vectorised minimum. |
| MinRows | Compute minimum of each row. |
| Mul (4) | Compute X*Y*Z |
| MulAndAdd (14) | Compute X*Y + Z |
| MulAndDiv (6) | Compute X * Y / Z |
| MulAndSub (14) | Compute X*Y - Z |
| MulElem (2) | Matrix array multiplication. |
| Multiply (8) | Multiplies coresponding elements in Src2 with Src1. |
| Parse | Parses string content as vector. |
| PBValues (2) | Obtains a pointer to the 8bit unsigned integer value of the vector at Index. |
| PIValues (2) | Obtains a pointer to the 32bit signed integer value of the vector at Index. |
| PSValues (2) | Obtains a pointer to the 16bit signed integer value of the vector at Index. |
| PValues (2) | Obtains a pointer to the integer value of the vector at Index. |
| Ramp | Fills the calling vector elements [Index]..[Index+Len-1]. |
| ReadHeader | |
| ReadValues | Read values content from stream to object. |
| Release | |
| RemDiv (6) | Divide all Src elements with Value elements and store result of division in the calling object and reminder in RemDst. |
| Reset | |
| Resize (2) | Resizes the matrix, while preserving the values in already allocated memory. |
| ResizeAndTranspose | Resize and transpose. |
| Reverse (2) | Reverse vector elements. |
| Rotate (2) | A cyclic shift on vector elements in range. |
| Rotate90 (2) | Rotates matrix Rows 90 degrees clockwise. |
| RowExchange | Exchanges two matrix Rows. |
| RowPermute | Permute the Rows of the Src matrix. |
| SaveToFile | Write object header and values to a file. |
| SaveToMatrixMarketFile | Saves matrix data to MatrixMarket ASCII file format. |
| SaveToStream | Save the list to a stream. |
| 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. |
| Select (2) | Selects a set of elements from the vector. |
| SelectAll | Resets any defined selection. |
| set_BValues (2) | |
| set_BValues1D | |
| set_DefaultArray (2) | |
| set_IValues (2) | |
| set_IValues1D | |
| set_SValues (2) | |
| set_SValues1D | |
| SetBits | |
| SetCapacity | |
| SetCapacityInElements | |
| SetCol (2) | Copies values from vector to matrix column. |
| SetFullRange | Resets subrange defined with SetSubRange. |
| SetFullRangeLevel | Pops the current subrange stack one level up. |
| SetIntPrecision | |
| SetIt (2) | Sets matrix values. |
| SetLength | |
| SetObjectFromByteArray | Reads the properties of the object from the array of bytes. |
| SetRow (2) | Copies values from vector to matrix row. |
| SetSubIndex | Defines a subarray. |
| SetSubRange (4) | Defines a sub vector/matrix. |
| SetSubRangeLevel (2) | Defines a sub vector/matrix and pushes any previous subranges on to a stack. |
| SetVal (3) | Set all calling object elements [Index]..[Index+Len-1] to Value. |
| SetZero (3) | Set all calling vector elements to zero. |
| Shift (2) | Perform a shift on vector elements in range. |
| Size (4) | Sets the size of matrix. |
| SizeFromArray (3) | Sizes the calling matrix to match the size of the array. |
| SizeToArray (11) | Sizes the array. |
| SortAscend (4) | Sort calling vector elements [Index..Index+Len-1] in ascending order in-place. |
| SortDescend (4) | Sort calling vector elements [Index..Index+Len-1] in descending order in-place. |
| Split | Splits matrix in blocks. |
| SqrAddScaled (4) | Compute sqr(X) + sqr(Y)*yScale |
| StringsToValues (5) | Convert strings to integers and store them in the Values array. |
| Sub (4) | Compute X - Y - Z |
| SubAndMul (26) | Compute (X - Y)*Z |
| SubRangeLevel | Returns the current subrange stack level. |
| SubScaled (6) | Compute X - Y*yScale - Z*zScale |
| SubScaledC (4) | Compute X - Y*yScale - zScalar |
| Subtract (8) | Subtract coresponding elements in Src2 from Src1. |
| SubtractFrom (4) | Subtract all calling vector elements from integer Value. |
| Sum (2) | Sums vector values. |
| SumCols | Calculates the sum of each of the calling matrix columns. |
| SumRows | Calculates the sum of each of the calling matrix Rows. |
| SValues (2) | |
| SValues1D | |
| TensorProd | Calculates the tensor product of two vectors. |
| TextToValues | |
| ThreshAbsGT (4) | Threshold top and bottom centered around zero. |
| ThreshAbsLT (4) | Threshold top and bottom centered around zero. |
| ThreshBottom (4) | Threshold bottom operation. |
| ThresholdGT_LT (4) | Threshold greater than and less than operation. |
| ThreshTop (4) | Threshold top operation. |
| ToolTip | |
| ToString | Returns content as a string. |
| Transp (2) | Transposes matrix. |
| UpperTriangle | Constructs upper triangular matrix. |
| ValidateCplxArrayIndexes | |
| ValidateParams (4) | |
| ValidateParams2 | |
| ValidateRealArrayIndexes | |
| Values | |
| ValuesToStrings (5) | Converts the content of the matrix Values array to a list of strings. |
| ValuesToText (2) | Converts all calling matrix elements to string. |
| WriteHeader | |
| WriteValues |
Operators
| Name | Description |
|---|---|
| operator!= (4) | Returns true, if Left and Right do not have equal Rows, Cols, IntPrecision and Values. |
| operator& (2) | Computes bitwise "and" between Left and right. |
| operator() | |
| operator* (2) | Multiply all elements in Left with corresponding elements in Right. |
| operator+ (2) | Add coresponding elements in Left and Right. |
| operator- (2) | Subtract coresponding elements in Right from Left. |
| operator/ (2) | Divide all elements in Left with coresponding elements in Right. |
| operator== (4) | Returns true, if Left and Right have equal Rows, Cols, IntPrecision and Values. |
| operator^ (2) | Performs logical "xor" between Left and Right. |
| operator| (2) | Computes bitwise "or" between Left and right. |
Fields
| Name | Type | Description |
|---|---|---|
| BData | DewArray<unsigned char> | |
| FBDataOffset | int | |
| FIDataOffset | int | |
| fRefCount | int | |
| FSDataOffset | int | |
| IData | DewArray<int> | |
| SData | DewArray<short> | |
| ThreadID | long long |