Man Page Intro.3m




NAME

     Intro, intro - introduction to  mathematical  library  func-
     tions and constants


SYNOPSIS

     #include <sys/ieeefp.h>

     #include <floatingpoint.h>

     #include <math.h>

     #include <sunmath.h>


DESCRIPTION

     <sys/ieeefp.h> and <floatingpoint.h>  define  certain  types
     and  constants  used  for libm and libsunmath exception han-
     dling, conforming to ANSI/IEEE Std 754-1985, the IEEE  Stan-
     dard for Binary Floating-Point Arithmetic.

     The include file <math.h> is located in the operating system
     area  under /usr/include.  <math.h> contains declarations of
     all the functions documented in the operating system  manual
     page area under /usr/man/man3m comprising the operating sys-
     tem math library, libm located under /usr/lib.   C  programs
     should  be  linked  with the -lm option in order to use this
     library.

     The include file <sunmath.h> is located in the compiler pro-
     ducts  area,  typically under /opt/SUNWspro/prod/include/cc.
     <sunmath.h> contains declarations of all the functions docu-
     mented  in  the 3m section of the compiler manual page area,
     typically under /opt/SUNWspro/man, which comprises the  com-
     piler value-added math library libsunmath, located typically
     under /opt/SUNWspro/lib.  C programs should be  linked  with
     the -lsunmath -lm option in order to use this library.  Note
     that the location of <sunmath.h> and libsunmath  can  change
     between releases.



IEEE EXCEPTION HANDLING

     The C compiler flag of -xlibmieee should be used if the user
     prefers exception handling of the math libraries routines in
     the spirit of IEEE754-1985.

     The IEEE Standard specifies  exception  handling  for  ceil,
     floor,  remainder,  rint  and sqrt, and suggests appropriate
     exception handling for copysign, fabs, fmod,  isnan,  ilogb,
     ldexp,  logb,  nextafter,  scalb  and  scalbn,  but does not
     specify exception handling for the other libm or  libsunmath
     functions.


     For these other unspecified functions the spirit of the IEEE
     Standard  is  generally  followed  in libm and libsunmath by
     handling invalid operand, singularity  (division  by  zero),
     overflow,  and underflow exceptions, as much as possible, in
     the same way they are handled for the fundamental  floating-
     point operations such as addition and multiplication.

     These unspecified functions are usually not quite  correctly
     rounded,  may  not observe the optional rounding directions,
     and may not set the inexact exception correctly.


IEEE ENVIRONMENT

     The IEEE Standard specifies modes  for  rounding  direction,
     precision,  and  exception  trapping,  and status reflecting
     accrued exceptions.  These modes and status  constitute  the
     IEEE run-time environment.





































LIST OF BUNDLED MATH LIBRARY FUNCTIONS

     Name                Appears on Page     Description

     acos()              acos(3M)            inverse trigonometric function
     acosh()             acosh(3M)           inverse hyperbolic function
     asin()              asin(3M)            inverse trigonometric function
     asinh()             acosh(3M)           inverse hyperbolic function
     atan()              atan(3M)            inverse trigonometric function
     atan2()             atan2(3M)           rectangular to polar conversion
     atanh()             acosh(3M)           inverse hyperbolic function
     cbrt()              cbrt(3M)            cube root
     ceil()              ceil(3M)            ceiling function
     copysign()          copysign(3M)        copy sign bit
     cos()               cos(3M)             trigonometric function
     cosh()              cosh(3M)            hyperbolic function
     erf()               erf(3M)             error function
     erfc()              erf(3M)             complementary error function
     exp()               exp(3M)             exponential function
     expm1()             expm1(3M)           exp(X)-1
     fabs()              fabs(3M)            absolute value function
     floor()             floor(3M)           floor function
     fmod()              fmod(3M)            floating-point remainder
     hypot()             hypot(3M)           Euclidean distance
     ilogb()             ilogb(3M)           exponent extraction
     isnan()             isnan(3M)           IEEE classification
     j0()                j0(3M)              Bessel function
     j1()                j0(3M)              Bessel function
     jn()                j0(3M)              Bessel function
     lgamma()            lgamma(3M)          log gamma function
     lgamma_r()          lgamma(3M)          log gamma function
     log()               log(3M)             natural logarithm
     log10()             log10(3M)           common logarithm
     log1p()             log1p(3M)           log(1+X)
     logb()              logb(3M)            exponent extraction
     matherr()           matherr(3M)         math library exception-handling routines
     nextafter()         nextafter(3M)       IEEE nearest neighbor
     pow()               pow(3M)             power X**Y
     remainder()         remainder(3M)       floating-point remainder
     rint()              rint(3M)            convert to integral value in floating-point format
     scalb()             scalb(3M)           exponent adjustment
     scalbn()            scalbn(3M)          exponent adjustment
     significand()       significand(3M)     scalb(x,-ilogb(x))
     sin()               sin(3M)             trigonometric function
     sinh()              sinh(3M)            hyperbolic function
     sqrt()              sqrt(3M)            square root
     tan()               tan(3M)             trigonometric function
     tanh()              tanh(3M)            hyperbolic function
     y0()                y0(3M)              Bessel function
     y1()                y0(3M)              Bessel function
     yn()                y0(3M)              Bessel function



LIST OF UNBUNDLED MATH LIBRARY FUNCTIONS IN LIBSUNMATH

     Name                     Appears on Page     Description

     -                        addrans(3M)         additive pseudo-random number generators
     -                        ieee_sun(3M)        IEEE classification
     -                        ieee_values(3M)     double-precision IEEE extreme values
     -                        lcrans(3M)          linear congruential pseudo-random number generators
     -                        mwcrans(3M)         multiply-with-carry pseudo-random number generators
     -                        shufrans(3M)        random number shufflers
     -                        trig_sun(3M)        trigonometric functions
     acosd()                  trig_sun(3M)        inverse trigonometric function
     acosp()                  trig_sun(3M)        inverse trigonometric function
     acospi()                 trig_sun(3M)        inverse trigonometric function
     aint()                   aint(3M)            convert to integral value in floating-point format
     anint()                  aint(3M)            convert to integral value in floating-point format
     annuity()                exp2(3M)            financial
     asind()                  trig_sun(3M)        inverse trigonometric function
     asinp()                  trig_sun(3M)        inverse trigonometric function
     asinpi()                 trig_sun(3M)        inverse trigonometric function
     atan2d()                 trig_sun(3M)        rectangular to polar conversion
     atan2pi()                trig_sun(3M)        rectangular to polar conversion
     atand()                  trig_sun(3M)        inverse trigonometric function
     atanp()                  trig_sun(3M)        inverse trigonometric function
     atanpi()                 trig_sun(3M)        inverse trigonometric function
     compound()               exp2(3M)            financial
     convert_external()       convert_external(3M)convert between binary formats
     cosd()                   trig_sun(3M)        trigonometric function
     cosp()                   trig_sun(3M)        trigonometric function
     cospi()                  trig_sun(3M)        trigonometric function
     exp10()                  exp2(3M)            10**X
     exp2()                   exp2(3M)            2**X
     fp_class()               ieee_sun(3M)        classify operand
     ieee_flags()             ieee_flags(3M)      IEEE modes and status
     ieee_handler()           ieee_handler(3M)    IEEE trapping
     infinity()               ieee_values(3M)     double-precision IEEE infinity
     irint()                  aint(3M)            convert to integral value in integer format
     isinf()                  ieee_sun(3M)        IEEE classification
     isnormal()               ieee_sun(3M)        IEEE classification
     issubnormal()            ieee_sun(3M)        IEEE classification
     iszero()                 ieee_sun(3M)        IEEE classification
     log2()                   exp2(3M)            log base 2
     max_normal()             ieee_values(3M)     double-precision IEEE largest positive normalized number
     max_subnormal()          ieee_values(3M)     double-precision IEEE largest positive subnormal number
     min_normal()             ieee_values(3M)     double-precision IEEE smallest positive normalized number
     min_subnormal()          ieee_values(3M)     double-precision IEEE smallest positive subnormal number
     nint()                   aint(3M)            convert to integral value in integer format
     nonstandard_arithmetic() ieee_sun(3M)        miscellaneous
     quad_precision()         quad_precision(3M)  quadruple-precision libm access
     quiet_nan()              ieee_values(3M)     double-precision IEEE quiet NaN
     signaling_nan()          ieee_values(3M)     double-precision IEEE signaling NaN
     signbit()                ieee_sun(3M)        IEEE sign bit test
     sincos()                 trig_sun(3M)        simultaneous sin and cos
     sincosd()                trig_sun(3M)        simultaneous sin and cos
     sincosp()                trig_sun(3M)        simultaneous sin and cos
     sincospi()               trig_sun(3M)        simultaneous sin and cos
     sind()                   trig_sun(3M)        trigonometric function
     single_precision()       single_precision(3M)single-precision libm access
     sinp()                   trig_sun(3M)        trigonometric function
     sinpi()                  trig_sun(3M)        trigonometric function
     standard_arithmetic()    ieee_sun(3M)        miscellaneous
     tand()                   trig_sun(3M)        trigonometric function
     tanp()                   trig_sun(3M)        trigonometric function
     tanpi()                  trig_sun(3M)        trigonometric function