NAME

     square_mag_Matrix - calculate the  squared  magnitude  of  a
     matrix.

SYNOPSIS

      #include <math.h>
      #include "CVIPmatrix.h"

     Matrix *square_mag_Matrix(Matrix *in)

      <in> - input Matrix;

PATH

      $CVIPHOME/MatrixAlgebra/m_magnitude.c

DESCRIPTION

     This function calculates the square of the magnitude of  the
     passed  matrix  structure  and  returns  the result in a new
     Matrix structure.

TYPES AND CONSTANTS

     See libmatrix.3

RETURN VALUES

     Pointer to matrix structure containing the squared magnitude
     of  the  Matrix at each point.  This Matrix is REAL.  If the
     input matrix format is REAL, the result  is  computed  using
     multPWise_Matrix().   If the input Matrix format is COMPLEX,
     the return matrix is of type CVIP_DOUBLE if the input Matrix
     is of type CVIP_DOUBLE, and of type CVIP_FLOAT otherwise.

HISTORY

     History information recorded: None

EXAMPLE


BUGS

     None at this time

SEE ALSO

     libmatrix, mag_Matrix()

AUTHOR

     Copyright (C) 1996 SIUE - by Scott Umbaugh and Arve Kjoelen