Matrix.PolynomialRoots(Variable, Matrix) Method

Top

Description

Returns the number of roots of the polynomial. The user can specify whether or not to return imaginary roots.

Timing Precision Mode

This page describes functionality in millisecond timing precision mode. Millisecond timing precision mode is deprecated and will be removed in a future release. We recommend that you migrate your Mission Plans to nanosecond timing precision mode.

Click here to see the documentation for this object in nanosecond timing precision mode.

Method Signature

Matrix.PolynomialRoots(	Variable rootsType,
	Matrix roots)

Arguments

rootsType

Description:

The type of the roots of the polynomial that will be calculated.

Valid Values:

Value	Label
0	Real roots only
1	Real and Imaginary roots

roots
Description:	A matrix containing the roots of the polynomial.

Return Value

Type:

number

Returns the number of real roots of the polynomial. Returns -1 if an error was encountered in the calculation.

Syntax

myVariable1 = myMatrix1.PolynomialRoots(myVariable2, myMatrix2);