Overload List
| # | Signature | Description |
|---|---|---|
| 1 | TMtxVec *Mag() const; | Magnitude. |
| 2 | TMtxVec *Mag(int Index, int Len) const; | Calculate the magnitude for calling object elements [Index]..[Index+Len-1] in-place. |
| 3 | TMtxVec *Mag(TMtxVec *X) const; | Calculate the magnitude for all X elements and store the results in the calling object elements. |
| 4 | TMtxVec *Mag(TMtxVec *X, int XIndex, int Index, int Len) const; | Calculate the magnitude for X elements [XIndex]..[XIndex+Len-1] and store the results in the calling object elements [Index]..[Index+Len-1]. |
Overload 1: TMtxVec *Mag() const;
Magnitude.
Calculate the magnitude for all calling object elements in-place. This method has the same function as the Matrix::Abs method.
Overload 2: TMtxVec *Mag(int Index, int Len) const;
Calculate the magnitude for calling object elements [Index]..[Index+Len-1] in-place.
| # | Name | Type | Description |
|---|---|---|---|
| 1 | Index | int | |
| 2 | Len | int |
An exception is raised if Matrix::ConditionCheck is True and array borders are overrun.
Overload 3: TMtxVec *Mag(TMtxVec *X) const;
Calculate the magnitude for all X elements and store the results in the calling object elements.
| # | Name | Type | Description |
|---|---|---|---|
| 1 | X | TMtxVec * |
Size and and Matrix::Complex properties of the calling Matrix are set implicitly to match Vec Matrix.
Overload 4: TMtxVec *Mag(TMtxVec *X, int XIndex, int Index, int Len) const;
Calculate the magnitude for X elements [XIndex]..[XIndex+Len-1] and store the results in the calling object elements [Index]..[Index+Len-1].
| # | Name | Type | Description |
|---|---|---|---|
| 1 | X | TMtxVec * | |
| 2 | XIndex | int | |
| 3 | Index | int | |
| 4 | Len | int |
Size and Matrix::Complex properties of the calling object must be set explicitly. An exception is raised if Matrix::ConditionCheck is True and array borders are overrun.