Contents

type_codes

Usage:

Type userfunhelp(type_codes) for a complete list of argument type and
  shape codes to be returned by an arginfo function.

Keywords: user functions, coding

This topic lists the type and shape codes that may be used by an arginfo
function to provide information about the arguments expected by a user
function (see topic arginfo_fun).  They are all integer constants
defined in header file Userfun.h.

Scalar argument (all dimensions 1)
  CHARSCALAR, LOGICSCALAR, REALSCALAR, NONMISSINGREAL, POSITIVEREAL,
  NONNEGATIVEREAL, INTSCALAR, POSITIVEINT, NONNEGATIVEINT, LONGSCALAR,
  POSITIVELONG, NONNEGATIVELONG

Vector argument (all dimensions beyond first, if any, are 1)
  CHARVECTOR, LOGICVECTOR, REALVECTOR, NONMISSINGREALVECTOR,
  POSITIVEVECTOR, NONNEGATIVEVECTOR, INTVECTOR, POSITIVEINTVECTOR,
  NONNEGATIVEINTVECTOR, LONGVECTOR, POSITIVELONGVECTOR,
  NONNEGATIVELONGVECTOR

Matrix argument (no more than 2 dimensions >= 1)
  CHARMATRIX, LOGICMATRIX, REALMATRIX, NONMISSINGREALMATRIX,
  POSITIVEMATRIX, NONNEGATIVEMATRIX, INTMATRIX, POSITIVEINTMATRIX,
  NONNEGATIVEINTMATRIX, LONGMATRIX, POSITIVELONGMATRIX,
  NONNEGATIVELONGMATRIX

Square matrix argument
  REALSQUAREMATRIX

Array argument
  CHARARRAY, LOGICARRAY, REALARRAY, NONMISSINGREALARRAY, POSITIVEARRAY,
  NONNEGATIVEARRAY, INTARRAY, POSITIVEINTARRAY, NONNEGATIVEINTARRAY,
  LONGARRAY, POSITIVELONGARRAY, NONNEGATIVELONGARRAY

Arbitrary Symbol argument
  SYMHVALUE

The qualifiers INT, POSITIVE and NONNEGATIVE imply all elements must be
non-MISSING.

These codes are applicable both for user functions whose arguments are
pointers or handles to data, and for user functions whose arguments are
pointers or handles to MacAnova symbols.  SYMHVALUE should only be used
when symbol arguments are expected and then only when the argument is
not restricted to one type and shape or may has type different from
REAL, LOGICAL, CHARACTER or LONG.