Previous IDL Reference Guide: Procedures and Functions Next

UINT

Syntax | Return Value | Arguments | Keywords | Examples | Version History | See Also

The UINT function returns a result equal to Expression converted to unsigned integer type.

Syntax

Result = UINT( Expression[Offset [D1 [, ..., D8]]] )

Return Value

Returns an unsigned integer value or array of the same dimensions as the result of the Expression. If Expression is a complex number, UINT returns the real part.

Arguments

Expression

The expression to be converted to unsigned integer.

Offset

Offset from beginning of the Expression data area. Specifying this argument allows fields of data extracted from Expression to be treated as unsigned integer data. See the description in Working with Data in IDL for details.

Di

When extracting fields of data, the Di arguments specify the dimensions of the result. If no dimension arguments are given, the result is taken to be scalar.

The Di arguments can be either an array or a series of scalar expressions specifying the dimensions of the result. If a single argument is specified, it can be either a scalar expression or an array of up to eight elements. If multiple arguments are specified, they must all be scalar expressions. Up to eight dimensions can be specified.

When converting from a string argument, it is possible that the string does not contain a valid integer and no conversion is possible. The default action in such cases is to print a warning message and return 0. The ON_IOERROR procedure can be used to establish a statement to be jumped to in case of such errors.

Keywords

Thread Pool Keywords

This routine is written to make use of IDL's thread pool, which can increase execution speed on systems with multiple CPUs. The values stored in the !CPU system variable control whether IDL uses the thread pool for a given computation. In addition, you can use the thread pool keywords TPOOL_MAX_ELTS, TPOOL_MIN_ELTS, and TPOOL_NOTHREAD to override the defaults established by !CPU for a single invocation of this routine. See Thread Pool Keywords for details.

Examples

If A contains the floating-point value 32000.0, it can converted to an unsigned integer and stored in the variable B by entering:

B = UINT(A)  

Version History

5.2
Introduced

See Also

BYTE, COMPLEX, DCOMPLEX, DOUBLE, FIX, FLOAT, LONG, LONG64, STRING, ULONG, ULONG64

  IDL Online Help (March 06, 2007)