Share via

2.5.4.65 Magnitude

  • Article

The Magnitude function performs a magnitude calculation of a vector.

ABNF:

 Magnitude = val val val val " MAGNITUDE():128"

Required Arguments:

Name: ConstantRise

Type: vDouble

An argument that specifies the constant factor for the rise.

Name: Rise

Type: vDouble

An argument that specifies the rise of the vector.

Name: ConstantRun

Type: vDouble

An argument that specifies the constant factor for the run.

Name: Run

Type: vDouble

An argument that specifies the run of the vector.

Return Value:

Type: PtgNum, PtgErr

The function returns a PtgNum containing the calculated magnitude. The magnitude calculation is performed using the following formula:

SQRT( (ConstantRise*Rise)^2 + (ConstantRun*Run)^2) )

If Rise or Run is a PtgNumMultiDim, the function returns a PtgErr with an error code of #DIM!.