Vector Math Library Functions                       vsqrt(3MVEC)



NAME
     vsqrt, vsqrtf - vector square root functions

SYNOPSIS
     cc [ flag... ] file... -lmvec [ library... ]

     void vsqrt(int *n, double * restrict x, int *stridex,
          double * restrict y, int *stridey);


     void vsqrtf(int *n, float * restrict x, int *stridex,
          float * restrict y, int *stridey);


DESCRIPTION
     These functions evaluate the function sqrt(x) for an  entire
     vector  of values at once. The first parameter specifies the
     number of values to compute. Subsequent  parameters  specify
     the argument and result vectors. Each vector is described by
     a pointer to the first element and a stride,  which  is  the
     increment between successive elements.


     Specifically, vsqrt(n, x, sx, y, sy) computes y[i * *sy]  =
     sqrt(x[i  *  *sx])  for  each  i  =  0,  1, ..., *n - 1. The
     vsqrtf() function performs the same computation for  single
     precision data.


     Unlike their scalar counterparts,  these  functions  do  not
     always deliver correctly rounded results. However, the error
     in each non-exceptional result is less than one unit in  the
     last place.

USAGE
     The element count *n must be greater than zero. The  strides
     for   the  argument  and  result  arrays  can  be  arbitrary
     integers, but the arrays themselves must not be the same  or
     overlap.  A zero stride effectively collapses an entire vec-
     tor into a single element. A negative stride causes a vector
     to be accessed in descending memory order, but note that the
     corresponding pointer must still point to the first  element
     of  the  vector  to be used; if the stride is negative, this
     will be the highest-addressed element in memory.  This  con-
     vention differs from the Level 1 BLAS, in which array param-
     eters always refer to the lowest-addressed element in memory
     even when negative increments are used.


     These functions assume  that  the  default  round-to-nearest
     rounding  direction  mode  is in effect. On x86, these func-
     tions also assume that the default round-to-64-bit  rounding



SunOS 5.11          Last change: 14 Dec 2007                    1






Vector Math Library Functions                       vsqrt(3MVEC)



     precision  mode is in effect. The result of calling a vector
     function with a non-default rounding mode in effect is unde-
     fined.


     These functions handle special  cases  and exceptions in the
     same  way  as the sqrt() functions  when  c99  MATHEREXCEPT
     conventions are in effect. See sqrt(3M) for  the results for
     special cases.


     An application wanting to check for exceptions  should  call
     feclearexcept(FEALEXCEPT) before calling these functions.
     On  return,  if  fetestexcept(FEINVALID    FEDIVBYZERO  
     FEOVERFLOW    FEUNDERFLOW)  is non-zero, an exception has
     been raised. The application can then examine the result  or
     argument  vectors  for exceptional values. Some vector func-
     tions can raise the inexact exception even if  all  elements
     of  the  argument  array are such that the numerical results
     are exact.

ATRIBUTES
     See attributes(5) for descriptions of the  following  attri-
     butes:



     
           ATRIBUTE TYPE               ATRIBUTE VALUE       
    
     Interface Stability          Committed                   
    
     MT-Level                     MT-Safe                     
    


SEE ALSO
     sqrt(3M), feclearexcept(3M), fetestexcept(3M), attributes(5)

















SunOS 5.11          Last change: 14 Dec 2007                    2