Generated from ./inc/complib/cl_math.h with ROBODoc v4.99.17 on Sun Mar 04 2007 18:17:51

[Definitions] Component Library: Math/MAX

[top][index]

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

[Definitions] Component Library: Math/MIN

[top][index]

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

[Definitions] Component Library: Math/ROUNDUP

[top][index]

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.