naginterfaces.library.dot.real_​prec

naginterfaces.library.dot.real_prec(a, b, c1, c2, sw)

real_prec calculates the value of a scalar product using basic precision or additional precision and adds it to a basic precision or additional precision initial value.

For full information please refer to the NAG Library document for x03aa

https://support.nag.com/numeric/nl/nagdoc_30.3/flhtml/x03/x03aaf.html

Parameters

afloat, array-like, shape $\left(n\right)$

The elements of the first vector.

bfloat, array-like, shape $\left(n\right)$

The elements of the second vector.

c1float

$c1$ and $c2$ must specify the initial value $c$: $c=c1+c2$. Normally, if $c$ is in additional precision, $c1$ specifies the most significant part and $c2$ the least significant part; if $c$ is in basic precision, then $c1$ specifies $c$ and $c2$ must have the value $0.0$. Both $c1$ and $c2$ must be defined on entry.

c2float

$c1$ and $c2$ must specify the initial value $c$: $c=c1+c2$. Normally, if $c$ is in additional precision, $c1$ specifies the most significant part and $c2$ the least significant part; if $c$ is in basic precision, then $c1$ specifies $c$ and $c2$ must have the value $0.0$. Both $c1$ and $c2$ must be defined on entry.

swbool

The precision to be used in the calculation.

$sw=True$

additional precision.

$sw=False$

basic precision.

Returns

d1float

The result $d$.

If the calculation is in additional precision ($sw=True$),

$d1=d$ rounded to basic precision;

$d2=d-d1$,

thus $d1$ holds the correctly rounded basic precision result and the sum $d1+d2$ gives the result in additional precision. $d2$ may have the opposite sign to $d1$.

If the calculation is in basic precision ($sw=False$),

$d1=d$;

$d2=0.0$.

d2float

The result $d$.

If the calculation is in additional precision ($sw=True$),

$d1=d$ rounded to basic precision;

$d2=d-d1$,

thus $d1$ holds the correctly rounded basic precision result and the sum $d1+d2$ gives the result in additional precision. $d2$ may have the opposite sign to $d1$.

If the calculation is in basic precision ($sw=False$),

$d1=d$;

$d2=0.0$.

Raises

NagValueError

(errno $1$)

On entry, $\text{istepb}=⟨value⟩$.

Constraint: $\text{istepb}>0$.

(errno $1$)

On entry, $\text{istepa}=⟨value⟩$.

Constraint: $\text{istepa}>0$.

(errno $2$)

On entry, $\text{isizeb}=⟨value⟩$, $n=⟨value⟩$ and $\text{istepb}=⟨value⟩$.

Constraint: $\text{isizeb}\ge (n-1)\times \text{istepb}+1$.

(errno $2$)

On entry, $\text{isizea}=⟨value⟩$, $n=⟨value⟩$ and $\text{istepa}=⟨value⟩$.

Constraint: $\text{isizea}\ge (n-1)\times \text{istepa}+1$.

Notes

No equivalent traditional C interface for this routine exists in the NAG Library.

real_prec calculates the scalar product of two float vectors and adds it to an initial value $c$ to give a correctly rounded result $d$:

$$d=c+\sum _{i=1}^n{a}_i{b}_i\text{.}$$

If $n<1$, $d=c$.

The vector elements $a_i$ and $b_i$ are stored in selected elements of the one-dimensional array arguments $a$ and $b$.

Both the initial value $c$ and the result $d$ are defined by a pair of float variables, so that they may take either basic precision or additional precision values.

1. If $sw=True$, the products are accumulated in additional precision, and on exit the result is available either in basic precision, correctly rounded, or in additional precision.

2. If $sw=False$, the products are accumulated in basic precision, and the result is returned in basic precision.

This function is designed primarily for use as an auxiliary function by other functions in the NAG Library, especially those in the modules on Linear Algebra.