fpp_get_rounding_mode()

FPP_$GET_ROUNDING_MODE            Domain/OS             FPP_$GET_ROUNDING_MODE


NAME
     fpp_$get_rounding_mode - report the current rounding mode

SYNOPSIS (C)
     #include <apollo/base.h>
     #include <apollo/fpp.h>

     void fpp_$get_rounding_mode(
          fpp_$rounding_mode_t *rounding_mode,
          status_$t *status)

SYNOPSIS (Pascal)
     %include '/sys/ins/base.ins.pas';
     %include '/sys/ins/fpp.ins.pas';

     procedure fpp_$get_rounding_mode(
          out rounding_mode: fpp_$rounding_mode_t;
          out status: status_$t);

SYNOPSIS (FORTRAN)
     %include '/sys/ins/base.ins.ftn'
     %include '/sys/ins/fpp.ins.ftn'

           integer*2 rounding_mode
           integer*4 status

           call fpp_$get_rounding_mode(rounding_mode, status)

DESCRIPTION
     Fpp_$get_rounding_mode reports the current IEEE-754 rounding mode of the
     floating-point unit.  If the floating-point unit does not support IEEE-
     754 rounding modes, fpp_$get_rounding_mode returns with status set to
     fpp_$unsupported_operation.

     rounding_mode
          An enumerated value describing the floating-point unit's current
          rounding mode.  It can have any one of the following values:

          fpp_$round_to_nearest
               The floating-point unit is in round to nearest representable
               value mode.  This is the default rounding mode.

          fpp_$round_to_negative
               The floating-point unit is in round to negative infinity (round
               down) mode.

          fpp_$round_to_positive
               The floating-point unit is in round to positive infinity (round
               up) mode.

          fpp_$round_to_zero
               The floating-point unit is in round toward 0 mode.

     status
          The completion status.
Museum
