HMRES_complexnumbersform()

Sets the form of the complex number that hmreslib is expecting.

Syntax

void HMRES_complexnumbersform(int form);

Type

HyperMesh hmreslib Function

Description

Sets the form of the complex number that hmreslib is expecting.

Inputs

form
Determines the form of the complex number.
  • 0 - The default value; tells hmreslib to expect complex numbers in polar (magnitude/phase format.)
  • 1 - Tells hmreslib to expect complex numbers in real/imaginary format.

Example

By default, hmreslib expects complex numbers to be in polar (magnitude/phase) format; this is the same as calling HMRES_complexnumbersform() with a form set to zero. Setting form to one and calling this function makes hmreslib accept complex numbers in real/imaginary format. This changes the meaning of the functions that pass complex numbers to hmreslib in that you should pass the real and imaginary part of the complex number where the function would by default expect magnitude and phase.

Errors

None.