---
name: "pcsrscl"
section: "3"
platform: "linux"
package: "scalapack-doc"
version: "1.5-11"
release: "Debian 11 (Bullseye)"
platforms: ["linux"]
url: "https://new.carta.tech/pcsrscl"
---

# pcsrscl(3)

multiplie an N-element complex distributed vector sub( X ) by the real scalar 1/a

## NAME

PCSRSCL - multiplie an N-element complex distributed vector sub( X ) by the real scalar 1/a

## SYNOPSIS

- SUBROUTINE PCSRSCL(

  N, SA, SX, IX, JX, DESCX, INCX )

- INTEGER

  IX, INCX, JX, N

- REAL

  SA

- INTEGER

  DESCX( \* )

- COMPLEX

  SX( \* )

## PURPOSE

PCSRSCL multiplies an N-element complex distributed vector sub( X ) by the real scalar 1/a. This is done without overflow or underflow as long as the final sub( X )/a does not overflow or underflow.\

where sub( X ) denotes X(IX:IX+N-1,JX:JX), if INCX = 1,\
\
                        X(IX:IX,JX:JX+N-1), if INCX = M\_X.

Notes\
 \=====\

Each global data object is described by an associated description vector.  This vector stores the information required to establish the mapping between an object element and its corresponding process and memory location.\

Let A be a generic term for any 2D block cyclicly distributed array. Such a global array has an associated description vector descA. In the following comments, the character \_ should be read as "of the global array".\

NOTATION        STORED IN      EXPLANATION\
 \--------------- -------------- -------------------------------------- DT\_A   (global) descA\[ DT\_ \]   The descriptor type.  In this case,\
                                DT\_A = 1.\
 CTXT\_A (global) descA\[ CTXT\_ \] The BLACS context handle, indicating\
                                the BLACS process grid A is distribu-\
                                ted over. The context itself is glo-\
                                bal, but the handle (the integer\
                                value) may vary.\
 M\_A    (global) descA\[ M\_ \]    The number of rows in the global\
                                array A.\
 N\_A    (global) descA\[ N\_ \]    The number of columns in the global\
                                array A.\
 MB\_A   (global) descA\[ MB\_ \]   The blocking factor used to distribu-\
                                te the rows of the array.\
 NB\_A   (global) descA\[ NB\_ \]   The blocking factor used to distribu-\
                                te the columns of the array. RSRC\_A (global) descA\[ RSRC\_ \] The process row over which the first\
                                row of the array A is distributed. CSRC\_A (global) descA\[ CSRC\_ \] The process column over which the\
                                first column of the array A is\
                                distributed.\
 LLD\_A  (local)  descA\[ LLD\_ \]  The leading dimension of the local\
                                array.  LLD\_A \>= MAX(1,LOCr(M\_A)).

Let K be the number of rows or columns of a distributed matrix, and assume that its process grid has dimension p x q.\
 LOCr( K ) denotes the number of elements of K that a process would receive if K were distributed over the p processes of its process column.\
 Similarly, LOCc( K ) denotes the number of elements of K that a process would receive if K were distributed over the q processes of its process row.\
 The values of LOCr() and LOCc() may be determined via a call to the ScaLAPACK tool function, NUMROC:\
\
         LOCr( M ) = NUMROC( M, MB\_A, MYROW, RSRC\_A, NPROW ),\
         LOCc( N ) = NUMROC( N, NB\_A, MYCOL, CSRC\_A, NPCOL ). An upper bound for these quantities may be computed by:\
\
         LOCr( M ) \<= ceil( ceil(M/MB\_A)/NPROW )\*MB\_A\
\
         LOCc( N ) \<= ceil( ceil(N/NB\_A)/NPCOL )\*NB\_A\

Because vectors may be seen as particular matrices, a distributed vector is considered to be a distributed matrix.\

## ARGUMENTS

- N (global input) pointer to INTEGER

  The number of components of the distributed vector sub( X ). N \>= 0.

- SA (global input) REAL

  The scalar a which is used to divide each component of sub( X ).  SA must be \>= 0, or the subroutine will divide by zero.

- SX (local input/local output) COMPLEX array

  containing the local pieces of a distributed matrix of dimension of at least ( (JX-1)\*M\_X + IX + ( N - 1 )\*abs( INCX ) ) This array contains the entries of the distributed vector sub( X ).

- IX (global input) pointer to INTEGER

  The global row index of the submatrix of the distributed matrix X to operate on.

- JX (global input) pointer to INTEGER

  The global column index of the submatrix of the distributed matrix X to operate on.

- DESCX (global and local input) INTEGER array of dimension 8.

  The array descriptor of the distributed matrix X.

- INCX (global input) pointer to INTEGER

  The global increment for the elements of X. Only two values of INCX are supported in this version, namely 1 and M\_X.