next up previous contents
Next: ABS Absolute Value Function Up: Elementary Functions Previous: REAL Real Function   Contents

Subsections

IMAG Imaginary Function

Usage

Returns the imaginary part of the input array for all elements. The general syntax for its use is

   y = imag(x)

where x is an n-dimensional array of numerical type. The output is the same numerical type as the input, unless the input is complex or dcomplex. For complex inputs, the imaginary part is a floating point array, so that the return type is float. For dcomplex inputs, the imaginary part is a double precision floating point array, so that the return type is double. The imag function returns zeros for real and integer types.

Example

The following demonstrates imag applied to a complex scalar.

--> imag(3+4*i)
ans = 
  <float>  - size: [1 1]
    4.0000000

The imaginary part of real and integer arguments is a vector of zeros, the same type and size of the argument.

--> imag([2,4,5,6])
ans = 
  <int32>  - size: [1 4]
 
Columns 1 to 4
             0              0              0              0

For a double-precision complex array,

--> imag([2.0+3.0*i,i])
ans = 
  <double>  - size: [1 2]
 
Columns 1 to 2
    3.000000000000000         1.000000000000000



Samit K. Basu 2005-03-16