View Raw SPL
/*****************************************************************************
*                                                                            *
*   ISCOMPLEX.SPL Copyright (C) 2000 DSP Development Corporation             *
*                               All Rights Reserved                          *
*                                                                            *
*   Author:      Randy Race                                                  *
*                                                                            *
*   Synopsis:    Returns 1 if input is complex                               *
*                                                                            *
*   Revisions:   14 Jun 2000  RRR  Creation                                  *
*                                                                            *
*****************************************************************************/


#if @HELP_ISCOMPLEX

    ISCOMPLEX

    Purpose: Returns 1 if input parameter is complex

    Syntax:  ISCOMPLEX(val)

              val - series, scalar or string input

    Returns: The scalar 1 if the input is complex or a complex
             series, else 0.

    Example:
             iscomplex(3i)

             returns 1

    Example:

             iscomplex("string")

             returns 0

    Example:

             iscomplex(fft({1, 2, 3, 4}))

             returns 1

    Remarks:
             If the input series is empty, iscomplex returns 0.


    See Also:
             Isreal

#endif



/* is input complex ? */
iscomplex(s)
{
        return(iscomplx(s));
}