Generated from cl_math.h with ROBODoc v3.2.3 on Sat Jan 18 07:05:18 2003

TABLE OF CONTENTS

  1. Component Library: Math/MAX
  2. Component Library: Math/MIN
  3. Component Library: Math/ROUNDUP

Component Library: Math/MAX

NAME
    MAX

DESCRIPTION
    The MAX macro returns the greater of two values.

SYNOPSIS
    MAX( x, y );

PARAMETERS
    x 
        [in] First of two values to compare. 

    y 
        [in] Second of two values to compare. 

RETURN VALUE
    Returns the greater of the x and y parameters.

SEE ALSO
    MIN, ROUNDUP

Component Library: Math/MIN

NAME
    MIN

DESCRIPTION
    The MIN macro returns the greater of two values.

SYNOPSIS
    MIN( x, y );

PARAMETERS
    x 
        [in] First of two values to compare. 

    y 
        [in] Second of two values to compare. 

RETURN VALUE
    Returns the lesser of the x and y parameters.

SEE ALSO
    MAX, ROUNDUP

Component Library: Math/ROUNDUP

NAME
    ROUNDUP

DESCRIPTION
    The ROUNDUP macro rounds a value up to a given multiple.

SYNOPSIS
    ROUNDUP( val, align );

PARAMETERS
    val 
        [in] Value that is to be rounded up. The type of the value is 
        indeterminate, but must be at most the size of a natural integer 
        for the platform. 

    align 
        [in] Multiple to which the val parameter must be rounded up. 

RETURN VALUE
    Returns a value that is the input value specified by val rounded up to 
    the nearest multiple of align.

NOTES
    The value provided must be of a type at most the size of a natural integer.