Overload List
| # | Signature | Description |
|---|---|---|
| 1 | void SetSubRange(int Index, int Len) const; | Defines a sub Matrix/matrix. |
| 2 | void SetSubRange(TDenseMtxVec *Src, int Index, int Len) const; | Defines a sub Matrix/matrix. |
| 3 | void SetSubRange(TMtxVec *Src, int Index, int aRows, int aCols) const; | Defines a sub vector/matrix. |
| 4 | void SetSubRange() const; | Sets the subarray size to full size. This method is the same as the Matrix::SetFullRange method. |
Overload 1: void SetSubRange(int Index, int Len) const;
Defines a sub Matrix/matrix.
| # | Name | Type | Description |
|---|---|---|---|
| 1 | Index | int | |
| 2 | Len | int |
The method will define a subarray starting at Index and ending at Index+Len-1. No copying will occur, only pointers will be shifted. All values of the original Vector will be preserved. An exception will be raised if an attempt is made to change the size of calling object.
A sub-Matrix/matrix is Matrix/matrix which does not neccessarily have its own memory allocated. Instead it adopts the memory of the source object and all operations done on the either of the objects affect the same elements. The use of subvectors/submatrices increases CPU cache reuse, lower's memory requirements, increases application performance and improves code readability.
To again obtain a view of the full Matrix/matrix, see Matrix::SetFullRange
Overload 2: void SetSubRange(TDenseMtxVec *Src, int Index, int Len) const;
Defines a sub Matrix/matrix.
| # | Name | Type | Description |
|---|---|---|---|
| 1 | Src | TDenseMtxVec * | |
| 2 | Index | int | |
| 3 | Len | int |
Overload 3: void SetSubRange(TMtxVec *Src, int Index, int aRows, int aCols) const;
Defines a sub vector/matrix.
| # | Name | Type | Description |
|---|---|---|---|
| 1 | Src | TMtxVec * | |
| 2 | Index | int | |
| 3 | aRows | int | |
| 4 | aCols | int |
The method will define a subarray starting at Index and ending at Index + (aRows*aCols)-1. No copying will occur, only pointers will be shifted or indices adjusted. The subranged matrix will have the size aRows and aCols. Length will be equal to aRows*aCols.
All values of the original TMtxVecBase will be preserved. An exception will be raised if an attempt is made to change the size of calling object.
A sub-vector/matrix is vector/matrix, which does not have its own memory allocated. Instead it adopts the memory of the source object and all operations done on either of the objects affect the same elements. The use of subvectors/submatrices increases CPU cache reuse, lower's memory requirements, increases application performance and improves code readability.
To again obtain a view of the full vector/matrix, see TMtxVecBase::SetFullRange
The routine only makes sense to be used where aCols matches Src.Cols. MtxVec has only limited support for matrices where the matrix rows are not stored strictly consecutively. This overload is to be used with great caution.
The routine should not be mixed with other SetSubRange routines or subrange stack.
Overload 4: void SetSubRange() const;
Sets the subarray size to full size. This method is the same as the Matrix::SetFullRange method.