004 2081 002 Scientific Libraries Reference Manual Volume 1 Version 3.3 July 1999

Scientific Libraries Reference
Manual, Volume 1
004–2081–002
"! # $&%' ( ) # *+), $#-./! !102 3)4*50)67*867 9267:1-;1) *)<=( $>?(!?(4*@ )6AB67C<=( /$)DFE6
B6G?BD: >?#67H
: $I($=C4D <J>$)! 6A*K*?67"<="4+6A:LEDM# $4(#DNEDPOQ"446G$R?67 <M *8*K"$SDC "! # $M%5( #*4?, $#-
T , UV, ;W1XM.ZY[X\02W1K;02,]1;WX^02,]%5_`; T W1%5W Y[X

a 8* 6G): >?! # (A4"$2D:1 *8#! D*4>?B6EDM 6b%5 9267 $<=6G$)"*`*4>EDc]67#24/B67*84 #4 $)*Z(*5*K6AC] S $I )6b0) 4*5 $IX5(4(L# ! ( >?*K6d()e./0
f- ffg h($:1i $I*8 <= !"(A`D*4>?##6A*K*8D# ! ( >?*867*' $I )6de./0j2` $= 6bXZkZX)X5klWh1YL./K.Je./0MK>1?! 6<=6G$4*K- a $F>E! *467:[ 3)4*
B67*867"9267:L>$):167@ )6d? ) T ( OQ*5C2 )6 a $) 46A:Qm4(467*8-2$4(#4Di <=( $F>?C](# >?B67' *5m ! "# $M%5( ) # *4?, $)# - )noo.Z</ )67(4B6
pq Or - Us>$4( $[t5 6GO'2.J o Aug uA-
.Z>?4D4(* q $)32?eD ?? (K?( R./:( )( 2 DC4 ?( wv2g]U p )? ( Dg8 02, $)C]"</)02,]ix7yjz{B|}` 92( _r8~2 T Em# U pp .Z?B6G$4 #6mmX2
a/p W102 Ta 8;W10j a Y[,]kZ8~2g4U p W.Z?( $): a Y[,]?klmi< q (B6rC467:167 (! ! MB6AD *8467B67:H4 (:6G<M( q *'( $):H167#( >?*86$lO[D q *K4(4 $I *5( $
*8! ( $:?, ??1UQ;D?eDo ??e ;D2e ;1f2e ; $)1>?G6G$)Us(A $)46G$($#6;D! *42?kl8( w.Z$ <=(4 $h;1)6A(A46A )? ( w. pp )( H?o
( HAoX)? ( MQ</? !" $)RK2*846G</)? (2X5D#]?? (HW T )( R8o ( Po*K62? ( T $ q ( PYQZ82( 2i02W1W T ! E("( $F
( H8g4U p )( MmmX)g4;o ( M8tr 2( P;o ? (w;1uX))( P;1uW ( D;m>?4D 2( R~2g4U p ?? (w~)UV8?? ( Dg4fm, UQ1t;D
XZ67! 926A $/ )6?OQ67`-F-j- ?X5%5( >?*8*4)X5D#]92 6O@)W UVXZ8?%5 j(02 $)3)_rW ~2./0j),]kZ8FYQXm67 67*Y[6A O[D q XZ * q ./ (3
Y[6A O[D q >?6G>? $PW $F9) B$<=6G$ Y[67 O[D q >?6G>? $)b;1D!"*+?k T Y[W ;D02l8)mW1% T XZ0j8U ./0m;W a/p W0 T , YQ}1
8*846G<UV( $46G$)( $#6l( $):H026<=D+6?;67*84 $PW $F92"B$F<M6G$) F; >?*8467: a Y[,]kZ8($: a YQ,4kl5UQ.Z~(AG6L4 (:6<=( q *@DC( M026A*K6A(AG#]F
T - T - - 2('Or)D! ! M Or$67:[*4>E*8 :1 ( =DC)m !" # $M%5( )"#*4?, $)# -
m%5,N *`(4(:16G<=( q D Cm ! "# $M%5( ) # *4), $#-,]02, ~\( $):Qm ! # $M%5 ( #*@(AG6dB67j *8467B67:[4 (:6<=( q *@( $):Q )6d "! # $M%5( #*5! DDw *`(
4 (:6G<M( q DCm ! "# $I5
% ( #*4), $)# -
X5I"*'(4(:16G<=( q C2? $)4BD!XZ(4(b8*846G<M*+?, $)# -)XZW1 a/T ;02, ~2Ft.Z~2?( $):LtUs(B6r4(:16G<=( q *@DCX5 j 4(!W1 >? <M6G$)
"? (A4"$-2W102oL *5(d4(:16G<M(A q DCW UQ.P 8, $)# -)W ;D."*'(4(:16G<=( q C2W;D.K2*846G<=*4?, $#-,]U"*'(4(:16G<=( q C2, $467 $(4 $(!
>?*8 $)6A*K*NUs(#]) $)67*'"? (A4"$-UV, p *5(d4(:16G<M(A q DCDUs, p ? </>?467@K2*846G<=*8- a Y[, ~\ *5(LB67j *8467B67:H4(:16G<M(A q $I )6 a $) 46A:
m4(467*@($:[D )67`# >$)4"67*4N! "#6G$*K6A: 67 #! >*K 9267! B>?3[~5i1k)?6G$S? </?( $F T <="467:1-~5ik?6G$M"*`(dB67D"*K46AB67:H4(:16G<=( q Cj~5ik?6G$
<P?($ T 4:1-F~&V $):1OK2*846G<( $:H )6?~\:6G9) #6b(B6d4 (:6<=( q *5DCD;16dk?6G$S%5B>?-
;1)6 a Y[,]?klw?67 (4 $)P*4*846G< *5:67 9267: C4B < a YQ, ~?h82*K46<t?-7;1)6 a Y[,]?klr ?67(4 $)h*4*846G< *5(! *8lE(*867:Q $h?(A 2 $S )6
ej>? =167 q 67! 6GSmC] O[(B6dXZ *84 ED>?4 $V41mX5F>$:167?! # 6G$)*86rC]B <;1)6b0267D6$)4*5C2 )6 a $) 9267*8 HDC?(! "C4D $)"(-
New Features
Scientific Libraries Reference Manual, Volume 1 004–2081–002
V'hB`KAK¡D&¡D¢``£Q¤V3&¥\¦5M8)hK¢`BQ3§Bm?¨
Record of Revision
©`ª1«m¬1D®2¯ °ª1¬±1«m3²w³D®2¯
´`¨ µ ¶3¡D¢¸·¹º1¹
»H¡D'¥\` B^m'¼'¼') B`£\ ¢`V½HV¾8¿/ÀMÁs´`¨ µV3§BmSA'``B`£¸¿/1Â\Ãrm3¡D¢
¡D¥\¼'' RmÂmK¥\¨
Ä`¨ µ ÅK`'AÂ·¹¹1·
ÃL¼'B`b¤VBK¢^3Æ?BmBÇm'¼'¼')AKB`£\ ¢`V½HV¾K¿PÀ=ÁÄ`¨ µV3§B1SA'``B`£)^¿PAÂÃL3¡D¢
¡D¥\¼'' RmÂmK¥\¨
È`¨ µ É='£'md·¹¹Ê
ÃL¼'B`b¤VBK¢^3Æ?BmBËm'¼'¼') B`£\½=&¾8¿PÀ=ÁsÈ`¨ µs3§BmVA'``B`£)¸¿PAÂÃL3¡D¢
¡D¥\¼'' RmÂmK¥\¨
º`¨ µ É='£'md·¹¹Ì
ÃL¼'B`b¤VBK¢^3Æ?BmBËm'¼'¼') B`£\K¢`S¿/1Â?Í5BÎ ·`¨ µs3§BmSÏ81Â`¡D¢`3`)'mÐw ¢`bA'`
¿/ÂÃL3¡D¢^mÂ ¥\¨Z¾KK¢`BQ3ÆBmB))r ¢`S¦5)¡j'¥\`K B)`Ñ? ¢`S¥\ ¢§BBÎAÂB
`Ò§B`£R¦5)¡j'¥\`K¦BÇ ¢`Vm¥\M¥\`'§b1QK¢`Sm¡DB` BÓ5¡H§BBÎAAÂ¨Z¾8`m ¦5Ñ@BdB
¦5)¡j'¥\`K¦¸BÇ ¢`RÔÖÕD×8ØVÙÚÜÛFÝAÕDÝAÞ&ßLà áDàAÝ àAâã àZÔÖÕDâ?äÕDåÜÑ`¼''Î§BB¡DKB)^ÁÃLæKÊ·Ì1º`¨5ç5¢`SmAr`¦
m3¡D¢3)'KB`Ñ@¤V¢`B¡D¢\¤V3&B\K¢`S½HV¾8¿/ÀMÁsÈ`¨ µIÆ?AB))r ¢`Sm¡DB`KBÓ'¡H§BBÎAÂ Ñ`¤V3
¥\Æ?¦¸ \ ¢`&½=V¾K¿PÀ=Áè) 1¸Í5BÎAAÂ¨
º`¨ · ÅK'`S·1¹¹é
ÃL¤sAB M \m'¼'¼')r ¢`&¿PAÂ?Í'BÎ?[·`¨ ·V3§B1&ÏKmÂ?`¡D¢`3)`'mÐr ¢`r'`Q¿PAÂ
ÃL3¡D¢^mÂ?m ¥\¨Zç5¢`BQ3Æ?BmBËB`¡DA¼')1K[m5¼@¼'ArK)[ ¢`S¿PAÂ^¶ê'êË¢`3¦'¤s13
¼'§B 8)A¥¨
º`¨ Ê ÀM¡D ÎR·¹¹é

ÃL¤sAB M \m'¼'¼')r ¢`&¿PAÂ?Í'BÎ?[·`¨ ÊV3§B1&ÏKmÂ?`¡D¢`3)`'mÐr ¢`r'`Q¿PAÂ
ÃL3¡D¢^mÂ?m ¥\¨Zç5¢`BQ3Æ?BmBËB`¡DA¼')1K[m5¼@¼'ArK)[ ¢`Së5mB¡HÍ5B`hÉ=§B£ÎA
Á2'Î¼' £1¥\ K)h¢`13¦AÂ ÏKë5Í5ÉHÁ2ì1Á2Ð ¨
Ê`¨ µ »H¡D¥\ÎR·¹¹´
ÃL¤sAB M \m'¼'¼')r ¢`&¿PAÂ?Í'BÎ?[Ê`¨ µV3§B1&K¢`1b'`Q)¸¿PAÂ\Ãrm3¡D¢¸mÂ ¥\¨
ç5¢`BQ3Æ?BB)ÇB`¡D)¼')AKQm'¼'¼')rK)hÁ2¡D§BÎ§B&Í'É=ê1ÉH¿PíÏKÁ2¡DÍ5ÉHêÉH¿PíRÐd`¦
¦5)¡j'¥\`K¦¸m'¼'¼')d8)hÌÊæKÎBrè?èçË3' B`¨lÉ=¦5¦5B B§Z3)'KB`Q¤V3&¦5¦5¦K)
è?èçË`¦ë5Í5ÉHÁ'¨
Ì`¨ µ ÅK'`S·1¹¹È
ÃL¤sAB M \m'¼'¼')r ¢`&¿PAÂ?Í'BÎ?[Ì`¨ µV3§B1&K¢`1b'`Q)¸¿PAÂ\Ãrm3¡D¢¸mÂ ¥\¨
ç5¢`BQ3Æ?BB)Ç3¥\Æ?Hm'¼'¼')d8)P ¢`Vë'B¡HÍ5B`RÉH§B£ÎsÁ2'Î¼'3)£¥\QK)[m¢`3¦
004–2081–002 i
Scientific Libraries Reference Manual, Volume 1
AÂhÏ8ë'Í5É=ÁìÁÐ ¨Á2SK¢`SV¤îè '3 ¼@£?&K)[¥\)3S¦5KB§BQÎ)'r¦5¦5B B`§

K'`¡j B`1§BBKÂ\¦'¦5¦Ëd ¢`B=3§Bm?¨
Ì`¨ · É='£'md·¹¹º
½=¼'¦'K¦¸K^3ï5¡Dd¡D¢``£ BÇ ¢`Sê'3£A¥\¥\B`£ð5`Æ?B3`¥\`Ì¨ ·s3§Bm?¨5ç5¢`
¼'AB`K¦ËKñd)r ¢`BQ¥\`'§b¤V ¥\¦'SÆ?B§BÎ§B&BÇ¼')mKm¡DB¼@dÏ ¨ ¼'mÐK)¥\b)`§BÂK
K¢`BQ3§Bm?¨
Ì`¨ Ì ÅK'§BÂ·¹¹1¹
½=¼'¦'K¦¸K^3ï5¡Dd¡D¢``£ BÇ ¢`Sê'3£A¥\¥\B`£ð5`Æ?B3`¥\`Ì¨ Ìs3§Bm?¨5ç5¢`
¼'AB`K¦ËKñd)r ¢`BQ¥\`'§b¤V ¥\¦'SÆ?B§BÎ§B&BÇ¼')mKm¡DB¼@dÏ ¨ ¼'mÐK)¥\b)`§BÂK
K¢`BQ3§Bm?¨
ii 004–2081–002
About This Guide
ç5¢`BH¼''Î§BB¡j1KB)^¦5)¡j'¥\`KQm'Î¼'3£A¥\=`¦3)'KB`QÆ1B§BÎ§B& \'mAQ)r ¢`

¿/ÂÍ5BÎH¼@3¦5'¡D Ñ'¤V¢`B¡D¢^BHB`¡D§B'¦5¦ËBÇK¢`Sê'3)£?A¥\¥\B`£ð5`Æ?B3)`¥\`LÌ`¨ Ì
3§Bm?¨lç5¢`S¿PAÂÍ5BÎH¼'3)¦5'¡Dd¡j)` B`QmÆ?1§l§BBÎAABmòK¢`S§BBÎAAÂ^3)'KB`Q¡D
Î&¡D§B§B¦K3)¥óm)'3¡D&¡D)¦5V¤VB KÇBÇ&`'¥\Îh)r¼@3£1¥\¥\B`£^§B1`£?'£mÑ
B`¡D§B'¦5B`£^è?)AKA`Ñ`¿/Ñ@ê'm¡j1§BÑ@`¦Ëm¥\Î§BÂ\§B`£'£?¨Zç5¢`SB`8)A¥\KB)¸BÇ ¢`B
¦5)¡D'¥\`Lm'¼'¼'§B¥\`KQB`K)¥\1KB)¸¡D` B`¦BÇ)K¢`P¥\`'§BQ ¢`
ê'3)£?A¥\¥\B`£Çð5`Æ?B3`¥\`d¦5)¡j'¥\`K BÇ ¨
ç5¢`BHBQs3K3`¡D&¥\`'§5Kh¼'¼'§BB¡D B)Ç`¦mÂmK¥ô¼'3£A¥\¥\A¨lÃL1¦5A
m¢`)'§B¦§Bm\¢`Æ?Is¤V)õB`£õ`¤V§B¦5£?M)BK¢`hK¢`S½HV¾8¿/ÀMÁÑ`½=V¾K¿PÀ=Á5ö¥\õÑ@)
½HV¾8÷)¼'AKB`£ÂmK¥ó`¦s¤V)õB`£õ`¤V§B¦5£?IdK¢`SèA ÇR¿
¼'3)£¥\¥\B£^§B`£'£?¨
Documentation Organization
ç5¢`&¼'B` ¦ËÆmB)`H)r ¢`SÁ¡jB`KBÓ'¡MÍ5BÎAAÂ¥\^¼'£Q¼'¼'1[BÇÊ&Æ?)§B5¥\
`¦3I£3'¼@¦¡D¡D)3¦5B`£Ç \ ¼'B¡D¨5ÁS ¢` ÏKÌÁÐd¥\1Ë¼'£SK)
¦5KB§BHÎ'lK¢`&¡D` ` d¡D¢ÇÆ?§B'¥\?¨ INTRO_LIBSCI
ð51¡j¢¸ ¼'B¡=¡j B)Ç§Bm\¢`[¸B` 3¦5'¡D AÂ\¥\Ë¼'1£?S¤V¢`B¡D¢^ñ¼@§BB` K¢`
¡D)`K` )K¢`Sm¡D BÇ1`¦¼'3)ÆB¦5=) ¢`RB`K)A¥\KB)¸Î)'rK¢`S'm£I)K¢`)m
3)'KB`N¨lç5¢`SK§B§B)¤VB`£\B`K3)¦5'¡DK)Â^¥\^¼'£Q3IÆ?B§BÎ§B?ø
Ï8Ì1Á2Ð
INTRO_BLACS
Ï8Ì1Á2Ð
INTRO_BLAS1
Ï8Ì1Á2Ð
INTRO_BLAS2
Ï8Ì1Á2Ð
INTRO_BLAS3
ÏKÌÁÐ
INTRO_CORE
ÏKÌÁÐ
INTRO_FFT
ÏKÌÁÐ
INTRO_LAPACK
ÏKÌÁÐ
INTRO_MACH
Ï8Ì1Á2Ð
INTRO_SCALAPACK
ÏKÌÁÐ
INTRO_SPARSE
004–2081–002 iii
ÏKÌÁÐ
INTRO_SPEC
ÏKÌÁ2Ð
INTRO_SUPERSEDED
Related Publications
ç5¢`&8)§B§B)¤VB`£¥\`'1§B ¦5)¡j'¥\`d ¢`V¿/1Â?Í5BÎ[¼'3)¦5'¡DK¨ZÉH§B§b¥\^¼'£QB
¢`mI¥\`'§B ¡DÇ1§BÎ&Æ?B¤V¦)`§BBÌÎÂ'B`£ ¢` ¡D)¥\¥\`¦w¨
man
ùûú â?×KÝ7ÚÜâ?ü7ÚÜã[ý5Ý þDã àAÿäÝ àAüRßrà áDà7Ý3àAâã àbÔÖÕDâ?äÕDå
å]ÚÜãÕj×KÚÜþDâý5Ý þ`ÝAÕ HàAÝ ühÙ?Ú]ÛFÝAÕDÝAÞVßrà áDà7Ý3àAâã àbÔÖÕDâ?äÕDå
ù
ù ã ÚÜà7â?×KÚ ãQÙÚÜÛFÝAÕDÝAÚ]àAüPßLàAÕDÿÞIßLà áDàAÝ àAâã à
ù å]ÚÜãÕj×KÚÜþDâý5Ý þ`ÝAÕ HàAÝ ühÙ?Ú]ÛFÝAÕDÝAÞVßràAÕDÿÞsßrà áDàAÝ àAâã à
ç5¢`SK§B§B)¤VB`£\¥\`'§Bh¦5m¡DBÎS ¢`S¼'3)¦5'¡j BÇ ¢`Sê53)£1¥\¥\B`£ð5`Æ?B3)`¥\` ¨
ç5¢`mI¼''Î§BB¡DKB)`Q¦5m¡DBÎ& ¢`S¼' B`£^mÂ?mK¥\ÑB`¼''ö2)'K¼''LÏK¾ ö2À=ÐKÑ`¦
)K¢`[3§B ¦ )¼'B¡j¨
ù
à HàAâ?×rÙþDÕDÿàAÝ Ù=ßLÕDâÿVåÜÿ&ßLà áàAÝ àAâ?ãàdÔÖÕDâä?ÕDå
ù H ú !" ü7àAÝ þ#!=ÕDâÿüRßLà áDàAÝ àAâã àbÔÖÕjâäÕjå
ù H ú !" ü7àAÝ þ#!= ÕDâÿüRßLà7Õjÿ1Þ&ßrà áDàAÝ àAâã à
ù äÚÜÿàP×KþHý5ÕjÝ7ÕDåÜåÜàAå%)$ àAã×KþjÝ åÜÚ]ã ÕD×KÚÜþDâ?ü
ù å]ÚÜãÕj×KÚÜþDâý5Ý þ`
ÝAÕ H àAÝ ü ú'&() ä?Ú]ÿà
¾K¸1¦5¦5BKB)¸ \ ¢`mI¦5)¡j'¥\`KmÑ@Æ§Z¦5)¡j'¥\`KQ3IÆ?B§BÎ§BIK¢`l¦5m¡DBÎ
¢`V¡D)¥\¼'B§BRÂmK¥\ Æ1B§BÎ§BS)¸½=&¾8¿PÀ=Ás`¦½=&¾8¿PÀ=Á'ö2¥\õl¨'Á2)¥\IdK¢`m
¥\`'1§B 3?ø
ù *,+- ßLàAÕDÿÞIßLà áDàAÝ àAâã à
ù *,+-. þ HÕDâ?ÿüRÕDâÿ/=Ú]Ý3à7ã ×KÚ10à7üRßrà áDà7Ý3à7â?ãàLÔÖÕDâ?äÕDå
ù * þjÝ7×8Ý7Õjâ\Ù?ÕDâ ` äÕ2 àPßrà áDàAÝ àAâã àbÔÖÕDâ?äÕDå13$ þDåÜä= à54
ù ÝAÕDÞ &(88 ßLà áDàAÝ àAâã àbÔÖÕjâäÕjå
iv 004–2081–002
About This Guide
ç5¢`&8)§B§B)¤VB`£¥\`'1§B ¦5)¡j'¥\`d ¢`V¡D)¥\¼'B§BA[K¢`1L13&1ÆB§ÜÎ§B&¸¾KÃL¾K÷

mÂ ¥\ø
ù Ô úý ý5Ý3þ !9 * þDÝA×KÝAÕDâ +-. þ =ÕDâÿüRÕDâ?ÿ.=ÚÜÝ àAã×KÚ10àAühßLà áàAÝ àAâ?ãàdÔÖÕDâä?ÕDå
ù Ô ú ý Ý3þ üAü7à:=ÛFåÜÞ&Ù?ÕDâ `ä?Õ`à/ý5Ý þ2ÝAÕ HàAÝ ü ä?Ú]ÿà
ù Ô ú ý Ý3þ * þjÝ7×8Ý7Õjâ;99&Ù?ÕDâ `äÕ2àhßLà áàAÝ àAâ?ãàdÔÖÕDâä?ÕDå
ù Ô ú ý Ý3þ * þjÝ7×8Ý7Õjâ;9& 9 ý5Ý þ2 ÝAÕ H àAÝ ü ä?Ú]ÿà
ù Ô ú ý Ý3þ <=>5
? Ú]×Lý5þDÝA×KÚÜâ Ç ÕDâ?ÿ/@ Ý7ÕjâüAÚ]×8Ú]þjâ äÚÜÿà
Obtaining Publications
BA
Á ¾w¥\1B`KB`[B`K)A¥\KB)¸Î)'rÆ1B§BÎ§B&¼''Î§BB¡DKB)`QdK¢`SK)§B§B¤VB`£\½=ÃrÍwø
DC
http://techpubs.sgi.com/library
BA FE
ç5¢`B ÎÒmBKI¡D` B`RB`8)A¥\KB)K¢`1b§B§B)¤V[Â?)¸ ÒÎ3)¤VmI¦5¡D'¥\` h)`§BB`Ñ
)3¦5h¦5¡D'¥\` mÑ'1`¦m`¦K¦5Î¡Dõ \Á ¾m¨ `)¡D^§Bm\3¦'[I¼'B` ¦Á ¾
¦5)¡D'¥\`LÎÂ¡D§B§BB`£·sºµµVÄ1ÊÈV¹Ìµ1È`¨
BA

ç5¢` üAà7ÝPý5äÛFåÜÚÜãÕj×KÚ]þjâü ÕD×KÕDåÜþ Ç¦5m¡DBÎQ ¢`VÆ?B§BÎB§BB Â`¦¡D` `Ld§B§l¿PAÂ
¢`3¦'¤s13V`¦m)8 ¤V3V¦5)¡j'¥\`KQ ¢`r3IÆ?B§BÎ§BMK¡j'm ¥\A¨Z¿P'mK)¥\A
¤V¢`m5Îm¡DABÎ?I \ ¢`S¿PAÂ\¾K`KA¥ Ï8¿/ÃL¾K`KA¥\Ðr¼'3)£¥ó¡j11¡j¡Dm[ ¢`B
B`K)¥\1KB)¸)¸K¢`S¿/ÃL¾8`K)A¥ ÂmK¥¨
BK)A §B§B¾w¥\¤VB1`B`£ÇK½HB`ÃL[ÍwBø `K)A¥\KB)¸)¸¼''Î§BB¡D§BÂ\Æ?B§BÎ§BI¿PAÂ^¦5)¡j'¥\`KQd ¢`
Á
!C
http://www.cray.com/swpubs/
GA
ç5¢`B ÎmBKI¡D)`KB`QB`K)A¥\KB)¸ ¢`r§B§B)¤V[Â?)KÎ3¤VmI¦5)¡j'¥\`KQ)`§BB`
FI
HH
`¦m`¦¸K¦5Î¡Dõ ^Á ¾ ¨1ç2Ò)3¦5[s¼@B` ¦¿/1Â\¦5)¡D'¥\`KÑ`B ¢`h¡D§B§
GA
·sÄ´1·VÄºÌV´1¹µÈVhm`¦sK¡DmB¥\B§BI)rÂ'R3 ?'L \Kñ`'¥\Î
·sÄ´1·VÄºÌVÌ1ºéµ`¨5Á ¾¥\¼'§B)Â?[¥\Â\§Bm\)3¦5h¼'AB`K¦Ë¿PAÂ^¦5)¡D'¥\`KQÎÂ
m`¦5B`£^K¢`Bh3¦'A Æ?BV§B¡DK3)`B¡M¥\B§5 ¨
orderdsk
KJ
¿/5m ¥\ )'KmB¦5I)r ¢`V½H`BK¦Á2 1`¦¿P`1¦5Vm¢`'§B¦¡D)`K¡Dd ¢`Bh§B)¡D§
mAÆ?B¡j&)3£` BÇKh)3¦5AB`£B`KA¥\ BÇ`¦¦5)¡D'¥\`K1KB)¸B`KA¥\ Br¨
Conventions
ç5¢`&8)§B§B)¤VB`£¡D)`Æ`KB)`H13&'m¦¸ ¢`3'£¢`' ¢`BQ¦5)¡j'¥\` ø
004–2081–002 v
¿ Æ ¶ £
ç5¢`BQÓ'ñ¦'æ8m¼'¡DIK)`r¦5` §BB A§lB ¥\[m5¡D¢Ç
command ¡D¥\¥\1`¦5mÑÓ5§BÑ`3)'KB`mÑ@¼' ¢Ç`¥\Ñ@B£`§BmÑ
¥\mm£mÑ``¦Ë¼'3£A¥\¥\B`£§B`£?'1£?&m '¡D 5 ¨
0ÕDÝAÚ]ÕjÛFå]à ¾8 §BB¡= Â?¼'81¡jS¦5`)K Æ?ABÎ§BI` ABQ1`¦¤V3¦5
)h¡D`¡D¼' [ÎB`£¦5Ó5`¦w¨
ç5¢`BQÎ§B¦5ÑÓ'ñ¦5æK¼'1¡jS8)`r¦'` Q§BBKA§lB ¥\
user input
¢`rK¢`S'mh` AQBÇB` 1¡j BÆ?ImmB)`¨
À='K¼''LB[m¢`)¤sÇBÇ`)`Î)§B¦5Ñ`Ó'ñN¦5æKm¼'¡DIK`¨
ML N QN PO
¾K¸1¦5¦5BKB)¸ \ ¢`mIKA¥\ KB`£^¡D)`Æ`KB)`mÑ`Æ§Z`¥\B`£¡D)`Æ`KB)` 3
'm¦ ¢`3)'£?¢`)'K¢`S¦'¡D'¥\` KB)r¨ ¿/1Â\ê RêËmÂ?m ¥\ &¦5`) §B§
L PO
¡D)`Ó5£'1KB)`H)r¿/Â¼'A§B§B§lÆ?¡D R¼'3)¡DmmB`£^ÏKê Rê'ÐdmÂ?mK¥\ K¢`1LA'^K¢`
L
½HV¾8¿/ÀMÁÒ¼' B`£\mÂ ¥¨ 1¿PAÂÇ¶ê'êËmÂ ¥\ s¦5`)K[1§B§l¡D`Ó'£5A B`
PO BA
¢`V¿/1Â\ç5ÌðmBQ ¢`r'^ ¢`S½=V¾K¿PÀ=Á5ö¥\õ^)¼'AKB`£ÂmK¥¨ ¾8Ãr¾8÷
mÂ ¥\ s¦5`)K Á ¾r¼'§BKK)A¥\=¤V¢`B¡D¢^'^ ¢`S¾8ÃL¾K÷Ö)¼'A B`£\mÂ?m ¥¨
ç5¢`&¦5K'§Bdm¢`§B§lBÇ ¢`S½=V¾K¿PÀ=Á`¦½HV¾K¿PÀ=Á5ö¥\õ\)¼'A B`£ÇmÂmK¥\mÑ`3K ¦
^Q ¢`SüA×KÕjâÿÕDÝAÿsüAØàAå]åÜÑB[sÆmB)ÇdK¢`&íh)AÇm¢`§B§l ¢`b¡D`K)¥\H \ ¢`
K)§B§B¤VB`£Çm `¦53¦5ø
ù
R
¾8`m BK' I)rð5§B¡j AB¡j1§l`¦ð'§B¡DK3)`B¡DHð5`£BÀQÏK¾Kð5ð5ð5ÐLê5)AKÎ§BSÀM¼@AKB`£
ÁÂ?m ¥ô¾8` K1¡jIÏ8ê'À=Á¾8÷rÐdÁ2 `¦513¦·µµ1Ì`¨ Ê ·¹1¹Ê
ù ÷[ö2À=¼'^ê'AK1Î?Ü§BBKÂ;A 'B¦5Ñ`¾Km'IésÏK÷rêA é1Ð
ç5¢`S½=&¾8¿PÀ=Ás`¦Ç½=V¾K¿PÀ=Á5ö¥\õ\)¼'A B`£\mÂ?m ¥\[1§Bm'¼'¼')lK¢`S)¼' B`§''m
)K¢`S¿ m¢`§B§3¨
Man page sections

ç5¢`&`KAB[BÇK¢`BQ¦'¡D'¥\`L13&Îm¦)^s¡D¥\¥\)ÇKA¥\¨Zç5¢`S8)§B§B)¤VB`£§BBm
m¢`)¤s K¢`S)3¦5hm¡D B`hBÇ¸` AÂ`¦¦5¡DABÎQ¡D¢Çm¡DKB)r¨5¶mr` AB
¡D)`KB¸)`§BÂsm5ÎmbdK¢Ìm¡D B`¨
Á ¡ ¢ ¦ £ » ¡ ¼
VÉH¶ð Á¼'¡DBÓ'H ¢`S`¥\S)K¢`S` AÂ`¦ÎABï5ÂmK
B K'`¡DKB)r¨
BE
Á L&ÀMê'Á¾8Á ê'3m` ¢`VmÂ`KñVdK¢`&` ÂN¨
¾K¶ê'Í5ð5¶ð5&ç)ÉPç5¾KÀM ¾8¦'`KBÓ'[ ¢`VmÂ ¥\ \¤V¢`B¡D¢Ç ¢`S` Â\¼'¼'§BB¨
vi 004–2081–002
About This Guide
Áç)ÉHV»HÉ=Ãr»=Á ê'3Æ?B¦5HB`8)A¥\KB)Î'r ¢`V¼@AKÎB§BB Â)r

'KB§BB Â\)h3' B`?¨
»Hð5Á¿PÃr¾8ê'ç5¾8À= »HBm¡j'mm ¢`S` ÂBÇ¦'K1B§3¨
VÀ=ç5ð5Á ê'3m` B ¥\ d¼'AKB¡D'§BRB¥\¼') `¡D?¨
¿/É=½HçZ¾KÀ=VÁ »Hm¡DBÎ ¡DKB)` ¢`r¡DÇ¦5 3)Â\¦5
¼'3)¦5'¡D&'`¦5mB3¦3m'§B N¨
CÇÉ=ÃrV¾K/A Á FI
»Hm¡DBÎ ¡DKB)` ¢`r¡DÇ¢À¥ ¼@¼@§BÑ
?'B¼@¥\`KÑ@)hmÂ ¥óm)KK¤V3¨
ð5.R
N'ÉHÃLN ¾K¾8É=ÃLë5À=Í5Vð5¶Á ð5Vç »Hm¡DBÎ ¼'3¦5Ó'`¦m¢`§B§lÆ?ABÎ§B[ ¢`
¦5 A¥\B`&m)¥\S¡D¢À¡DKBm B¡jQ ¢`Sm¢`§B§l/ ¢`
K¡jdK¢`&Î¢`Æ?B)Rd)¥\&¼'3)£¥\mÑ@¡D)¥\¥\`¦5mÑ
)h'KB§BB B¨
Ãrð5ç5½=Ãr SN'ÉHÍ5½Hð5Á »Hm¡DBÎ ¼'mmBÎ§BS3K'AËÆ?§B' K¢`lB`¦5B¡DKV
§BBÎAÂ/mÂ?m ¥ ¡D§B§ZñN¡D'K¦m'¡D¡jmK'§B§BÂDÑ`)
B¦5` BÓ'H ¢`SA3)[¡D`¦'BKB)¸'`¦5P¤V¢`B¡D¢ËB
KB§B¦w¨
ð5÷r¾8çÁç)É/ç5½=Á »Hm¡DBÎ ¼'mmBÎ§BSñBrmK ' Æ?§B' ¢`rB`¦5B¡DK
¤V¢` ¢`PK¢`&¡D¥\¥\`¦¸h' B§BBKÂ^ñN¡D'K¦
m'¡j¡DmmK'§B§BÂ¨
¶ð5ÁÁ2É !A ð5Á »Hm¡DBÎ B `8)A¥\KB)`§BÑ`¦5B1£?`)mKB¡DÑ``¦A3)
¥\mm£ ` ¢ r¥\Â\¼@¼'¨'Á§BKæKñN¼'§B` AÂ
¥\mm£ 3I`)d§BB ¦w¨
ð5ÃrÃLÀ=ÃLÁ »H¡D'¥\K 3)[¡D)¦5¨ZÉH¼'¼'§BB[)`§BÂ \mÂ?m ¥
¡D§B§B¨
èÀ=ÃZç5ÃLÉH »Hm¡DBÎ ¢`¤ K¡j1§B§ZsmÂ?mK¥ó¡D§B§ZK3)¥ èAKAr¨
ð5÷rç5ð5VÁ¾8À=VÁ É=¼@¼'§BB `§BÂÒK^mÂmK¥ô¡j1§B§BN¨
!A
ë5½ Á ¾8`¦'B¡j1K õ`¤V^Î'£H`¦¦'Ó'¡jB`¡jBN¨
ð5÷rÉ=¶ê'Í5ð5Á Á¢`¤V ñN¥\¼'§B )r'm£?¨
è¾8Í5ð5Á Í5BmKQÓ'§BH ¢`b13&BK¢`[¼@L)r ¢`S` Â\h13
3§B1K¦KB ¨
004–2081–002 vii
Áð5ðÉHÍ5ÁÀ Í5BmKQ` BQ`¦Ë¼''Î§BB¡j1KB)`= ¢`b¡D)`KB¸3§BK¦

B`KA¥\ Br¨
Reader Comments
KJ
¾KÂ)¢`1ÆS¡j)¥\¥\` Q1Î?)'rK¢`S ¡D¢``B¡D§b¡D¡D'1¡jÂmÑ'¡D` ` ÑR3£` B)¸)
¢`B=¦'¡D'¥\` Ñ@¼@§BmIK§B§Z'¨'ë5Vm'3& \B`¡D§B'¦5M ¢`V BK§BI1`¦¼'Ad`'¥\ÎR
¢`V¦'¡D'¥\`b¤VBK¢ËÂ'R¡D¥\¥\`K¨
E¡DÇ¡D` ¡Dd'HBÇ`Â)r ¢`&8)§B§B)¤VB`£¤VÂø
ù Á`¦æK¥\B§Z \ ¢`SK§B§B)¤VB`£\¦5¦53mø
ù
techpubs@sgi.com
L PO H ·sÄ1´µV¹ÌÊ&µºµ·`¨
Á`¦&Kñ \ ¢`&K ` BÇ) 1çN¡D¢``B¡j1§lê''Î§BB¡j1KB)` V ø
½=mMK¢`&è¦5Î¡Dõ\)¼'KB)Ç¸ ¢`SçN¡j¢``B¡D§Zê''Î?§BB¡D B)`=Í'BÎ?AAÂT
C )§B¦UC B¦5
ù
CÎ¼@£?ø
ù
http://techpubs.sgi.com
DA
¿P1§B§ZK¢`Sç¡D¢``B¡j1§lê''Î§BB¡j1KB)` 3)'¼'Ñ@ ¢`3)'£?¢ÇK¢`&çN¡j¢``B¡D§ZÉ=mmBmK`¡D
¿P`K Ñ'mB`£)`&dK¢`SK)§B§B¤VB`£\`'¥\ÎANø
èRÁGA ¾r¾KÃL¾K÷ Îm¦)¼'AKB`£ÂmK¥\Nø5·&ºµµ&ºµµéÁ BA ¾
èR½=V¾K¿PÀ=Á)h½HV¾8¿/ÀMÁ'ö¥\õ\Îm¦¼' B`£\mÂ ¥\ )h¿PAÂÀMAB£BËÊµµµ
H
mÂ?m ¥\øZ·&º1µµV¹´µ&ÊÈÊ¹VÏKK)§B§Z83&K3)¥ ¢`S½=`B ¦Á K `¦¿P1`¦5Ðb
·sÄ´·&ÄºÌV´Ä1µµ
ù Á`¦¥\B§5 \ ¢`VK)§B§B¤VB`£\¦5¦53ø
BA
ç¡D¢``B¡j1§lê''Î§BB¡j1KB)`
Á ¾
VN
·Äµ1µsÉH¥\¼'¢`BK¢`K3Sê'õ?¤VÂ¨
R
¶'` B LB¤[Ñ`¿P1§BB8)A`BV¹éµé1Ì ·Ì´·
CÇ&Æ?§B'IÂ)'h¡D¥\¥\`K[`¦¤VB§B§l3¼')`¦KK¢`¥ó¼@3¥\¼' §BÂ2¨
viii 004–2081–002
CONTENTS
intro_libsci, INTRO_LIBSCI .......................... Introduction to Scientific Library routines .................................................... 1
Solvers for dense linear systems and eigensystems

intro_lapack, INTRO_LAPACK .......................... Introduction to LAPACK solvers for dense linear systems .......................... 7
eispack, EISPACK .................................................. Introduction to Eigensystem computation for dense linear systems ........... 23
linpack, LINPACK .................................................. Single-precision real and complex LINPACK routines .............................. 29
Vector-vector linear algebra subprograms

intro_blas1, INTRO_BLAS1 ............................... Introduction to vector-vector linear algebra subprograms .......................... 33
csrot, CSROT ........................................................... Applies a real plane rotation to a pair of complex vectors ........................ 37
haxpy, HAXPY, GAXPY ............................................. Adds a scalar multiple of a real or complex vector to another real or
complex vector ............................................................................................ 38
hdot, HDOT, GDOTC, GDOTU .................................... Computes a dot product (inner product) of two real or complex
vectors .......................................................................................................... 40
sasum, SASUM, SCASUM ........................................... Sums the absolute value of elements in a real or complex vector ............. 42
saxpby, SAXPBY, CAXPBY ...................................... Adds a scalar multiple of a real or complex vector x to a scalar
multiple of another real or complex vector y .............................................. 44
saxpy, SAXPY, CAXPY ............................................. Adds a scalar multiple of a real or complex vector to another real or
complex vector ............................................................................................ 46
scopy, SCOPY, CCOPY ............................................. Copies a real or complex vector into another real or complex vector ....... 48
sdot, SDOT, CDOTC, CDOTU .................................... Computes a dot product (inner product) of two real or complex
vectors .......................................................................................................... 50
shad, SHAD ................................................................ Computes the Hadamard product of two vectors ........................................ 52
snrm2, SNRM2, SCNRM2 ........................................... Computes the Euclidean norm of a vector .................................................. 54
spaxpy, SPAXPY ...................................................... Adds a scalar multiple of a real vector to a sparse real vector .................. 56
spdot, SPDOT ........................................................... Computes the dot product of a real vector and a real sparse vector .......... 57
srot, SROT, CROT .................................................... Applies a real plane rotation or complex coordinate rotation ..................... 58
srotg, SROTG, CROTG ............................................. Constructs a Givens plane rotation ............................................................. 60
srotm, SROTM ........................................................... Applies a modified Givens plane rotation ................................................... 62
srotmg, SROTMG ...................................................... Constructs a modified Givens plane rotation .............................................. 64
sscal, SSCAL, CSSCAL, CSCAL ............................. Scales a real or complex vector .................................................................. 70
ssum, SSUM, CSUM .................................................... Sums the elements of a real or complex vector .......................................... 72
sswap, SSWAP, CSWAP ............................................. Swaps two real or complex vectors ............................................................ 73
Matrix-vector linear algebra subprograms

intro_blas2, INTRO_BLAS2 ............................... Introduction to matrix-vector linear algebra subprograms .......................... 75
chbmv, CHBMV ........................................................... Multiplies a complex vector by a complex Hermitian band matrix ........... 78
chemv, CHEMV ........................................................... Multiplies a complex vector by a complex Hermitian matrix .................... 81
cher, CHER ................................................................
Performs Hermitian rank 1 update of a complex Hermitian matrix ........... 83
cher2, CHER2 ........................................................... Performs Hermitian rank 2 update of a complex Hermitian matrix ........... 85
chpmv, CHPMV ........................................................... Multiplies a complex vector by a packed complex Hermitian matrix ........ 87
chpr, CHPR ................................................................
Performs Hermitian rank 1 update of a packed complex Hermitian
matrix ........................................................................................................... 89
chpr2, CHPR2 ........................................................... Performs Hermitian rank 2 update of a packed complex Hermitian
matrix ........................................................................................................... 91
sgbmv, SGBMV, CGBMV ............................................. Multiplies a real or complex vector by a real or complex general
band matrix .................................................................................................. 93
004– 2081– 002 ix

sgemv, SGEMV, CGEMV ............................................. Multiplies a real or complex vector by a real or complex general
matrix ........................................................................................................... 96
sger, SGER, CGERC, CGERU .................................... Performs rank 1 update of a real general matrix ........................................ 98
sgesum, SGESUM, CGESUM ...................................... Adds a scalar multiple of a real or complex matrix to a scalar
multiple of another real or complex matrix .............................................. 100
ssbmv, SSBMV ........................................................... Multiplies a real vector by a real symmetric band matrix ........................ 102
sspmv, SSPMV, CSPMV ............................................. Multiplies a real or complex symmetric packed matrix by a real or
complex vector .......................................................................................... 104
sspr, SSPR, CSPR .................................................... Performs symmetric rank 1 update of a real or complex symmetric
packed matrix ............................................................................................ 106
sspr2, SSPR2 ........................................................... Performs symmetric rank 2 update of a real symmetric packed matrix ... 108
sspr12, SSPR12 ...................................................... Performs two simultaneous symmetric rank 1 updates of a real
symmetric packed matrix .......................................................................... 110
ssymv, SSYMV, CSYMV ............................................. Multiplies a real or complex vector by a real or complex symmetric
matrix ......................................................................................................... 112
ssyr, SSYR, CSYR .................................................... Performs symmetric rank 1 update of a real or complex symmetric
matrix ......................................................................................................... 114
ssyr2, SSYR2 ........................................................... Performs symmetric rank 2 update of a real symmetric matrix ............... 116
stbmv, STBMV, CTBMV ............................................. Multiplies a real or complex vector by a real or complex triangular
band matrix ................................................................................................ 118
stbsv, STBSV, CTBSV ............................................. Solves a real or complex triangular banded system of equations ............. 121
stpmv, STPMV, CTPMV ............................................. Multiplies a real or complex vector by a real or complex triangular
packed matrix ............................................................................................ 124
stpsv, STPSV, CTPSV ............................................. Solves a real or complex triangular packed system of equations ............. 126
strmv, STRMV, CTRMV ............................................. Multiplies a real or complex vector by a real or complex triangular
matrix ......................................................................................................... 128
strsv, STRSV, CTRSV ............................................. Solves a real or complex triangular system of equations ......................... 130
Matrix-matrix linear algebra subprograms

intro_blas3, INTRO_BLAS3 ............................... Introduction to matrix-matrix linear algebra subprograms ........................ 133
chemm, CHEMM ........................................................... Multiplies a complex general matrix by a complex Hermitian matrix ..... 135
cher2k, CHER2K ...................................................... Performs Hermitian rank 2k update of a complex Hermitian matrix ....... 138
cherk, CHERK ........................................................... Performs Hermitian rank k update of a complex Hermitian matrix ......... 141
scopy2, SCOPY2, CCOPY2 ...................................... Copies a real or complex matrix into another real or complex matrix .... 143
sgemm, SGEMM, CGEMM ............................................. Multiplies a real or complex general matrix by a real or complex
general matrix ............................................................................................ 145
sgemms, SGEMMS, CGEMMS ...................................... Multiplies a real or complex general matrix by a real or complex
general matrix, using Strassen’s algorithm ............................................... 148
ssymm, SSYMM, CSYMM ............................................. Multiplies a real or complex general matrix by a real or complex
symmetric matrix ....................................................................................... 152
ssyr2k, SSYR2K, CSYR2K ...................................... Performs symmetric rank 2k update of a real or complex symmetric
matrix ......................................................................................................... 155
ssyrk, SSYRK, CSYRK ............................................. Performs symmetric rank k update of a real or complex symmetric
matrix ......................................................................................................... 158
strmm, STRMM, CTRMM ............................................. Multiplies a real or complex general matrix by a real or complex
triangular matrix ........................................................................................ 160
Signal processing routines (FFT)

intro_fft, INTRO_FFT ........................................ Introduction to signal processing routines ................................................. 163
x 004– 2081– 002

ccfft, CCFFT ........................................................... Applies a multitasked complex-to-complex Fast Fourier Transform
(FFT) .......................................................................................................... 167
ccfft2d, CCFFT2D .................................................. Applies a two-dimensional complex-to-complex Fast Fourier
Transform (FFT) ........................................................................................ 172
ccfft3d, CCFFT3D .................................................. Applies a three-dimensional complex-to-complex Fast Fourier
Transform (FFT) ........................................................................................ 178
ccfftm, CCFFTM ...................................................... Applies multiple multitasked complex-to-complex Fast Fourier
Transforms (FFTs) ..................................................................................... 183
ccnvl, CCNVL ........................................................... Computes the convolution of a complex sequence with one or more
other complex sequences ........................................................................... 188
ccnvlf, CCNVLF ...................................................... Computes the convolution of a complex sequence with one or more
other complex sequences by using a Fourier transform method .............. 192
cfft, CFFT ................................................................ Applies a multitasked complex Fast Fourier Transform (FFT) ................ 195
cfft2, CFFT2 ........................................................... Applies a complex Fast Fourier Transform (FFT) .................................... 201
cfft2d, CFFT2D ...................................................... Applies a multitasked two-dimensional complex Fast Fourier
Transform (FFT) ........................................................................................ 202
cfft3d, CFFT3D ...................................................... Applies a multitasked three-dimensional complex Fast Fourier
Transform (FFT) ........................................................................................ 208
cfftmlt, CFFTMLT .................................................. Applies complex-to-complex Fast Fourier Transforms (FFTs) on
multiple input vectors ................................................................................ 215
crfft2, CRFFT2 ...................................................... Applies a complex-to-real Fast Fourier Transform (FFT) ........................ 217
descinit3d, DESCINIT3D ................................... Initializes a descriptor vector that contains information about the
distribution of a three-dimensional (3D) array across a 3D grid of
processors .................................................................................................. 219
filterg, FILTERG .................................................. Computes a correlation of two vectors ..................................................... 224
filters, FILTERS .................................................. Computes a correlation of two vectors (symmetric coefficient) ............... 225
ggfft, GGFFT ........................................................... Applies a multitasked complex-to-complex Fast Fourier Transform
(FFT) .......................................................................................................... 227
hconv, HCONV ........................................................... Performs the convolution of two sequences of real numbers ................... 231
hcorr, HCORR ........................................................... Performs the correlation of two sequences of real numbers ..................... 233
hcorrs, HCORRS ...................................................... Performs the correlation of two sequences of real numbers
(symmetric filter) ....................................................................................... 235
hgfft, HGFFT, GHFFT ............................................. Computes a real-to-complex or complex-to-real Fast Fourier
Transform (FFT) ........................................................................................ 237
hopfilt, HOPFILT .................................................. Solves Weiner-Levinson linear equations ................................................. 243
mcfft, MCFFT ........................................................... Applies multiple multitasked complex Fast Fourier Transforms
(FFTs) ........................................................................................................ 245
opfilt, OPFILT ...................................................... Solves Weiner-Levinson linear equations ................................................. 253
pccfft2d, PCCFFT2D ............................................. Applies a two-dimensional (2D) complex-to-complex Fast Fourier
Transform (FFT) to a matrix distributed across a set of processors ......... 255
pccfft3d, PCCFFT3D ............................................. Applies a three-dimensional (3D) complex-to-complex Fast Fourier
Transform (FFT) to a matrix distributed across a set of processors ......... 262
pscfft2d, PSCFFT2D, PCSFFT2D ........................ Applies a two-dimensional (2D) real-to-complex or complex-to-real
Fast Fourier Transform (FFT) to a matrix distributed across a set of
processors .................................................................................................. 269
pscfft3d, PSCFFT3D, PCSFFT3D ........................ Applies a three-dimensional (3D) real-to-complex or complex-to-real
Fast Fourier Transform (FFT) to a matrix distributed across a set of
processors .................................................................................................. 277
rcfft2, RCFFT2 ...................................................... Applies a real-to-complex Fast Fourier Transform (FFT) ........................ 285
rfftmlt, RFFTMLT .................................................. Applies complex-to-real or real-to-complex Fast Fourier Transforms
(FFTs) on multiple input vectors .............................................................. 286
004– 2081– 002 xi

scfft, SCFFT, CSFFT ............................................. Computes a real-to-complex or complex-to-real Fast Fourier
Transform (FFT) ........................................................................................ 290
scfft2d, SCFFT2D, CSFFT2D ............................... Applies a two-dimensional real-to-complex or complex-to-real Fast
Fourier Transform (FFT) ........................................................................... 296
scfft3d, SCFFT3D, CSFFT3D ............................... Applies a multitasked three-dimensional real-to-complex Fast Fourier
Transform (FFT) ........................................................................................ 303
scfftm, SCFFTM, CSFFTM ...................................... Applies multiple real-to-complex or complex-to-real Fast Fourier
Transforms (FFTs) ..................................................................................... 309
scnvl1d, SCNVL1D .................................................. Computes a real one-dimensional (1D) convolution of two vectors ........ 316
scnvl2d, SCNVL2D .................................................. Computes a real two-dimensional (2D) convolution of two matrices ...... 320
sconv, SCONV ........................................................... Performs the convolution of two sequences of real numbers ................... 326
scorr, SCORR ........................................................... Performs the correlation of two sequences of real numbers ..................... 328
scorrs, SCORRS ...................................................... Performs the correlation of two sequences of real numbers
(symmetric filter) ....................................................................................... 330
xii 004– 2081– 002

INTRO_LIBSCI ( 3S ) INTRO_LIBSCI ( 3S )
NAME
INTRO_LIBSCI – Introduction to Scientific Library routines
IMPLEMENTATION
See individual man pages for implementation details
DESCRIPTION
The printed versions of the Scientific Library routines appear in 3 volumes and are grouped according to
topics. Not all man pages are available on all hardware types; see the individual man pages for details about
supported hardware types.
Volume 1 contains the following topic sections:
• Solvers for dense linear systems and eigensystems (see INTRO_LAPACK(3S) introductory man page)
• Vector-vector linear algebra subprograms (see INTRO_BLAS1(3S) introductory man page)
• Matrix-vector linear algebra subprograms (see INTRO_BLAS2(3S) introductory man page)
• Matrix-matrix linear algebra subprograms (see INTRO_BLAS3(3S) introductory man page)
• Signal processing routines (see INTRO_FFT(3S) introductory man page)
Volume 2 contains the following topic sections:
• Solvers for dense linear systems and eigensystems (see INTRO_LAPACK(3S) introductory man page)
• Scalable LAPACK subprograms for UNICOS/mk systems (see INTRO_SCALAPACK(3S) introductory
man page)
• Solvers for sparse linear systems (not available on UNICOS/mk systems) (see INTRO_SPARSE(3S)
introductory man page)
• Solvers for special linear systems (not available on UNICOS/mk systems) (see INTRO_SPEC(3S)
• Basic Linear Algebra Communication Subprograms (BLACS) routines (see INTRO_BLACS(3S)
• Out-of-core routines (not available on UNICOS/mk systems) (see INTRO_CORE(3S) introductory man
page)
• Machine constant functions (see INTRO_MACH(3S) introductory man page)
• Superseded routines (not available on UNICOS/mk systems): (see INTRO_SUPERSEDED(3S)
004– 2081– 002 1

NOTES
Default kinds
When using the CF90 compiler or MIPSpro 7 Fortran 90 compiler on UNICOS, UNICOS/mk, or IRIX, all
arguments must be of default kind unless documented otherwise. On UNICOS and UNICOS/mk, default
kind is KIND=8 for integer, real, complex, and logical arguments; on IRIX, the default kind is KIND=4.
Multitasking
Many of the Scientific Library routines are multitasked. This means that a program that calls a multitasked
Scientific Library routine will run in parallel mode and take advantage of multiple processors whenever
possible, even if the program has not specifically requested multitasking. If a significant percentage of time
is spent in the Scientific Library routine, this feature can significantly reduce wall-clock time.
The NCPUS environment variable determines the maximum number of (logical) central processors that a
multitasked Scientific Library routine uses. If you do not define this variable, the default value is the
number of central processors on the system. To change the number of CPUs used, you can set the value of
NCPUS before your program is executed. If you do not want your program to run in multitasked mode, set
the value of NCPUS equal to 1.
To set the number of logical CPUs used by multitasked Scientific Library routines equal to n, use one of the
following commands.
Under the POSIX shell (sh) or Korn shell (ksh):
NCPUS= n
export NCPUS
Under C shell (csh):

setenv NCPUS n
The majority of LAPACK routines do perform multitasking.

Guidelines for Choosing NCPUS
The value of NCPUS can dramatically impact the performance of the routines in the Scientific Library.
Clearly, in a dedicated environment you should set NCPUS to the number of physical processors on the
machine to get optimal performance. However, in a multiuser environment, the choice of NCPUS is not as
simple. Setting NCPUS to a large number on a heavily loaded machine probably will lead to an increase in
both elapsed "wall-clock" time and user time. Setting NCPUS to a very small number can mean a lost
opportunity for better job turnaround time.
Multitasked Routines
The following tables display the Scientific Library routines that are multitasked. Each of these routines (or
one or more subprograms called by each routine) was compiled with Autotasking, except for those routines
marked as superseded. These routines (or one or more of its subprograms) were compiled with
microtasking.
2 004– 2081– 002

The routines are grouped by the section of the manual in which they appear, according to the list given
previously in the DESCRIPTION section of this man page. In many cases, a real variable (single-precision)
routine is paired with its complex variable equivalent.
LAPACK routines are not listed. Most LAPACK routines do not perform multiprocessing, but almost all
LAPACK routines call Level 2 BLAS and Level 3 BLAS that do multiprocessing.
The following are the multitasked Level 2 BLAS routines:
• SGBMV, CGBMV
• SGEMV, CGEMV
• SGER
• CGERC
• CGERU
• CHBMV
• SSBMV
• STRSV, CTRSV
• CHEMV
• CHER
• CHER2
• SSPR
• SSPR12
• SSYMV, CSYMV
• SSYR, CSYR
• SSYR2
• STBMV, CTBMV
• STBSV, CTBSV
• STRMV, CTRMV
The following are the multitasked Level 3 BLAS routines:
• SCOPY2, CCOPY2
• SGEMMS, CGEMMS
• SGEMM, CGEMM
• CHEMM
• CHER2K
• CHERK
004– 2081– 002 3

• SSYMM, CSYMM
• SSYR2K, CSYR2K
• SSYRK, CSYRK
• STRMM, CTRMM
• STRSM, CTRSM
The following are the multitasked LINPACK routines:
• SCHDD, CCHDD
• SCHEX, CCHEX
• SCHUD, CCHUD
• SGBFA, CGBFA
• SGEDI
• SGEFA
• SPODI, CPODI
• SSVDC, CSVDC
• STRDI, CTRDI
The following are the multitasked Out-of-core routines:
• SCOPY2RV, CCOPY2RV
• SCOPY2VR, CCOPY2VR
• VSGEMM, VCGEMM
• VSGETRF, VCGETRF
• VSGETRS, VCGETRS
• VSPOTRF, VSPOTRS
• VSTRSM, VCTRSM
The following are the multitasked EISPACK routines:
• BAKVEC
• BALBAK
• BANDR
• CBABK2
• COMBAK
• COMLR2
• COMQR2
4 004– 2081– 002

• CORTB
• CORTH
• FIGI2
• HQR2
• HTRIB3
• HTRIDI
• IMTQLV
• MINFIT
• QZIT
• REBAKB
• REDUC
• REDUC2
• SVD
• TRED2
The following are the multitasked Sparse routines:
• SITRSOL
• SSGETRF
• SSGETRS
• SSPOTRF
• SSPOTRS
• SSTSTRF
• SSTSTRS
The following are the multitasked Signal processing routines:
• CCNVL
• CCNVLF
• CCFFT
• CCFFTM
• CCFFT2D
• CCFFT3D
004– 2081– 002 5

The following are the multitasked Superseded routines:

• MXM
• MXMA
• MXV
• MXVA
• SMXPY
• SXMPY
Multiple-routine Man Pages
Many of the routines in the Scientific Library are available in both real (single-precision) and complex
versions. Often little or no difference exists between these versions, other than the data types of some inputs
and outputs. In this case, the routines are described on the same man page, and that man page is named
after the real (single-precision) routine.
The man(1) command can find such a man page online by either the real or complex routine name.
However, in this manual, you may have to search for the real equivalent of any complex routine you want to
find. Typically, the real routine name is the same as the complex routine name, except that when the
complex routine name’s first or second letter is C (for complex), the real routine name’s first or second letter
is S (for single precision).
SEE ALSO
INTRO_BLACS(3S), INTRO_BLAS1(3S), INTRO_BLAS2(3S), INTRO_BLAS3(3S), INTRO_FFT(3S),
INTRO_LAPACK(3S), INTRO_MACH(3S), INTRO_SCALAPACK(3S)
The following man pages are not available on UNICOS/mk systems:
INTRO_CORE(3S), INTRO_SPARSE(3S), INTRO_SPEC(3S), INTRO_SUPERSEDED(3S)
6 004– 2081– 002

INTRO_LAPACK ( 3S ) INTRO_LAPACK ( 3S )
NAME
INTRO_LAPACK – Introduction to LAPACK solvers for dense linear systems
IMPLEMENTATION
DESCRIPTION
The preferred solvers for dense linear systems are those parts of the LAPACK package included in the
current version of the Scientific Library. The LAPACK routines in the Scientific Library supersede the older
LINPACK routines (see LINPACK(3S) for more information).
LAPACK Routines
LAPACK is a public domain library of subroutines for solving dense linear algebra problems, including the
following:
• Systems of linear equations
• Linear least squares problems
• Eigenvalue problems
• Singular value decomposition (SVD) problems
For details about which routines are supported, see LAPACK Routines Contained in the Scientific Library,
which follows.
The LAPACK package is designed to be the successor to the older LINPACK and EISPACK packages. It
uses today’s high-performance computers more efficiently than the older packages. It also extends the
functionality of these packages by including equilibration, iterative refinement, error bounds, and driver
routines for linear systems, routines for computing and reordering the Schur factorization, and condition
estimation routines for eigenvalue problems.
Performance issues are addressed by implementing the most computationally-intensive algorithms by using
the Level 2 and 3 Basic Linear Algebra Subprograms (BLAS). Because most of the BLAS were optimized
in single- and multiple-processor environments for UNICOS and UNICOS/mk systems, these algorithms give
near optimal performance.
The original Fortran programs are described in the LAPACK User’s Guide by E. Anderson, Z. Bai,
C. Bischof, J. Demmel, J. Dongarra, J. Du Croz, A. Greenbaum, S. Hammarling, A. McKenney,
S. Ostrouchov, and D. Sorensen, published by the Society for Industrial and Applied Mathematics (SIAM),
Philadelphia, 1992. You can order the LAPACK User’s Guide, publication TPD– 0003.
LAPACK Routines Contained in the Scientific Library
Most of the single-precision (64-bit) real and complex routines from LAPACK 2.0 are supported in the
Scientific Library. This includes driver routines and computational routines for solving linear systems, least
squares problems, and eigenvalue and singular value problems. Selected auxiliary routines for generating
and manipulating elementary orthogonal transformations are also supported.
004– 2081– 002 7

The Scientific Library does not include the LAPACK driver routines for certain generalized eigenvalue and
singular value computations and the divide-and-conquer routines for computing eigenvalues, which were new
for LAPACK 2.0. This may be added in a future release. Also, most of the auxiliary routines used only
internally by LAPACK have been renamed to avoid conflicts with user-defined subroutine names.
The LAPACK routines in the Scientific Library are described online in man pages. For example, to see a
description of the arguments to the expert driver routine for solving a general system of equations, enter the
following command:
% man sgesvx
The user interface to all LAPACK routines is exactly the same as the standard LAPACK interface, except
for the CPTSV(3L) and CPTSVX(3L) driver routines. An optional character argument was added to CPTSV
and CPTSVX to afford upward compatibility with the storage format in LINPACK’s CPTSL. However,
because the argument is optional the LAPACK calling sequence also is accepted.
Several enhancements were made to the public-domain LAPACK software to improve performance for
UNICOS and UNICOS/mk systems. In particular, the solve routines were redesigned to give better
performance for one or a small number of right-hand sides, and to make better use of parallelism when the
number of right-hand sides is large.
Tuning parameters for the block algorithms provided in the Scientific Library are set within the LAPACK
routine ILAENV(3L). ILAENV(3L) is an integer function subprogram that accepts information about the
problem type and dimensions, and it returns one integer parameter, such as the optimal block size, the
minimum block size for which a block algorithm should be used, or the crossover point (the problem size at
which it becomes more efficient to switch to an unblocked algorithm). The setting of tuning parameters
occurs without user intervention, but users may call ILAENV(3L) directly to discover the values that will be
used (for example, to determine how much workspace to provide).
Naming Scheme
The name of each LAPACK routine is a coded specification of its function (within the limits of standard
FORTRAN 77 six-character names).
All driver and computational routines have five- or six-character names of the form XYYZZ or XYYZZZ.
The first letter in each name, X, indicates the data type, as follows:
S REAL (single precision)
C COMPLEX
The next two letters, YY, indicate the type of matrix (or the most-significant matrix). Most of these
two-letter codes apply to both real and complex matrices, but a few apply specifically to only one or the
other. The matrix types are as follows:
BD BiDiagonal
GB General Band
GE GEneral (nonsymmetric)
GG General matrices, Generalized problem
8 004– 2081– 002

GT General Tridiagonal
HB Hermitian Band (complex only)
HE HErmitian (possibly indefinite) (complex only)
HG Hessenberg matrix, Generalized problem
HP Hermitian Packed (possibly indefinite) (complex only)
HS upper HeSsenberg
OP Orthogonal Packed (real only)
OR ORthogonal (real only)
PB Positive definite Band (symmetric or Hermitian)
PO POsitive definite (symmetric or Hermitian)
PP Positive definite Packed (symmetric or Hermitian)
PT Positive definite Tridiagonal (symmetric or Hermitian)
SB Symmetric Band (real only)
SP Symmetric Packed (possibly indefinite)
ST Symmetric Tridiagonal
SY SYmmetric (possibly indefinite)
TB Triangular Band
TG Triangular matrices, Generalized problem
TP Triangular Packed
TR TRiangular
TZ TrapeZoidal
UN UNitary (complex only)
UP Unitary Packed (complex only)
Some LAPACK auxiliary routines also have man pages on UNICOS and UNICOS/mk systems. These
routines use the special YY designation:
LA LAPACK Auxiliary routine
For example, ILAENV(3) is the auxiliary routine that determines the block size for a particular algorithm and
problem size.
The last two or three letters, ZZ or ZZZ, indicate the computation performed. For example, SGETRF
performs a TRiangular Factorization of a Single-precision (real) GEneral matrix; CGETRF performs the
factorization of a Complex GEneral matrix.
004– 2081– 002 9

Lists of Available LAPACK Routines

The following pages contain tables of driver and computational routines from LAPACK available in the
Scientific Library. For details about the argument lists and usage of these routines, see the individual online
man pages or the LAPACK User’s Guide, publication TPD– 0003.
Driver Routines
These routines are listed in alphabetical order.
Name Purpose
CHESV Solves a complex Hermitian indefinite system of linear equations AX = B.

CHESVX Solves a complex Hermitian indefinite system of linear equations AX = B and provides an
estimate of the condition number and error bounds on the solution.
CHPSV Solves a complex Hermitian indefinite system of linear equations AX = B; A is held in
packed storage.
CHPSVX Solves a complex Hermitian indefinite system of linear equations AX = B (A is held in
packed storage) and provides an estimate of the condition number and error bounds on the
solution.
SGBSV Solves a general banded system of linear equations AX = B.
CGBSV
SGBSVX Solves any of the following general banded systems of linear equations and provides an
CGBSVX estimate of the condition number and error bounds on the solution.
AX = B
T
A X=B
H
A X=B
SGEES Compute eigenvalues, Schur form, and Schur vectors of a general matrix
CGEES
SGEESX Compute eigenvalues, Schur form, Schur vectors, and condition numbers of a general matrix
CGEESX
SGEEV Compute eigenvalues and eigenvectors of a general matrix
CGEEV
SGEEVX Compute eigenvalues, eigenvectors, and condition numbers of a general matrix
CGEEVX
SGEGS Compute the generalized Schur factorization of a matrix pair (A,B)
CGEGS
SGEGV Compute the eigenvalues and eigenvectors of a matrix pair (A,B)
CGEGV
10 004– 2081– 002

Name Purpose
SGELS Finds a least squares or minimum norm solution of an overdetermined or underdetermined

CGELS linear system.
SGELSS Solve linear least squares problem using SVD
CGELSS
SGELSX Computes a minimum norm solution of a linear least squares problem using a complete
CGELSX orthogonal factorization.
SGESV Solves a general system of linear equations AX = B.
CGESV
SGESVD Compute the singular value decomposition (SVD) of a general matrix
CGESVD
SGESVX Solves any of the following general systems of linear equations and provides an estimate of
CGESVX the condition number and error bounds on the solution.
AX = B
T
A X=B
H
A X=B
SGTSV Solves a general tridiagonal system of linear equations AX = B.
CGTSV
SGTSVX Solves any of the following general tridiagonal systems of linear equations and provides an
CGTSVX estimate of the condition number and error bounds on the solution.
AX = B
T
A X=B
H
A X=B
SPBSV Solves a symmetric or Hermitian positive definite banded system of linear equations
CPBSV AX = B.
SPBSVX Solves a symmetric or Hermitian positive definite banded system of linear equations AX = B
CPBSVX and provides an estimate of the condition number and error bounds on the solution.
SPOSV Solves a symmetric or Hermitian positive definite system of linear equations AX = B.
CPOSV
SPOSVX Solves a symmetric or Hermitian positive definite system of linear equations AX = B and
CPOSVX provides an estimate of the condition number and error bounds on the solution.
SPPSV Solves a symmetric or Hermitian positive definite system of linear equations AX = B; A is
CPPSV held in packed storage.
004– 2081– 002 11

Name Purpose
SPPSVX Solves a symmetric or Hermitian positive definite system of linear equations AX = B (A is

CPPSVX held in packed storage) and provides an estimate of the condition number and error bounds
on the solution.
SPTSV Solves a symmetric or Hermitian positive definite tridiagonal system of linear equations
CPTSV AX = B.
SPTSVX Solves a symmetric or Hermitian positive definite tridiagonal system of linear equations
CPTSVX AX = B and provides an estimate of the condition number and error bounds on the solution.
SSBEV Compute all eigenvalues and eigenvectors of a symmetric or Hermitian band matrix
CHBEV
SSBEVX Compute selected eigenvalues and eigenvectors of a symmetric or Hermitian band matrix
CHBEVX
SSBGV Compute all eigenvalues and eigenvectors of a generalized symmetric-definite or Hermitian-
CHBGV definite banded eigenproblem
SSPEV Compute all eigenvalues and eigenvectors of a symmetric or Hermitian packed matrix
CHPEV
SSPEVX Compute selected eigenvalues and eigenvectors of a symmetric or Hermitian packed matrix
CHPEVX
SSPGV Compute all eigenvalues and eigenvectors of a generalized symmetric-definite or
CHPGV Hermitian-definite packed eigenproblem
SSPSV Solves a real or complex symmetric indefinite system of linear equations AX = B; A is held
CSPSV in packed storage.
SSPSVX Solves a real or complex symmetric indefinite system of linear equations AX = B (A is held
CSPSVX in packed storage) and provides an estimate of the condition number and error bounds on
the solution.
SSTEV Compute all eigenvalues and eigenvectors of a real symmetric tridiagonal matrix
SSTEVX Compute selected eigenvalues and eigenvectors of a real symmetric tridiagonal matrix
SSYEV Compute all eigenvalues and eigenvectors of a symmetric or Hermitian matrix
CHEEV
SSYEVX Compute selected eigenvalues and eigenvectors of a symmetric or Hermitian matrix
CHEEVX
SSYGV Compute all eigenvalues and eigenvectors of a generalized symmetric-definite or
CHEGV Hermitian-definite eigenproblem
SSYSV Solves a real or complex symmetric indefinite system of linear equations AX = B.
CSYSV
12 004– 2081– 002

Name Purpose
SSYSVX Solves a real or complex symmetric indefinite system of linear equations AX = B and
CSYSVX provides an estimate of the condition number and error bounds on the solution.
Computational Routines
These computational routines are listed in alphabetical order, with real matrix routines and complex matrix
routines grouped together as appropriate.
Name Purpose
CHECON Estimates the reciprocal of the condition number of a complex Hermitian indefinite matrix,
using the factorization computed by CHETRF.
CHERFS Improves the computed solution to a complex Hermitian indefinite system of linear
equations AX = B and provides error bounds for the solution.
CHETRF Computes the factorization of a complex Hermitian indefinite matrix, using the diagonal
pivoting method.
CHETRI Computes the inverse of a complex Hermitian indefinite matrix, using the factorization
computed by CHETRF.
CHETRS Solves a complex Hermitian indefinite system of linear equations AX = B, using the
factorization computed by CHETRF.
CHPCON Estimates the reciprocal of the condition number of a complex Hermitian indefinite matrix
in packed storage, using the factorization computed by CHPTRF.
CHPRFS Improves the computed solution to a complex Hermitian indefinite system of linear
equations AX = B (A is held in packed storage) and provides error bounds for the solution.
CHPTRF Computes the factorization of a complex Hermitian indefinite matrix in packed storage,
using the diagonal pivoting method.
CHPTRI Computes the inverse of a complex Hermitian indefinite matrix in packed storage, using the
factorization computed by CHPTRF.
CHPTRS Solves a complex Hermitian indefinite system of linear equations AX = B (A is held in
packed storage) using the factorization computed by CHPTRF.
ILAENV Determines tuning parameters (such as the block size).
SBDSQR Compute the singular value decomposition of a general matrix reduced to bidiagonal form
CBDSQR
SGBCON Estimates the reciprocal of the condition number of a general band matrix, in either the 1-
CGBCON norm or the infinity-norm, using the LU factorization computed by SGBTRF or CGBTRF.
004– 2081– 002 13

Name Purpose
SGBEQU Computes row and column scalings to equilibrate a general band matrix and reduce its
CGBEQU condition number. Does not multiprocess or call any multiprocessing routines.
SGBRFS Improves the computed solution to any of the following general banded systems of linear
CGBRFS equations and provides error bounds for the solution.
AX = B
T
A X=B
H
A X=B
SGBTRF Computes an LU factorization of a general band matrix, using partial pivoting with row
CGBTRF interchanges.
SGBTRS Solves any of the following general banded systems of linear equations using the LU
CGBTRS factorization computed by SGBTRF or CGBTRF.
AX = B
T
A X=B
H
A X=B
SGEBAK Back transform the eigenvectors of a matrix transformed by SGEBAL/CGEBAL.
CGEBAK
SGEBAL Balances a general matrix A.
CGEBAL
SGEBRD Reduces a general matrix to upper or lower bidiagonal form by an orthogonal/unitary
CGEBRD transformation.
SGECON Estimates the reciprocal of the condition number of a general matrix, in either the 1-norm or
CGECON the infinity-norm, using the LU factorization computed by SGETRF or CGETRF.
SGEEQU Computes row and column scalings to equilibrate a general rectangular matrix and to reduce
CGEEQU its condition number.
SGEHRD Reduces a general matrix to upper Hessenberg form by an orthogonal/unitary transformation.
CGEHRD
SGELQF Computes an LQ factorization of a general rectangular matrix.
CGELQF
SGEQLF Computes a QL factorization of a general rectangular matrix.
CGEQLF
SGEQPF Computes a QR factorization with column pivoting of a general rectangular matrix.
CGEQPF
14 004– 2081– 002

Name Purpose
SGEQRF Computes a QR factorization of a general rectangular matrix.

CGEQRF
SGERFS Improves the computed solution to any of the following general systems of linear equations
CGERFS and provides error bounds for the solution.
AX = B
T
A X=B
H
A X=B
SGERQF Computes an RQ factorization of a general rectangular matrix.
CGERQF
SGETRF Computes an LU factorization of a general matrix, using partial pivoting with row
CGETRF interchanges.
SGETRI Computes the inverse of a general matrix, using the LU factorization computed by SGETRF
CGETRI or CGETRF.
SGETRS Solves any of the following general systems of linear equations using the LU factorization
CGETRS computed by SGETRF or CGETRF.
AX = B
T
A X=B
H
A X=B
SGGBAK Back transform the eigenvectors of a generalized eigenvalue problem transformed by
CGGBAK SGGBAL
SGGBAL Balance a pair of general matrices (A,B)
CGGBAL
SGGHRD Reduce a pair of matrices (A,B) to generalized upper Hessenberg form
CGGHRD
SGTCON Estimates the reciprocal of the condition number of a general tridiagonal matrix, in either
CGTCON the 1-norm or the infinity-norm, using the LU factorization computed by SGTTRF or
CGTTRF.
SGTRFS Improves the computed solution to any of the following general tridiagonal systems of linear
CGTRFS equations and provides error bounds for the solution.
AX = B
T
A X=B
H
A X=B
004– 2081– 002 15

Name Purpose
SGTTRF Computes an LU factorization of a general tridiagonal matrix, using partial pivoting with
CGTTRF row interchanges.
SGTTRS Solves a general tridiagonal system of linear equations using the LU factorization computed
CGTTRS by SGTTRF or CGTTRF. AX = B
T
A X=B
H
A X=B
SHGEQZ Compute the eigenvalues of a matrix pair (A,B) in generalized upper Hessenberg form using
CHGEQZ the QZ method
SHSEIN Compute eigenvectors of a upper Hessenberg matrix by inverse iteration
CHSEIN
SHSEQR Compute eigenvalues, Schur form, and Schur vectors of a upper Hessenberg matrix
CHSEQR
SLAMCH Computes machine-specific constants.
SLARF Applies an elementary reflector.
CLARF
SLARFB Applies a block reflector.
CLARFB
SLARFG Generates an elementary reflector.
CLARFG
SLARFT Forms the triangular factor of a block reflector.
CLARFT
SLARGV Generate a vector of real or complex plane rotations
CLARGV
SLARNV Generates a vector of random numbers.
CLARNV
SLARTG Generates a plane rotation.
CLARTG
SLARTV Apply a vector of real or complex plane rotations to two vectors
CLARTV
SLASR Apply a sequence of real plane rotations to a matrix
CLASR
SOPGTR Generates the orthogonal/unitary matrix Q from SSPTRD/CHPTRD.
CUPGTR
16 004– 2081– 002

Name Purpose
SOPMTR Multiplies by the orthogonal/unitary matrix Q from SSPTRD/CHPTRD.

CUPMTR
SORGBR Generates one of the orghogonal/unitary matrices Q or P H from SGEBRD/CGEBRD.
CUNGBR
SORGHR Generates the orthogonal/unitary matrix Q from SGEHRD/CGEHRD.
CUNGHR
SORGLQ Generates all or part of the orthogonal or unitary matrix Q from an LQ factorization
CUNGLQ determined by SGELQF or CGELQF.
SORGQL Generates all or part of the orthogonal or unitary matrix Q from a QL factorization
CUNGQL determined by SGEQLF or CGEQLF.
SORGQR Generates all or part of the orthogonal or unitary matrix Q from a QR factorization
CUNGQR determined by SGEQRF or CGEQRF.
SORGRQ Generates all or part of the orthogonal or unitary matrix Q from an RQ factorization
CUNGRQ determined by SGERQF or CGERQF.
SORGTR Generates the orthogonal/unitary matrix Q from SSYTRD/CHETRD.
CUNGTR
SORMBR Multiplies by one of the orthogonal/unitary matrices Q or P from SGEBRD/CGEBRD.
CUNMBR
SORMHR Multiplies by the orthogonal/unitary matrix Q from SGEHRD/CGEHRD.
CUNMHR
SORMLQ Multiplies a general matrix by the orthogonal or unitary matrix from an LQ factorization
CUNMLQ determined by SGELQF or CGELQF.
SORMQL Multiplies a general matrix by the orthogonal or unitary matrix from a QL factorization
CUNMQL determined by SGEQLF or CGEQLF.
SORMQR Multiplies a general matrix by the orthogonal or unitary matrix from a QR factorization
CUNMQR determined by SGEQRF or CGEQRF.
SORMRQ Multiplies a general matrix by the orthogonal or unitary matrix from an RQ factorization
CUNMRQ determined by SGERQF or CGERQF.
SORMTR Multiplies by the orthogonal/unitary matrix Q from SSYTRD/CHETRD.
CUNMTR
SPBCON Estimates the reciprocal of the condition number of a symmetric or Hermitian positive
CPBCON definite band matrix, using the Cholesky factorization computed by SPBTRF or CPBTRF.
SPBEQU Computes row and column scalings to equilibrate a symmetric or Hermitian positive definite
CPBEQU band matrix and to reduce its condition number.
004– 2081– 002 17

Name Purpose
SPBRFS Improves the computed solution to a symmetric or Hermitian positive definite banded
CPBRFS system of linear equations AX = B and provides error bounds for the solution.
SPBSTF Compute a split Cholesky factorization of a symmetric or Hermitian positive definite band
CPBSTF matrix.
SPBTRF Computes the Cholesky factorization of a symmetric or Hermitian positive definite band
CPBTRF matrix.
SPBTRS Solves a symmetric or Hermitian positive definite banded system of linear equations AX =
CPBTRS B, using the Cholesky factorization computed by SPBTRF or CPBTRF.
SPOCON Estimates the reciprocal of the condition number of a symmetric or Hermitian positive
CPOCON definite matrix, using the Cholesky factorization computed by SPOTRF or CPOTRF.
SPOEQU Computes row and column scalings to equilibrate a symmetric or Hermitian positive definite
CPOEQU matrix and reduces its condition number.
SPORFS Improves the computed solution to a symmetric or Hermitian positive definite system of
CPORFS linear equations AX = B and provides error bounds for the solution.
SPOTRF Computes the Cholesky factorization of a symmetric or Hermitian positive definite matrix.
CPOTRF
SPOTRI Computes the inverse of a symmetric or Hermitian positive definite matrix, using the
CPOTRI Cholesky factorization computed by SPOTRF or CPOTRF.
SPOTRS Solves a symmetric or Hermitian positive definite system of linear equations AX = B, using
CPOTRS the Cholesky factorization computed by SPOTRF or CPOTRF.
SPPCON Estimates the reciprocal of the condition number of a symmetric or Hermitian positive
CPPCON definite matrix in packed storage, using the Cholesky factorization computed by SPPTRF or
CPPTRF.
SPPEQU Computes row and column scalings to equilibrate a symmetric or Hermitian positive definite
CPPEQU matrix in packed storage and reduces its condition number.
SPPRFS Improves the computed solution to a symmetric or Hermitian positive definite system of
CPPRFS linear equations AX = B (A is held in packed storage) and provides error bounds for the
solution.
SPPTRF Computes the Cholesky factorization of a symmetric or Hermitian positive definite matrix in
CPPTRF packed storage.
SPPTRI Computes the inverse of a symmetric or Hermitian positive definite matrix in packed
CPPTRI storage, using the Cholesky factorization computed by SPPTRF or CPPTRF.
SPPTRS Solves a symmetric or Hermitian positive definite system of linear equations AX = B (A is
CPPTRS held in packed storage) using the Cholesky factorization computed by SPPTRF or CPPTRF.
18 004– 2081– 002

Name Purpose
H
SPTCON Uses the LDL factorization computed by SPTTRF or CPTTRF to compute the reciprocal
CPTCON of the condition number of a symmetric or Hermitian positive definite tridiagonal matrix.
SPTEQR Compute eigenvalues and eigenvectors of a symmetric or Hermitian positive definite
CPTEQR tridiagonal matrix.
SPTRFS Improves the computed solution to a symmetric or Hermitian positive definite tridiagonal
CPTRFS system of linear equations AX = B and provides error bounds for the solution.
SPTTRF Computes the LDL H factorization of a symmetric or Hermitian positive definite tridiagonal
CPTTRF matrix.
H
SPTTRS Uses the LDL factorization computed by SPTTRF or CPTTRF to solve a symmetric or
CPTTRS Hermitian positive definite tridiagonal system of linear equations.
SSBGST Reduce a symmetric or Hermitian definite banded generalized eigenproblem to standard
CHBGST form.
SSBTRD Reduce a symmetric or Hermitian band matrix to real symmetric tridiagonal form by an
CHBTRD orthogonal/unitary transformation.
SSPCON Estimates the reciprocal of the condition number of a real or complex symmetric indefinite
CSPCON matrix in packed storage, using the factorization computed by SSPTRF or CSPTRF.
SSPGST Reduce a symmetric or Hermitian definite generalized eigenproblem to standard form, using
CHPGST packed storage.
SSPRFS Improves the computed solution to a real or complex symmetric indefinite system of linear
CSPRFS equations AX = B (A is held in packed storage) and provides error bounds for the solution.
SSPTRD Reduces a symmetric/Hermitian packed matrix A to real symmetric tridiagonal form by an
CHPTRD orthogonal/unitary transformation.
SSPTRF Computes the factorization of a real or complex symmetric indefinite matrix in packed
CSPTRF storage, using the diagonal pivoting method.
SSPTRI Computes the inverse of a real or complex symmetric indefinite matrix in packed storage,
CSPTRI using the factorization computed by SSPTRF or CSPTRF.
SSPTRS Solves a real or complex symmetric indefinite system of linear equations AX = B (A is held
CSPTRS in packed storage) using the factorization computed by SSPTRF or CSPTRF.
SSTEBZ Compute eigenvalues of a symmetric tridiagonal matrix by bisection.
SSTEIN Compute eigenvectors of a real symmetric tridiagonal matrix by inverse iteration.
CSTEIN
SSTEQR Compute eigenvalues and eigenvectors of a real symmetric tridiagonal matrix using the
CSTEQR implicit QL or QR method.
004– 2081– 002 19

Name Purpose
SSTERF Compute all eigenvalues of a symmetric tridiagonal matrix using the root-free variant of the
QL or QR algorithm.
SSYCON Estimates the reciprocal of the condition number of a real or complex symmetric indefinite
CSYCON matrix, using the factorization computed by SSYTRF or CSYTRF.
SSYGST Reduce a symmetric or Hermitian definite generalized eigenproblem to standard form.
CHEGST
SSYRFS Improves the computed solution to a real or complex symmetric indefinite system of linear
CSYRFS equations AX = B and provides error bounds for the solution.
SSYTRD Reduces a symmetric/Hermitian matrix A to real symmetric tridiagonal form by an
CHETRD orthogonal/unitary transformation.
SSYTRF Computes the factorization of a real complex symmetric indefinite matrix, using the
CSYTRF diagonal pivoting method.
SSYTRI Computes the inverse of a real or complex symmetric indefinite matrix, using the
CSYTRI factorization computed by SSYTRF or CSYTRF.
SSYTRS Solves a real or complex symmetric indefinite system of linear equations AX = B, using the
CSYTRS factorization computed by SSYTRF or CSYTRF.
STBCON Estimates the reciprocal of the condition number of a triangular band matrix, in either the
CTBCON 1-norm or the infinity-norm.
STBRFS Provides error bounds for the solution of any of the following triangular banded systems of
CTBRFS linear equations:
AX = B
T
A X=B
H
A X=B
STBTRS Solves any of the following triangular banded systems of linear equations:
CTBTRS AX = B
T
A X=B
H
A X=B
STGEVC Compute eigenvectors of a pair of matrices (A,B) in generalized Schur form.
CTGEVC
STPCON Estimates the reciprocal of the condition number of a triangular matrix in packed storage, in
CTPCON either the 1-norm or the infinity-norm.
20 004– 2081– 002

Name Purpose
STPRFS Provides error bounds for the solution of any of the following triangular systems of linear
CTPRFS equations where A is held in packed storage.
AX = B
T
A X=B
H
A X=B
STPTRI Computes the inverse of a triangular matrix in packed storage.
CTPTRI
STPTRS Solves any of the following triangular systems of linear equations where A is held in packed
CTPTRS storage.
AX = B
T
A X=B
H
A X=B
STRCON Estimates the reciprocal of the condition number of a triangular matrix, in either the 1-norm
CTRCON or the infinity-norm.
STREVC Compute eigenvectors of a real upper quasi-triangular matrix.
CTREVC Compute eigenvectors of a complex triangular matrix.
STREXC Exchange diagonal blocks in the real Schur factorization of a real matrix.
CTREXC Exchange diagonal elements in the Schur factorization of a complex matrix.
STRRFS Provides error bounds for the solution of any of the following triangular systems of linear
CTRRFS equations:
AX = B
T
A X=B
H
A X=B
STRSEN Compute condition numbers to measure the sensitivity of a cluster of eigenvalues and its
CTRSEN corresponding invariant subspace.
STRSNA Compute condition numbers for specified eigenvalues and eigenvectors of a real upper
quasi-triangular matrix.
CTRSNA Compute condition numbers for specified eigenvalues and eigenvectors of a complex upper
triangular matrix.
STRSYL Solve the Sylvester matrix equation
CTRSYL
004– 2081– 002 21

Name Purpose
STRTRI Computes the inverse of a triangular matrix.

CTRTRI
STRTRS Solves any of the following triangular systems of linear equations:
CTRTRS AX = B
T
A X=B
H
A X=B
STRZRQF Reduces an upper trapezoidal matrix to upper triangular form by an orthogonal/unitary
CTZRQF transformation.
SEE ALSO
LINPACK(3S) which lists the names of the LINPACK routines that are superseded by the linear system
solvers in LAPACK
LAPACK User’s Guide, CRI publication TPD– 0003
22 004– 2081– 002

EISPACK ( 3S ) EISPACK ( 3S )
NAME
EISPACK – Introduction to Eigensystem computation for dense linear systems
IMPLEMENTATION
UNICOS systems (except Cray T90 systems that support IEEE arithmetic)
DESCRIPTION
EISPACK is a package of Fortran routines for solving the eigenvalue problem and for computing and using
the singular-value decomposition.
The original Fortran versions are described in the Matrix Eigensystem Routines – EISPACK Guide, second
edition, by B. T. Smith, J. M. Boyle, J. J. Dongarra, B. S. Garbow, Y. Ikebe, V. C. Klema, and C. B. Moler,
published by Springer-Verlag, New York, 1976, Library of Congress catalog card number 76– 2662. The
original Fortran versions also are documented in the Matrix Eigensystem Routines - EISPACK Guide
Extensions (Lecture Notes in Computer Science, Vol. 51) by B. S. Garbow, J. M. Boyle, J. J. Dongarra, and
C. B. Moler, published by Springer-Verlag, New York, 1977, Library of Congress catalog card number
77– 2802.
Most EISPACK routines are superseded by routines from the more recent public domain package, LAPACK,
described in the LAPACK User’s Guide (see INTRO_LAPACK(3S) for a complete reference). Of particular
interest to EISPACK users who want to switch to LAPACK is Appendix D, "Converting from LINPACK
and EISPACK," of the LAPACK User’s Guide. This appendix contains a table that shows the name of the
LAPACK routines that are functionally equivalent to each EISPACK routine.
Each Scientific Library version of the EISPACK routines has the same name, algorithm, and calling
sequence as the original version. Optimization of each routine includes the following:
• Use of the Level 1 BLAS routines when applicable, and use of the Level 2 and 3 BLAS in TRED1,
TRED2, TRBAK, and REDUC.
• Removal of Fortran IF statements when the result of either branch is the same.
• Unrolling complicated Fortran DO loops to improve vectorization.
• Use of Fortran compiler directives to aid vector optimization.
These modifications increase vectorization and use optimized library routines; therefore, they reduce
execution time. Only the order of computations within a loop is changed; the modified versions produce the
same answers as the original versions, unless the problem is sensitive to small changes in the data.
004– 2081– 002 23

The following table lists the routines, name, matrix or decomposition, and purpose for each routine.
Purpose Matrix or Decomposition Name
Forms eigenvectors by back transforming corresponding Real nonsymmetric tridiagonal BAKVEC

matrix determined by FIGI
Balances matrix and isolates eigenvalues when possible Real general BALANC
Forms eigenvectors by back transforming those of the Real general BALBAK
corresponding matrices determined by BALANC
Finds the eigenvalues that lie in a specified interval by using Real symmetric tridiagonal BISECT
bisection
Forms eigenvectors by back transforming those of the Complex general CBABK2
corresponding matrices determined by CBAL
Balances matrix and isolates eigenvalues when possible Complex general CBAL
Reduces to a symmetric tridiagonal matrix Real symmetric banded BANDR
Finds those eigenvectors that correspond to ordered list of Real symmetric banded BANDV
eigenvalues by using inverse iteration
Finds some eigenvalues by using QR algorithm with shifts Real symmetric banded BQR
of origin
Finds eigenvalues and eigenvectors Complex general CG
Finds eigenvalues and eigenvectors Complex Hermitian CH
Finds eigenvectors that correspond to specified eigenvalues Complex upper Hessenberg CINVIT
by using inverse iteration
Forms eigenvectors by back transforming those of the Complex general COMBAK
corresponding matrices determined by COMHES
Reduces matrix to upper Hessenberg form by using Complex general COMHES
elementary similarity transformations
Finds eigenvalues by using modified LR method Complex upper Hessenberg COMLR
Finds eigenvalues and eigenvectors, by using modified LR Complex upper Hessenberg COMLR2
method
Finds eigenvalues by QR method Complex upper Hessenberg COMQR
Finds eigenvalues and eigenvectors by QR method Complex upper Hessenberg COMQR2
Forms eigenvectors by back transforming those of the Complex general CORTB
corresponding matrices determined by CORTH
24 004– 2081– 002

Reduces matrix to upper Hessenberg form by using unitary Complex general CORTH
similarity transformations
Forms eigenvectors by back transforming those of the Real general ELMBAK
corresponding matrices determined by ELMHES
Reduces matrix to upper Hessenberg form by using Real general ELMHES
elementary similarity transformations
Accumulates transformations used in the reduction to upper Real general ELTRAN
Hessenberg form done by ELMHES
Reduces to symmetric tridiagonal matrix that has the same Real nonsymmetric tridiagonal FIGI
eigenvalues
Reduces to symmetric tridiagonal matrix that has the same Real nonsymmetric tridiagonal FIGI2
eigenvalues, retaining the diagonal similarity transformations
Finds eigenvalues by QR method Real upper Hessenberg HQR
Finds eigenvalues and eigenvectors by QR method Real upper Hessenberg HQR2
Finds eigenvectors given the eigenvectors of the real Complex Hermitian HTRIBK
symmetric tridiagonal matrix calculated by HTRIDI
(including eigenvectors calculated by TQL2 or IMTQL2)
Finds eigenvectors given the eigenvectors of the real Complex Hermitian (packed) HTRIB3
symmetric tridiagonal matrix calculated by HTRID3
(eigenvectors calculated by TQL2 or IMTQL2, among
others)
Reduces to real symmetric tridiagonal form by using unitary Complex Hermitian HTRIDI
Reduces to real symmetric tridiagonal form by using unitary Complex Hermitian (packed) HTRID3
Finds eigenvalues by using implicit QL method, and Real symmetric tridiagonal IMTQLV
associates them with their corresponding submatrix indices
Finds eigenvalues by implicit QL method Real symmetric tridiagonal IMTQL1
Finds eigenvalues and eigenvectors by implicit QL method Real symmetric tridiagonal IMTQL2
Finds eigenvectors that correspond to specified eigenvalues Real upper Hessenberg INVIT
by using inverse iteration
Determines the singular-value decomposition A = USV T , Real rectangular MINFIT
forming U T B rather than U by using Householder
bidiagonalization and a variant of the QR algorithm
004– 2081– 002 25

Forms eigenvectors by back transforming those of the Real general ORTBAK

corresponding matrices determined by ORTHES
Reduces matrix to upper Hessenberg form by using Real general ORTHES
orthogonal similarity transformations
Accumulates transformations used in the reduction to upper Real general ORTRAN
Hessenberg form done by ORTHES
Reduces matrices A and B in the generalized eigenproblem Real general QZHES
(Ax = λBx ) so that A is in upper Hessenberg form and B is
in upper triangular form by using orthogonal transformations
Further reduces matrices A and B as calculated by QZHES Real general QZIT
for the generalized eigenproblem (Ax = λBx ), so that A is in
quasi-upper triangular form and B is still upper triangular
Produces three arrays that can be used to calculate the Real general QZVAL
eigenvalues for the generalized eigenproblem (Ax = λBx ),
with A and B as calculated by QZIT
Finds the eigenvectors that correspond to a list of Real general QZVEC
eigenvalues for the generalized eigenproblem (Ax = λBx ),
with A and B as calculated by QZIT
Finds the smallest or largest eigenvalues by rational QR Real symmetric tridiagonal RATQR
method with Newton corrections
Forms generalized eigenvectors by back transforming those Real general REBAK
of the corresponding matrices determined by REDUC or
REDUC2
Forms eigenvectors by back transforming those of the Real general REBAKB
corresponding matrices determined by REDUC2
Reduces the generalized eigenproblem (Ax = λBx ) to a Real symmetric REDUC
standard symmetric eigenproblem by using the Cholesky
factorization of B
Reduces either of the generalized eigenproblems Real symmetric REDUC2
(ABx = λBx or BAx = λBx ) to a standard symmetric
eigenproblem by using the Cholesky factorization of B
Finds eigenvalues and eigenvectors Real general RG
Finds generalized eigenvalues and eigenvectors Real general RGG
(Ax = λBx )
26 004– 2081– 002

Finds eigenvalues and eigenvectors Real symmetric RS

Finds eigenvalues and eigenvectors Real symmetric banded RSB
Finds generalized eigenvalues and eigenvectors Real symmetric RSG
(Ax = λBx )
Finds generalized eigenvalues and eigenvectors Real symmetric RSGAB
(ABx = λx )
Finds generalized eigenvalues and eigenvectors Real symmetric RSGBA
(BAx = λx )
Finds eigenvalues and eigenvectors Real symmetric RSM
Finds eigenvalues and eigenvectors Real symmetric packed RSP
Finds eigenvalues and eigenvectors Real symmetric tridiagonal RST
Finds eigenvalues and eigenvectors Special real tridiagonal RT
Determines the singular-value decomposition A = USV by T
Real rectangular SVD
using Householder bidiagonalization and a variant of the QR
algorithm
Finds the eigenvectors from a set of ordered eigenvalues by Real symmetric tridiagonal TINVIT
using inverse iteration
Finds the eigenvalues by rational QL method Real symmetric tridiagonal TQLRAT
Finds the eigenvalues and/or eigenvectors by the rational QL Real symmetric tridiagonal TQL1
or QL method
Finds the eigenvalues and/or eigenvectors by the rational QL Real symmetric tridiagonal TQL2
or QL method
Forms eigenvectors by back transforming those of the Real symmetric TRBAK
corresponding matrices determined by TRED1
Forms eigenvectors by back transforming those of the Real symmetric (packed) TRBAK3
corresponding matrices determined by TRED3
Reduces to symmetric tridiagonal matrix by using orthogonal Real symmetric TRED1
Reduces to symmetric tridiagonal matrix by using and Real symmetric TRED2
accumulating orthogonal similarity transformations
Reduces to symmetric tridiagonal matrix by using orthogonal Real symmetric (packed) TRED3
004– 2081– 002 27

Finds the eigenvalues that lie between specified indices by Real symmetric tridiagonal TRIDIB
using bisection
Finds the eigenvalues that lie in a specified interval and each Real symmetric tridiagonal TSTURM
corresponding eigenvector by using bisection and inverse
iteration
SEE ALSO
28 004– 2081– 002

LINPACK ( 3S ) LINPACK ( 3S )
NAME
LINPACK – Single-precision real and complex LINPACK routines
IMPLEMENTATION
UNICOS systems (except Cray T90 systems that support IEEE arithmetic)
DESCRIPTION
LINPACK is a public domain package of Fortran routines that solves systems of linear equations and
computes the QR, Cholesky, and singular value decompositions. The original Fortran programs are
described in the LINPACK User’s Guide by J. J. Dongarra, C. B. Moler, J. R. Bunch, and G. W. Stewart,
published by the Society for Industrial and Applied Mathematics (SIAM), Philadelphia, 1979, Library of
Congress catalog card number 78– 78206.
Most LINPACK routines are superseded by routines from the more recent public domain package, LAPACK,
described in the LAPACK User’s Guide (see INTRO_LAPACK(3S) for a complete reference). Of particular
interest to LINPACK users who want to switch to LAPACK is Appendix D, "Converting from LINPACK
and EISPACK," of the LAPACK User’s Guide. This appendix contains a table that shows the name of the
LAPACK routines that are functionally equivalent to each LINPACK routine.
Each single-precision Scientific Library version of the LINPACK routines has the same name, algorithm, and
calling sequence as the original version. Optimization of each routine includes the following:
• Replacement of calls to the BLAS routines SSCAL, SCOPY, SSWAP, SAXPY, and SROT with inline
Fortran code vectorized by the Cray Research Fortran compilers. (SROTG is still called by LINPACK.)
• Removal of Fortran IF statements in which the result of either branch is the same.
• Replacement of SDOT to solve triangular systems of linear equations in SPOSL, STRSL, and SCHDD
with more vectorizable code.
These optimizations affect only the execution order of floating-point operations in DO loops. See the
LINPACK User’s Guide for further descriptions. The complex routines have been added without much
optimization.
As mentioned previously, LAPACK does not completely supersede LINPACK. In the following table, an
asterick (*) marks LINPACK routines that are not superseded in public domain LAPACK. This table lists
the name, matrix or decomposition, and purpose for each routine.
Name Matrix or Decomposition Purpose
SGECO Real general Factors and estimates condition

SGEFA Factors
SGESL Solves
SGEDI Computes determinant and inverse
004– 2081– 002 29

CGECO Complex general Factors and estimates condition

CGEFA Factors
CGESL Solves
CGEDI Computes determinant and inverse
SGBCO Real general banded Factors and estimates condition
SGBFA Factors
SGBSL Solves
SGBDI Computes determinant
CGBCO Complex general banded Factors and estimates condition
CGBFA Factors
CGBSL Solves
CGBDI Computes determinant
SPOCO Real positive definite Factors and estimates condition
SPOFA Factors
SPOSL Solves
SPODI Computes determinant and inverse
CPOCO Complex positive definite Factors and estimates condition
CPOFA Factors
CPOSL Solves
CPODI Computes determinant and inverse
SPPCO Real positive definite packed Factors and estimates condition
SPPFA Factors
SPPSL Solves
SPPDI Computes determinant and inverse
CPPCO Complex positive definite packed Factors and estimates condition
CPPFA Factors
CPPSL Solves
CPPDI Computes determinant and inverse
SPBCO Real positive definite banded Factors and estimates condition
SPBFA Factors
SPBSL Solves
SPBDI Computes determinant
CPBCO Complex positive definite banded Factors and estimates condition
CPBFA Factors
CPBSL Solves
CPBDI Computes determinant
30 004– 2081– 002

SSICO Real symmetric indefinite Factors and estimates condition

SSIFA Factors
SSISL Solves
SSIDI Computes inertia, determinant, and inverse
CSICO Complex symmetric Factors and estimates condition
CSIFA Factors
CSISL Solves
CSIDI Computes determinant and inverse
CHICO Complex Hermitian indefinite Factors and estimates condition
CHIFA Factors
CHISL Solves
CHIDI Computes inertia, determinant, and inverse
SSPCO Real symmetric indefinite packed Factors and estimates condition
SSPFA Factors
SSPSL Solves
SSPDI Computes inertia, determinant, and inverse
CSPCO Complex symmetric indefinite packed Factors and estimates condition
CSPFA Factors
CSPSL Solves
CSPDI Computes inertia, determinant, and inverse
CHPCO Complex Hermitian indefinite packed Factors and estimates condition
CHPFA Factors
CHPSL Solves
CHPDI Computes inertia, determinant, and inverse
STRCO Real triangular Factors and estimates condition
STRSL Solves
STRDI Computes determinant and inverse
CTRCO Complex triangular Factors and estimates condition
CTRSL Solves
CTRDI Computes determinant and inverse
SGTSL Real tridiagonal Solves
CGTSL Complex tridiagonal Solves
SPTSL Real positive definite Solves tridiagonal
CPTSL Complex positive Solves definite tridiagonal
004– 2081– 002 31

SCHDC * Real Cholesky decomposition Decomposes

SCHDD * Downdates
SCHUD * Updates
SCHEX * Exchanges
CCHDC * Complex Cholesky decomposition Decomposes
CCHDD * Downdates
CCHUD * Updates
CCHEX * Exchanges
SQRDC Real Performs orthogonal factorization
SQRSL Solves
CQRDC Complex Performs orthogonal factorization
CQRSL Solves
SSVDC Real Performs singular value decomposition
CSVDC Complex Performs singular value decomposition
SEE ALSO
INTRO_LAPACK(3S) for information and references about the LAPACK routines that supersede LINPACK
Dongarra, J. J., C. B. Moler, J. R. Bunch, and G. W. Stewart, LINPACK User’s Guide. Society for
Industrial and Applied Mathematics (SIAM), Philadelphia, 1979.
32 004– 2081– 002

INTRO_BLAS1 ( 3S ) INTRO_BLAS1 ( 3S )
NAME
INTRO_BLAS1 – Introduction to vector-vector linear algebra subprograms
IMPLEMENTATION
DESCRIPTION
The linear algebra subprograms are written to run optimally on UNICOS and UNICOS/mk systems. These
subprograms use call-by-address convention when called by a Fortran, C, or CAL program.
Level 1 Basic Linear Algebra Subprograms
The Level 1 BLAS perform basic vector-vector operations. Only the single-precision real and complex data
types are supported from the standard set of Level 1 BLAS. In addition, several half-precision subroutines
are provided as extensions to the BLAS on UNICOS/mk systems, using the following naming conventions:
H half-precision (32-bit) REAL
G half-precision (32-bit) COMPLEX
The following three types of vector-vector operations are available:
• Dot products and various vector norms
• Scaling, copying, swapping, and computing linear combination of vectors
• Generate or apply plane or modified plane rotations
Increment arguments
A vector’s description consists of the name of the array (x or y) followed by the storage spacing (increment)
in the array of vector elements (incx or incy). The increment can be positive or negative. When a vector x
consists of n elements, the corresponding actual array arguments must be of a length at least
1+(n – 1) .  incx  . For a negative increment, the first element of x is assumed to be x (1+(n – 1) .  incx  ).
The standard specification of _SCAL, _NRM2, _ASUM, and I_AMAX does not define their behavior for
negative increments, so this functionality is an extension to the standard BLAS.
Setting an increment argument to 0 can cause unpredictable results.
Fortran type declaration for functions
Always declare the data type of external functions. Declaring the data type of the complex Level 1 BLAS
functions is particularily important because, based on the first letter of their names and the Fortran data
typing rules, the default implied data type would be REAL.
Fortran type declarations for function names follow:
Type Function Name
REAL SASUM, SCASUM, SCNRM2, SDOT, SNRM2, SPDOT, SSUM
COMPLEX CDOTC, CDOTU, CSUM
004– 2081– 002 33

When using half-precision routines, the following types can only be declared in Fortran 90:
Type Function Name
REAL(KIND=4) HDOT
COMPLEX(KIND=4) GTOC,GDOTU
Level 1 BLAS search functions
Several search functions are properly a part of Level 1 BLAS, but they are not described in this section of
the manual. See the INTRO_SORTSEARCH(3F) man page for details. These functions are as follows
(functions marked with an asterisk [*] are extensions to the standard set of Level 1 BLAS routines):
ISA MAX , ICA MAX, ISA MIN *, ISMAX* , ISM IN*
These man pages are documented in the Application Programmer’s Library Reference Manual.
Table of Level 1 BLAS routines
The following table contains the purpose, operation, and name of each Level 1 BLAS routine (except search
functions). The first routine name listed in each table block is the name of the manual page that contains
documentation for any routines listed in that block. The routines marked with an asterisk (*) are extensions
to the standard set of Level 1 BLAS routines. For complete details about each operation, see the individual
man pages.
Purpose Operation Name
Adds a scalar multiple of a real or complex vector to y← α E x + y HAXPY

another real or complex vector (32-bit version) GAXPY
n
Σ xi yi
Computes a dot product (inner product) of two real or hdot ← x T y = HDOT
complex vectors (32-bit version) i =1
n
Σ xi yi
gdotc ← x H y = GDOTC
i =1
n
Σ xi yi
gdotu ← x T y = GDOTU
i =1
n
Σ
Sums the absolute values of the elements of a real sasum ← ||x ||1 =  xi  SASUM
vector (also called the l 1 norm) i =1
Sums the absolute values of the real and imaginary parts scasum ← ||Real (x )||1 + ||Imag (x )||1 SCASUM
n n
Σ  Real (xi )  + iΣ=1  Imag (xi ) 
of the elements of a complex vector =
i =1
Adds a scalar multiple of a real or complex vector to a y ← αx + βy SAXPBY,

scalar multiple of another vector CAXPBY*
Adds a scalar multiple of a real or complex vector to y ← αx + y SAXPY,
another vector CAXPY
34 004– 2081– 002

Copies a real or complex vector into another vector y ←x SCOPY,

CCOPY
n
Σ xi yi
Computes a dot product of two real or complex vectors sdot ← x T y = SDOT
i =1
n
Σ xi yi
cdotc ← x H y = CDOTC
i =1
n
Σ xi yi
cdotu ← x T y = CDOTU
i =1
Computes the Hadamard product of two vectors z (i ) := α x (i ) y (i ) + β z (i ) SHAD
√Σ x
Computes the Euclidean norm (also called l 2 norm) of a n SNRM2
snrm2 ← ||x ||2 = i
2
real or complex vector i =1
√
n SCNRM2
scnrm2 ← ||x || = Σ x x 2 i i
i =1
Adds a scalar multiple of a vector to a sparse vector yJ ← αxi + yJ

i i
SPAXPY*
n
Σ xi yJ
Computes a dot product of a real vector and a sparse spdot ← SPDOT*
real vector i =1
i
Applies a real plane rotation to a pair of complex CSROT

vectors
Applies an orthogonal plane rotation SROT
Applies a complex Givens plane rotation CROT
Constructs a Givens plane rotation SROTG,
CROTG
Applies a modified Givens plane rotation SROTM
Constructs a modified Givens plane rotation SROTMG
Scales a real or complex vector x ← αx SSCAL,
CSSCAL,
CSCAL
n
Σ xi
Sums the elements of a real or complex vector sum ← SSUM*,
i =1 CSUM*
Swaps two real or two complex vectors x ←
→y SSWAP,
CSWAP
004– 2081– 002 35

SEE ALSO
Lawson, C., Hanson, R., Kincaid, D., and Krogh, F., "Basic Linear Algebra Subprograms for Fortran Usage,"
ACM Transactions on Mathematical Software, 5 (1979), pp. 308 – 325.
36 004– 2081– 002

CSROT ( 3S ) CSROT ( 3S )
NAME
CSROT – Applies a real plane rotation to a pair of complex vectors
SYNOPSIS
CALL CSROT ( n, x, incx, y, incy, c, s)
IMPLEMENTATION
UNICOS and UNICOS/mk systems
On UNICOS/mk systems, this subroutine executes on a single processor and uses private data.
DESCRIPTION
CSROT applies a real plane rotation to a pair of complex vectors. The form of the operation is the
following:
 xi   c s   xi 
 :=   
 yi   −s c   yi 
for each pair of values (x(i), y(i)) i=1,. . ., n

This routine has the following arguments:
n Integer. (input)
Number of pairs of elements of x and y to be rotated.
x Complex array of dimension (n– 1) .  incx  + 1. (input and output)
On input, array x. If incx > 0, x(i) is stored in x(1+(i– 1) . incx); if incx < 0, x(i) is stored in
x(1– (n– i) . incx). On output, the rotated vector x.
incx Integer. (input)
Increment between elements of x. incx should not be 0.
y Complex array of dimension 1+(n– 1) .  incy  ) (input and output)
On input, array y. If incy > 0, y(i) is stored in y(1+(i– 1) . incy); if incy < 0, y(i) is stored in
y(1– (n– i) . incy). On output, the rotated vector y.
incy Integer. (input)
Increment between elements of y. incy should not be 0.
c Real. (input)
Cosine of the angle of rotation.
s Real. (input)
Sine of the angle of rotation.
SEE ALSO
CROTG(3S), SROT(3S), SROTG(3S), SROTM(3S)
004– 2081– 002 37

HAXPY ( 3S ) HAXPY ( 3S )
NAME
HAXPY, GAXPY – Adds a scalar multiple of a real or complex vector to another real or complex vector
SYNOPSIS
CALL HAXPY (n, alpha, x, incx, y, incy)
CALL GAXPY (n, alpha, x, incx, y, incy)
IMPLEMENTATION
UNICOS/mk systems
These subroutines execute on a single processor and use private data.
DESCRIPTION
HAXPY adds a scalar multiple of a real vector to another real vector.
GAXPY adds a scalar multiple of a complex vector to another complex vector.
HAXPY and GAXPY perform the following vector operation:
y←αx+y
where α is a real or complex scalar, and x and y are real or complex vectors.
These routines have the following arguments:
n INTEGER(KIND=8). (input)
Number of elements in the vectors. If n ≤ 0, HAXPY and GAXPY return without any
computation.
alpha HAXPY: REAL(KIND=4). (input)
GAXPY: COMPLEX(KIND=4). (input)
Scalar multiplier α. If real α = 0. or complex α = 0 = 0. + 0.i, HAXPY and GAXPY return
without any computation.
x HAXPY: REAL(KIND=4) array of dimension (n– 1) .  incx  + 1. (input)
GAXPY: COMPLEX(KIND=4) array of dimension (n– 1) .  incx  + 1. (input)
Contains the vector to be scaled before summation.
incx INTEGER(KIND=8). (input)
y HAXPY: REAL(KIND=4) array of dimension (n– 1) .  incy  + 1. (input and output)
GAXPY: COMPLEX(KIND=4) array of dimension (n– 1) .  incy  + 1. (input and output)
Before calling the routine, y contains the vector to be summed. After the routine ends, y
contains the result of the summation.
incy INTEGER(KIND=8). (input)
38 004– 2081– 002

HAXPY ( 3S ) HAXPY ( 3S )
NOTES
HAXPY and GAXPY are based on SAXPY and CAXPY from the Level 1 Basic Linear Algebra Subprograms
(Level 1 BLAS).
When working backward (incx < 0 or incy < 0), each routine starts at the end of the vector and moves
backward, as follows:
x(1– incx . (n– 1)), x(1– incx . (n– 2)), . . ., x(1)
y(1– incy . (n– 1)), y(1– incy . (n– 2)), . . ., y(1)
RETURN VALUES
When n ≤ 0, real α = 0., or complex α = 0 = 0.+0.i, these routines return immediately with no change in
their arguments.
004– 2081– 002 39

HDOT ( 3S ) HDOT ( 3S )
NAME
HDOT, GDOTC, GDOTU – Computes a dot product (inner product) of two real or complex vectors
SYNOPSIS
dot = HDOT (n, x, incx, y, incy)
dot = GDOTC (n, x, incx, y, incy)
dot = GDOTU (n, x, incx, y, incy)
IMPLEMENTATION
UNICOS/mk systems
This subroutine executes on a single processor and uses private data.
DESCRIPTION
HDOT computes a dot product of two real vectors (l 2 real inner product).
GDOTC computes a dot product of the conjugate of a complex vector and another complex vector (l 2 real
inner product).
GDOTU computes a dot product of two complex vectors.
HDOT and GDOTU perform the following vector operation:
n
dot ← x T y = Σ xi yi
i =1
T
where x and y are real or complex vectors and x is the transpose of x.
GDOTC performs the following vector operation:
n
dot ← x H y = Σ xi yi
i =1
H
where x and y are complex vectors, and x is the conjugate transpose of x.
These functions have the following arguments:
dot HDOT: REAL(KIND=4). (output)
GDOTC, GDOTU: COMPLEX(KIND=4). (output)
Result (dot product). If n ≤ 0, dot is set to 0.
Number of elements in each vector.
x HDOT: REAL(KIND=4) array of dimension (n– 1) .  incx  + 1. (input)
GDOTC, GDOTU: COMPLEX(KIND=4) array of dimension (n– 1) .  incx  + 1. (input)
Array x contains the first vector operand.
40 004– 2081– 002

HDOT ( 3S ) HDOT ( 3S )
incx INTEGER(KIND=8). (input)

y HDOT: REAL(KIND=4) array of dimension (n– 1) .  incy  + 1. (input)
GDOTC, GDOTU: COMPLEX(KIND=4) array of dimension (n– 1) .  incy + 1. (input)
Array y contains the second vector operand.
incy INTEGER(KIND=8). (input)
NOTES
HDOT, GDOTC, and GDOTU are based on SDOT, CDOTC, and CDOTU from the Level 1 Basic Linear Algebra
Subprograms (Level 1 BLAS).
x(1– incx . (n– 1)), x(1– incx . (n– 2)), . . ., x(1)
y(1– incy . (n– 1)), y(1– incy . (n– 2)), . . ., y(1)
004– 2081– 002 41

SASUM ( 3S ) SASUM ( 3S )
NAME
SASUM, SCASUM – Sums the absolute value of elements in a real or complex vector
SYNOPSIS
sum = SASUM (n, x, incx)
sum = SCASUM (n, x, incx)
IMPLEMENTATION
On UNICOS/mk systems, these subroutines execute on a single processor and use private data.
DESCRIPTION
SASUM sums the absolute values of the elements of a real vector, as follows:
n
sum ← ||x ||1 = Σ
i =1
 xi 
where x is a real vector of length n.

SCASUM sums the absolute values of the real and imaginary parts of the elements of a complex vector, as
follows:
n n
sum← ||Real (x )||1 + ||Imag (x )||1= Σ  Real (xi )  + jΣ=1  Imag (x j ) 
i =1
where x is a complex vector of length n.

These real functions have the following arguments:
sum Real. (output)
SASUM: Sum of the absolute values of the elements of x.
SCASUM: Sum of the absolute values of the real and imaginary parts of the elements of x.
n Integer. (input)
Number of elements in the vector to be summed. If n ≤ 0, SASUM and SCASUM return 0.
x SASUM: Real array of dimension (n– 1) .  incx  + 1. (input)
SCASUM: Complex array of dimension (n– 1) .  incx  + 1. (input)
Array x contains the vector to be summed.
Increment between elements of x. If incx = 0, the results will be unpredictable.
42 004– 2081– 002

SASUM ( 3S ) SASUM ( 3S )
NOTES
SASUM and SCASUM are Level 1 Basic Linear Algebra Subprograms (Level 1 BLAS).
When working backward (incx < 0), each routine starts at the end of the vector and moves backward, as
follows:
x(1– incx . (n– 1)), x(1– incx . (n– 2)), . . ., x(1)
004– 2081– 002 43

SAXPBY ( 3S ) SAXPBY ( 3S )
NAME
SAXPBY, CAXPBY – Adds a scalar multiple of a real or complex vector x to a scalar multiple of another
real or complex vector y
SYNOPSIS
CALL SAXPBY (n, alpha, x, incx, beta, y, incy)
CALL CAXPBY (n, alpha, x, incx, beta, y, incy)
IMPLEMENTATION
UNICOS/mk systems
These subroutines execute on a single processor and use private data only.
DESCRIPTION
SAXPBY adds a scalar multiple of a real vector x to a scalar multiple of a real vector y.
CAXPBY adds a scalar multiple of a complex vector x to a scalar multiple of a complex vector y.
y←αx+βy
where x and y are n-vectors and α and β are scalars.
The following special cases are recognized:
α = 0: equivalent to SSCAL or CSCAL
α = 1, β = 0: equivalent to SCOPY or CCOPY
α ≠1, β = 0: like SCOPY or CCOPY, with scaling
α ≠0, β = 1: equivalent to SAXPY or CAXPY
n Integer. (input)
Number of elements of the vectors x and y.
alpha SAXPBY: Real. (input)
CAXPBY: Complex. (input)
The scalar α.
x SAXPBY: Real array of dimension (1+(n– 1) .  incx ). (input)
CAXPBY: Complex array of dimension (1+(n– 1) .  incx  ). (input)
The vector x. If incx > 0, the i-th element of the vector x is located in x(1+(i-1) .  incx  ). If
incx < 0, the i-th element of the vector x is located in x(1+(n-i) .  incx  ).
Increment between elements of the vector x. If incx < 0, x is processed in reverse order.
beta SAXPBY: Real. (input)
CAXPBY: Complex. (input)
The scalar β.
44 004– 2081– 002

SAXPBY ( 3S ) SAXPBY ( 3S )
y SAXPBY: Real array of dimension (1+(n– 1) .  incy  ). (input/output)

CAXPBY: Complex array of dimension (1+(n– 1) .  incy  ). (input/output)
On entry, the vector y. If incy > 0, the i-th element of the vector y is located in y(1+(i-1) .
 incy  ). If incy < 0, the i-th element of the vector y is located in y(1+(n-i) .  incy ).
On exit, y is overwritten with the vector sum αx+βy.
Increment between elements of y. If incy < 0, y is processed in reverse order.
004– 2081– 002 45

SAXPY ( 3S ) SAXPY ( 3S )
NAME
SAXPY, CAXPY – Adds a scalar multiple of a real or complex vector to another real or complex vector
SYNOPSIS
CALL SAXPY (n, alpha, x, incx, y, incy)
CALL CAXPY (n, alpha, x, incx, y, incy)
IMPLEMENTATION
On UNICOS/mk systems, this subroutine executes on a single processor and uses only private data.
DESCRIPTION
SAXPY adds a scalar multiple of a real vector to another real vector.
CAXPY adds a scalar multiple of a complex vector to another complex vector.
SAXPY and CAXPY perform the following vector operation:
y ← αx +y
where α is a real or complex scalar, and x and y are real or complex vectors.
n Integer. (input)
Number of elements in the vectors. If n ≤ 0, SAXPY and CAXPY return without any
computation.
alpha SAXPY: Real. (input)
CAXPY: Complex. (input)
Scalar multiplier α. If real α = 0 or complex α = 0 = 0. + 0.i, SAXPY and CAXPY return
without any computation.
x SAXPY: Real array of dimension (n– 1) .  incx  + 1. (input)
CAXPY: Complex array of dimension (n– 1) .  incx  + 1. (input)
Contains the vector to be scaled before summation.
46 004– 2081– 002

SAXPY ( 3S ) SAXPY ( 3S )
y SAXPY: Real array of dimension (n– 1) .  incy  + 1. (input and output)

CAXPY: Complex array of dimension (n– 1) .  incy  + 1. (input and output)
Before calling the routine, y contains the vector to be summed. After the routine ends, y
contains the result of the summation.
Increment between elements of y. If incy = 0, the results will be unpredictable.
NOTES
SAXPY and CAXPY are Level 1 Basic Linear Algebra Subprograms (Level 1 BLAS).
x(1– incx . (n– 1)), x(1– incx . (n– 2)), . . ., x(1)
y(1– incy . (n– 1)), y(1– incy . (n– 2)), . . ., y(1)
RETURN VALUES
When n ≤ 0, real α = 0., or complex α = 0 = 0.+0.i, these routines return immediately with no change in
their arguments.
004– 2081– 002 47

SCOPY ( 3S ) SCOPY ( 3S )
NAME
SCOPY, CCOPY – Copies a real or complex vector into another real or complex vector
SYNOPSIS
CALL SCOPY (n, x, incx, y, incy)
CALL CCOPY (n, x, incx, y, incy)
IMPLEMENTATION
DESCRIPTION
SCOPY copies a real vector into another real vector.
CCOPY copies a complex vector into another complex vector.
SCOPY and CCOPY perform the following vector operation:
y←x
where x and y are real or complex vectors.
n Integer. (input)
Number of elements to be copied. If n ≤ 0, SCOPY and CCOPY return without any computation.
x SCOPY: Real array of dimension (n– 1) .  incx  + 1. (input)
CCOPY: Complex array of dimension (n– 1) .  incx  + 1. (input)
Vector from which to copy.
y SCOPY: Real array of dimension (n– 1) .  incy  + 1. (output)
CCOPY: Complex array of dimension (n– 1) .  incy + 1. (output)
Result vector.
NOTES
SCOPY and CCOPY are Level 1 Basic Linear Algebra Subprograms (Level 1 BLAS).
48 004– 2081– 002

SCOPY ( 3S ) SCOPY ( 3S )
x(1– incx . (n– 1)), x(1– incx . (n– 2)), . . ., x(1)
y(1– incy . (n– 1)), y(1– incy . (n– 2)), . . ., y(1)
004– 2081– 002 49

SDOT ( 3S ) SDOT ( 3S )
NAME
SDOT, CDOTC, CDOTU – Computes a dot product (inner product) of two real or complex vectors
SYNOPSIS
dot = SDOT (n, x, incx, y, incy)
dot = CDOTC (n, x, incx, y, incy)
dot = CDOTU (n, x, incx, y, incy)
IMPLEMENTATION
DESCRIPTION
SDOT computes a dot product of two real vectors l 2 real inner product).
CDOTC computes a dot product of the conjugate of a complex vector and another complex vector l 2 complex
inner product).
CDOTU computes a dot product of two complex vectors.
SDOT and CDOTU perform the following vector operation:
n
dot ← x y = Σ x i y
T
i
i =1
T
where x and y are real or complex vectors, and x is the transpose of x.
CDOTC performs the following vector operation:
n
Σ xi
H
dot ← x y = yi
i =1
H
where x and y are complex vectors, and x is the conjugate transpose of x.
dot SDOT: Real. (output)
CDOTC, CDOTU: Complex. (output)
Result (dot product). If n ≤ 0, dot is set to 0.
n Integer. (input)
Number of elements in each vector.
x SDOT: Real array of dimension (n– 1) .  incx  + 1. (input)
CDOTC, CDOTU: Complex array of dimension (n– 1) .  incx  + 1. (input)
Array x contains the first vector operand.
50 004– 2081– 002

SDOT ( 3S ) SDOT ( 3S )

y SDOT: Real array of dimension (n– 1) .  incy  + 1. (input)
CDOTC, CDOTU: Complex array of dimension (n– 1) .  incy  + 1.
Array y contains the second vector operand.
NOTES
SDOT, CDOTC, and CDOTU are Level 1 Basic Linear Algebra Subprograms (Level 1 BLAS).
x(1– incx . (n– 1)), x(1– incx . (n– 2)), . . ., x(1)
y(1– incy . (n– 1)), y(1– incy . (n– 2)), . . ., y(1)
004– 2081– 002 51

SHAD ( 3S ) SHAD ( 3S )
NAME
SHAD – Computes the Hadamard product of two vectors
SYNOPSIS
CALL SHAD (n, alpha, x, incx, y, incy, beta, z, incz)
IMPLEMENTATION
UNICOS/mk systems
DESCRIPTION
SHAD computes the Hadamard product of two vectors X and Y, storing the results in a vector Z.
z (i ) := α x (i ) y (i ) + β z (i ), i = 1, . . ., n
α = 0 is recognized as a special case. β = 0 or β = 1 is also recognized as a special case.
The SHAD routine accepts the following arguments:
n Integer. (input)
The number of elements in each vector.
alpha Real. (input)
The scalar α.
x Real array, dimension (1+(n– 1) . incx). (input)
The vector x.
If incx > 0, the ith element of the vector x is located in x(1+(i– 1) . incx).
If incx < 0, the ith element of the vector x is located in x(1+(n– i) .  incx  ).
The increment between elements of the vector x.
incx must not = 0.
y Real array, dimension (1+(n– 1) . incy). (input)
The vector y.
If incy > 0, the ith element of the vector y is located in y(1+(i– 1) . incy).
If incy < 0, the ith element of the vector y is located in y(1+(n– i) .  incy  ).
The increment between elements of the vector y. incy must not = 0.
beta Real. (input)
The scalar beta.
52 004– 2081– 002

SHAD ( 3S ) SHAD ( 3S )
z Real array, dimension (1+(n– 1) . incz). (input/output)

On entry, the vector Z.
If incz > 0, the ith element of the vector z is located in z(1+(i– 1) . incz).
If incz < 0, the ith element of the vector z is located in z(1+(n– i) .  incz ). On exit, z is
overwritten with the Hadamard product α . x . y + β . z .
incz Integer. (input)
The increment between elements of the vector z. incz must not = 0.
004– 2081– 002 53

SNRM2 ( 3S ) SNRM2 ( 3S )
NAME
SNRM2, SCNRM2 – Computes the Euclidean norm of a vector
SYNOPSIS
enrm = SNRM2 (n, x, incx)
enrm = SCNRM2 (n, xi, incx)
IMPLEMENTATION
DESCRIPTION
SNRM2 computes the Euclidean (l 2 ) norm of a real vector, as follows:
√
n
enrm ← ||x ||2 = √x T x = Σ
i =1
xi 2
where x is a real vector, and x T denotes the transpose of x.

SCNRM2 computes the Euclidean (l 2 ) norm of a complex vector, as follows:
√
n
enrm ← ||x ||2 =√x H x = Σ xi xi
i =1
H
where x is a complex vector, and x denotes the conjugate transpose of x.
enrm Real. (output)
Result (Euclidean norm). If n ≤ 0, enrm is set to 0.
n Integer. (input)
Number of elements in the operand vector.
x SNRM2: Real array of dimension (n– 1) .  incx  + 1. (input)
SCNRM2: Complex array of dimension (n– 1) .  incx  + 1. (input)
Array x contains the operand vector.
NOTES
SNRM2 and SCNRM2 are Level 1 Basic Linear Algebra Subprograms (Level 1 BLAS).
54 004– 2081– 002

SNRM2 ( 3S ) SNRM2 ( 3S )
The version of these routines on UNICOS systems does not behave the same way that the public domain
FORTRAN version behaves. For performance reasons, they do not scale the input values; input for the
routines must be within a certain range of numbers.
follows:
x(1– incx . (n– 1)), x(1– incx . (n– 2)), . . ., x(1)
004– 2081– 002 55

SPAXPY ( 3S ) SPAXPY ( 3S )
NAME
SPAXPY – Adds a scalar multiple of a real vector to a sparse real vector
SYNOPSIS
CALL SPAXPY (n, alpha, x, y, index)
IMPLEMENTATION
UNICOS systems
DESCRIPTION
SPAXPY adds a scalar multiple of a real vector to a sparse real vector. It performs the following vector
operation where α is a real scalar, x is a real vector, and y is a sparse real vector:
y←αx+y
n Integer. (input)
Number of vector elements to be used in the computation. If n ≤ 0, SPAXPY returns without
any computation.
alpha Real. (input)
Scalar multiplier α. If α = 0.0, SPAXPY returns without any computation.
x Real array of dimension n. (input)
Contains the dense vector operand to be scaled before adding.
y Real array of dimension MAX{index(1),. . .,index(n)}. (input and output)
On input, y contains the sparse vector used in the addition. On output, y receives the resulting
vector.
index Integer array of dimension n. (input)
Contains the vector of indices for elements of y. All elements in index should be unique.
SPAXPY executes an operation equivalent to the following Fortran code:
DO 10 I=1,N
Y(I NDEX(I ))= ALP HA* X(I )+Y (IN DEX (I) )
10 CONTIN UE
NOTES
SPAXPY is an extension to the standard Level 1 Basic Linear Algebra Subprograms (Level 1 BLAS).
56 004– 2081– 002

SPDOT ( 3S ) SPDOT ( 3S )
NAME
SPDOT – Computes the dot product of a real vector and a real sparse vector
SYNOPSIS
dot = SPDOT (n, y, index, x)
IMPLEMENTATION
UNICOS systems
DESCRIPTION
SPDOT computes the dot product of a real vector and a sparse real vector (l 2 real inner product). It
T
performs the following vector operation where y is a real vector, y is the transpose of y, and x is a real
sparse vector:
n
dot ← y T x = Σ yi xi
i =1
This function has the following arguments:

dot Real. (output)
Result (dot product). If n ≤ 0, dot is set to 0 on output.
n Integer. (input)
Number of vector elements to be used in the computation.
y Real array of dimension MAX{index(1),. . .,index(n)}. (input)
Contains the sparse real vector operand.
index Integer array of dimension n. (input)
Contains the real vector of indices for the elements of y. All values in index should be unique.
Contains the real dense vector operand.
SPDOT executes an operation equivalent to the following Fortran code:
DOT=0. 0
DO 10 I=1 ,N
DOT=DO T+Y (IN DEX (I) )*X (I)
10 CON TINUE
NOTES
SPDOT is an extension to the standard Level 1 Basic Linear Algebra Subprograms (Level 1 BLAS).
004– 2081– 002 57

SROT ( 3S ) SROT ( 3S )
NAME
SROT, CROT – Applies a real plane rotation or complex coordinate rotation
SYNOPSIS
CALL SROT (n, x, incx, y, incy, c, s)
CALL CROT (n, x, incx, y, incy, c, s)
IMPLEMENTATION
DESCRIPTION
SROT applies a plane rotation matrix to a real sequence of ordered pairs:
(x i , y i ), for all i = 1, 2, . . ., n.
CROT applies a rotation matrix to a complex sequence of ordered pairs:
(x i , y i ), for all i = 1, 2, . . ., n.
n Integer. (input)
Number of ordered pairs (planar points in SROT) to be rotated. If n ≤ 0, SROT or CROT returns
without computation.
x SROT: Real array of dimension (n– 1) .  incx  + 1. (input and output)
On input, array x contains the x-coordinate of each planar point to be rotated. On output, array x
contains the x-coordinate of each rotated planar point.
CROT: Complex array of dimension (n– 1) .  incx  + 1. (input and output)
On input, array x contains the first element of each ordered pair to be rotated. On output, array
x contains the first element of each rotated ordered pair.
y SROT: Real array of dimension (n– 1) .  incy  + 1. (input and output)
On input, array y contains the y-coordinate of each planar point to be rotated. On output, array y
contains the y-coordinate of each rotated planar point.
CROT: Complex array of dimension (n– 1) .  incy  + 1. (input and output)
On input, array y contains the second element of each ordered pair to be rotated. On output,
array y contains the second element of each rotated ordered pair.
58 004– 2081– 002

SROT ( 3S ) SROT ( 3S )
c Real. (input)
Cosine of the angle of rotation, usually calculated using SROTG(3S) or CROTG(3S).
s SROT: Real. (input)
Sine of the angle of rotation, usually calculated using SROTG.
CROT: Complex. (input)
Complex sine of the angle of rotation, usually calculated using CROTG.
NOTES
SROT and CROT are Level 1 Basic Linear Algebra Subprograms (Level 1 BLAS). SROT applies the
following plane rotation to each pair of elements (x i , y i ):
 xi   c s   xi 
  ←     for i =1, 2,. . ., n
 yi   −s c   yi 
2 2
If coefficients c and s satisfy c + s = 1.0, the rotation matrix is orthogonal, and the transformation is called
a Givens plane rotation. If c = 1 and s = 0, SROT returns without modifying any input parameters.
CROT applies the following rotation to each pair of complex elements (x i , y i ):
 xi   c s   xi 
  ←     for i =1, 2,. . ., n
 yi   −s c   yi 
where s is the complex conjugate of s.
For CROT, if the coefficient c is real, and the coefficients c and s satisfy c 2 + ss = 1.0, the rotation matrix is
unitary, and the transformation is called a Givens complex rotation.
To calculate the Givens coefficients c and s from a two-element vector to determine the angle of rotation,
use SROTG(3S) or CROTG(3S).
x(1– incx . (n– 1)), x(1– incx . (n– 2)), . . ., x(1)
y(1– incy . (n– 1)), y(1– incy . (n– 2)), . . ., y(1)
SEE ALSO
CROTG(3S), SROTG(3S), SROTM(3S)
004– 2081– 002 59

SROTG ( 3S ) SROTG ( 3S )
NAME
SROTG, CROTG – Constructs a Givens plane rotation
SYNOPSIS
CALL SROTG (a, b, c, s)
CALL CROTG (a, b, c, s)
IMPLEMENTATION
DESCRIPTION
SROTG computes the elements of a rotation matrix such that:
 c s   a   r 
 .   =  
 −s c   b   0 
where r = ± √a 2+b 2 and c 2+s 2 = 1

CROTG computes the elements of a rotation matrix such that:
 c s   a   r 
  .   = 
 −s c   b   0 
where r =
a √aa +bb
√aa
and the notation z represents the complex conjugate of z.
a SROTG: Real.
CROTG: Complex.
(input and output)
SROTG: On input, the first component of the vector to be rotated. On output, a is overwritten by r,
the first component of the vector in the rotated coordinate system, where:
r =sign ( √(a 2+b 2 ), a ), if  a  >  b 
r =sign ( √(a 2+b 2 ), b ), if  a  ≤  b 
CROTG: On output, a is overwritten by the unique complex number r, whose size in the complex
plane is the Euclidean norm of the complex vector (a,b), and whose direction in the complex
plane is the same as that of the original complex element a.
60 004– 2081– 002

SROTG ( 3S ) SROTG ( 3S )
b SROTG: Real.
CROTG: Complex.
(input and output)
On input, the second component of the vector to be rotated. On output, b contains z, where:
z=s if  a >  b
z=1/c if  a ≤  b and c ≠0
z=1 if c = 0.
c Real. (output).
Cosine, c, of the angle of rotation.
s SROTG: Real.
CROTG: Complex.
(output)
Sine, s, of the angle of rotation.
NOTES
SROTG and CROTG are Level 1 Basic Linear Algebra Subprograms (Level 1 BLAS).
The value of z, returned in b by SROTG, gives a compact representation of the rotation matrix, which can be
used later to reconstruct c and s as in the following example:
IF (B .EQ. 1. ) THEN
C = 0.
S = 1.
ELS EIF ( ABS ( B) .LT. 1) THEN
C = SQRT( 1. - B * B)
S = B
ELS E
C = 1. / B
S = SQRT( 1 - C * C)
END IF
SEE ALSO
SROT(3S)
004– 2081– 002 61

SROTM ( 3S ) SROTM ( 3S )
NAME
SROTM – Applies a modified Givens plane rotation
SYNOPSIS
CALL SROTM (n, x, incx, y, incy, rparam)
IMPLEMENTATION
DESCRIPTION
SROTM applies the modified Givens plane rotation constructed by SROTMG(3S).
n Integer. (input)
Number of planar points to be rotated. If n ≤ 0, SROTM returns without any computation.
x Real array of dimension (n– 1) .  incx + 1. (input and output)
On input, array x contains the x-coordinate of each planar point to be rotated. On output, array x
contains the x-coordinate of each rotated planar point.
y Real array of dimension (n– 1) .  incy + 1. (input and output)
On input, array y contains the y-coordinate of each planar point to be rotated. On output, array y
contains the y-coordinate of each rotated planar point.
Increment between elements of y. If incx = 0, the results will be unpredictable.
rparam Real array of dimension 5. (input)
Contains rotation matrix information.
SROTM computes a planar rotation, with possible scaling or reflection, as follows:
 xi   h 1,1 h 1,2   xi 
 ←     : for i =1, 2,. . ., n
 yi   h 2,1 h 2,2   yi 
where the matrix that contains the elements h 1,1, h 2,1, h 1,2, and h 2,2 is called a rotation matrix.
The rparam array determines the contents of the rotation matrix, as follows:
The key parameter, rparam(1), may have one of four values:
1.0, 0.0, – 1.0, or – 2.0
62 004– 2081– 002

SROTM ( 3S ) SROTM ( 3S )
If rparam(1) = 1.0:
 h 11 h 1,2   rparam (2) 1.0 
 =  
 h 2,1 h 2,2   −1.0 rparam (5) 
and rparam(3) and rparam(4) are ignored.
If rparam(1) = 0.0:
 h 1,1 h 1,2   1.0 rparam (4) 
 =  
 h 2,1 h 2,2   rparam (3) 1.0 
and rparam(2) and rparam(5) are ignored.

If rparam(1)=– 1.0 (rescaling case):
 h 1,1 h 1,2   rparam (2) rparam (4) 
 =  
 h 2,1 h 2,2   rparam (3) rparam (5) 
This is a full matrix multiplication.
If rparam(1) = – 2.0:
 h 1,1 h 1,2   1.0 0.0 
 =  =I
 h 2,1 h 2,2   0.0 1.0 
where I is the identity matrix. In this case, rparam(2), rparam(3), rparam(4), and rparam(5) are ignored.
If n ≤0, or if the rotation matrix is the identity matrix (for example, when rparam(1)=– 2.0), SROTM returns
with no operation on input arrays x and y.
If any value of rparam(1) that is not valid is read (any value other than 1.0, 0.0, – 1.0, or – 2.0), SROTM
aborts the job and the following message appears on stderr (diagnostic output):
SROTM CAL LED WITH INC ORR ECT PAR AME TER KEY
SEE ALSO
SROTMG(3S) for further details about the modified Givens transformation and array rparam
004– 2081– 002 63

SROTMG ( 3S ) SROTMG ( 3S )
NAME
SROTMG – Constructs a modified Givens plane rotation
SYNOPSIS
CALL SROTMG (d 1 , d 2 , b 1 , b 2 , rparam)
IMPLEMENTATION
DESCRIPTION
SROTMG computes the elements of a modified Givens plane rotation matrix.
d1 Real. (input and output)
On input, this value is the first diagonal element of the scaling matrix D. On the first call to
SROTMG, this value is typically 1.0. Subsequent calls typically use the value from the previous
call. On output, this value is the first diagonal element of the updated scaling matrix D’.
d2 Real. (input and output)
On input, this is the first diagonal element of the scaling matrix D. On the first call to SROTMG,
this value is typically 1.0. Subsequent calls typically use the value from the previous call. On
output, this value is the first diagonal element of the updated scaling matrix D’.
b1 Real. (input and output)
On input, this value is the x-coordinate of the vector used to define the angle of rotation, before
scaling (multiplying by the matrix D). On output, this value is the x-coordinate of the rotated
vector, before scaling (multiplying by the matrix D’).
b2 Real. (input)
On input, this value is the y-coordinate of the vector used to define the angle of rotation, before
scaling (multiplying by the matrix D). It is unchanged on output.
rparam Real array of dimension 5. (output)
This array contains rotation matrix information. SROTMG sets up the computed elements in
rparam from inputs d 1 , d 2 , b 1 , and b 2 .
Standard Givens Rotation
A standard Givens rotation (see SROTG(3S)) is based on an orthogonal matrix G that rotates points on a
Cartesian xy-coordinate plane. To calculate the rotation matrix, you must provide the angle of rotation
desired, or, equivalently, a vector (point) that lies along the angle of rotation. For a given planar point (x r ,
y r ), G is formed so that:
64 004– 2081– 002

 x ′   c s   xr   xr 
 =    = G  
 0   −s c   yr   yr 
where x ′ = √xr 2 + yr 2.
With this rotation matrix G, you can then convert any number of existing planar points to the new (rotated)
xy-coordinate system. For n points, the rotations would be as follows:
 xi   c s   xi 
  ←     for i =1, 2,. . ., n
 yi   −s c   yi 
Modified Givens Rotation
The algorithm for SROTMG is based on the following observation. The rotation matrix G can be factored
into a scaling matrix (diagonal matrix) and modified rotation matrix H, for which either the diagonal or the
off-diagonal elements are units (that is, ±1). Thus, to perform m modified (scaled) rotations on n planar
points, requires only 2nm, rather than 4nm multiplications for the standard rotation.
Because you may want to perform several successive rotations, this routine assumes that you have leftover
scaling factors from your previous modified Givens rotation; that is, the routine requires you to input not
only a planar rotation vector (b 1 , b 2 ) but also the squares of the diagonal elements of the scaling matrix, d 1
and d 2 . The actual rotation vector is specified as follows:
 xr   √d 1 
0   b1  1  b 
 = 
1
   = 2  
 r  
0 √d 2  2 
D
y

b  b 2 

where d 1 and d 2 are the input scaling factors.

Given these inputs, SROTMG generates a new modified rotation matrix H with units for either the diagonal or
off-diagonal elements, and new elements d 1′ and d 2′ for the new scaling factors, and rotated but unscaled
vector (b 1′, 0), with the following results:
 xr  1  b  1  b1  1  b1 
= D H  b 2  = D H  b 2 
1
G y  = G D 2   ′2   ′2 
 r   b2 
where:
 
1
 √d 1′ 0 
′2
D =  
 0 √d 2′ 
uses the updated scaling factors d 1 ’ and d 2 ’, which are d 1 and d 2 on output.
 h 1,1 h 1,2 
H =   is stored in the output array argument rparam
 h 2,1 h 2,2 
004– 2081– 002 65

b 1′ is stored as b 1 on output.
1/2 1/2
D’ H equals G D , not G, as implied earlier. You must account for the old scaling factors when
calculating the new scaling factors.
After calculating the matrix H by using SROTMG, you can then use it in SROTM(3S) to convert points to the
new coordinate system.
NOTES
Meaning of the Output Values

The output values are returned through arguments d 1 , d 2 , b 1 , and rparam.
The scaling factors d 1 and d 2 are updated with each call to SROTMG. Although SROTM(3S) does not need
the updated factors, they are needed in two other important contexts:
• As input for subsequent calls to SROTMG.
• As scaling factors for rotated but unscaled points (x i ), y i )), which are output from SROTM(3S).
In this second usage, the actual (scaled) points would be given by (√d 1xi , √d 2yi ). Doing this operation
frequently on all your points is counterproductive. The main advantage of the modified rotation algorithm
is to reduce the number of operations. If you fold in the scaling factors after each rotation, you are
performing the same number of operations as in the standard Givens rotation.
These two uses for the scaling factors are mutually exclusive; that is, if you fold the scaling factors back into
all your points, you no longer need those factors for SROTMG. After folding in the scaling factors, and
before the next call to SROTMG, reset d 1 and d 2 to 1.0.
On output, b 1 represents the new x-coordinate after rotating (but before scaling) the rotation vector.
Although the y-coordinate of this vector is 0.0 (see the the previous discussion), the corresponding value b 2
is unchanged on output.
The output array argument rparam specifies the format of matrix H, and it holds the nonunit values of H.
This is the only output of SROTMG that SROTM(3S) requires. Each element of rparam has a specific
meaning, as follows:
rparam(1) a flag parameter that specifies how the matrix is stored
= 0.0 Off-diagonal elements of H are units.
= 1.0 Diagonal elements of H are units.
= – 1.0 Rescaling case (see the following subsection).
= – 2.0 H is the identity matrix; no rotation needed.
rparam(2) = h 1,1 if needed
66 004– 2081– 002


Calculating the Output Values
The following presents the algorithm for calculating the output values d 1 , d 2 , b 1 , and rparam, based on the
input values d 1 , d 2 , b 1 , and b2. This algorithm is presented without explanation or proof. For a more
complete discussion of the modified Givens algorithm, see the papers listed in the SEE ALSO section.
Case 1: b 2 = 0 (trivial case)
In this case, no rotation is needed. The flag value, rparam(1), is set to – 2.0. When passed to routine
SROTM(3S), this flag indicates that it should not do any rotations.
On output from SROTMG, d 1, d 2, and b 1 are unchanged.
Case 2:  √d 1b 1  >  √d 2b 2  (  xr  >  yr  )
In this case, the diagonal elements of H (h 1,1 and h 2,2 ) are set to 1.0 . Thus, the rparam values set on
output are as follows:
rparam (1) ← 0.0
b2
rparam (3) ← h 2,1 = −
b1
d 2b 2
rparam (4) ← h 1,2 =
d 1b 1
The output values of the scaling factors are as follows:

d1
d 1 ← d 1′ =
u
d
d 2 ← d 2′ =
2
u
d 2b 22
where u = det(H ) = 1 + .
d 1b 12
The output value of b 1 is as follows:
b 1 ← b 1′ = b 1u
If rescaling is needed, SROTMG will further modify these output values before the end of the routine. See
case 4 later in this subsection.
Case 3:  √d 1b 1  ≤  √d 2b 2  (  xr  ≤  yr  )
In this case, the off-diagonal elements of H are units (to be specific, h 2,1 = −1 and h 1,2 = 1). Thus, the
rparam values set on output are as follows:
004– 2081– 002 67

rparam (1) ← 1.0

d 1b 1
rparam (2) ← h 1,1 =
d 2b 2
b1
rparam (5) ← h 2,2 =
b2
d2
d 1 ← d 1′ =
u
d1
d 2 ← d 2′ =
u
2
d 1b 1
where u = det(H ) = 1 + .
d 2b 22
b 1 ← b 1′ = b 2u
If rescaling is needed, SROTMG will further modify these output values before the end of the routine. See
case 4.
Case 4: Rescaling
If the scaling factors become either very large or very small, the scaling and rotation operations may lose a
lot of accuracy; therefore, each scaling factor from case 2 or case 3 is kept within the range:
γ-2 ≤  di ′  ≤ γ 2, for i = 1, 2
where γ = 2.012 = 4096.0.

At the end of case 2 or case 3 assignments, if either of the scaling factors falls outside this range, SROTMG
must rescale that factor (and the corresponding elements of H) to bring its size back within the specified
range. When the scaling factors stay within this range, scaling and rotation operations should keep the
following accuracy:
48 − log2(gamma ) = 48 − 12 = 36 bits (∼
∼10 decimal digits)
Rescaling is performed as follows:
If either d 1 or d 2 is 0, no rescaling is done;
otherwise, let
 log (  d ′  )   log (  d ′  ) 
1
qi = int(logγ(√  di ′  )) = int   = int  , for i =1, 2.
2 i 2 i
î 2 12  î 24 
Then the following is true:
68 004– 2081– 002

qi < 0, if  di ′  < γ2
qi = 0, if γ-2 ≤  di ′  ≤γ2
qi > 0, if  di ′  > γ2
Furthermore,  qi  represents the number of times di ′ must be multiplied (or divided) by γ 2

to return it to
the proper range of values.
In this case, the rparam values set on output are as follows:
rparam (1) ← −1.0
q1
rparam (2) ← h 1,1′ = h 1,1γ
q
rparam (3) ← h 2,1′ = h 2,1γ 2
q
rparam (4) ← h 1,2′ = h 1,2γ 1
q
rparam (5) ← h 2,2′ = h 2,2γ 2

−2q 1
d 1 ← d 1′′ = d 2′γ
−2q
d 2 ← d 2′′ = d 1′γ 2

q
b 1 ← b 1′′ = b 1′γ 1
SEE ALSO
SROTG(3S), SROTM(3S)
Gentleman, W. M., "Least Squares Computations by Givens Transformations Without Square Roots,"
Journal of the Institute for Mathematical Applications 12 (1973), pp. 329 – 336.
Lawson, C., Hanson, R., Kincaid, D., and Krogh, F., "Basic Linear Algebra Subprograms for Fortran Usage,"
ACM Transactions on Mathematical Software, 5 (1979), pp. 308 – 325.
004– 2081– 002 69

SSCAL ( 3S ) SSCAL ( 3S )
NAME
SSCAL, CSSCAL, CSCAL – Scales a real or complex vector
SYNOPSIS
CALL SSCAL (n, alpha, x, incx)
CALL CSSCAL (n, alpha, x, incx)
CALL CSCAL (n, alpha, x, incx)
IMPLEMENTATION
On UNICOS/mk systems, these subroutines execute on a single processor and use only private data.
DESCRIPTION
SSCAL scales a real vector with a real scalar.
CSSCAL scales a complex vector with a real scalar.
CSCAL scales a complex vector with a complex scalar.
These routines perform the following vector operation:
x←αx
where α is a real or complex scalar, and x is a real or complex vector.
n Integer. (input)
Number of elements in the vector. If n ≤ 0, SSCAL, CSSCAL, and CSCAL return without any
computation.
alpha SSCAL, CSSCAL: Real. (input)
CSCAL: Complex. (input)
Scalar value α by which to scale the vector.
x SSCAL: Real array of dimension (n– 1) .  incx  + 1. (input and output)
CSSCAL, CSCAL: Complex array of dimension (n– 1) .  incx  + 1. (input and output)
Vector to be scaled.
70 004– 2081– 002

SSCAL ( 3S ) SSCAL ( 3S )
NOTES
SSCAL, CSSCAL, and CSCAL are Level 1 Basic Linear Algebra Subprograms (Level 1 BLAS).
follows:
x(1– incx . (n– 1)), x(1– incx . (n– 2)), . . ., x(1)
004– 2081– 002 71

SSUM ( 3S ) SSUM ( 3S )
NAME
SSUM, CSUM – Sums the elements of a real or complex vector
SYNOPSIS
sum = SSUM (n, x, incx)
sum = CSUM (n, x, incx)
IMPLEMENTATION
DESCRIPTION
SSUM sums the elements of a real vector.
CSUM sums the elements of a complex vector.
SSUM and CSUM perform the following vector operation:
n
sum ← Σ xi
i =1

sum SSUM: Real. (input)
CSUM: Complex. (input)
Sum of the elements of the vector x. If n ≤ 0, sum is set to 0.
n Integer. (input)
Number of vector elements to be summed.
x SSUM: Real array of dimension (n– 1) .  incx  + 1. (input)
CSUM: Complex array of dimension (n– 1) .  incx  + 1. (input)
Vector that contains elements to be summed.
NOTES
SSUM and CSUM are extensions to the standard Level 1 Basic Linear Algebra Subprograms (Level 1 BLAS).
follows:
x(1– incx . (n– 1)), x(1– incx . (n– 2)), . . ., x(1)
72 004– 2081– 002

SSWAP ( 3S ) SSWAP ( 3S )
NAME
SSWAP, CSWAP – Swaps two real or complex vectors
SYNOPSIS
CALL SSWAP (n, x, incx, y, incy)
CALL CSWAP (n, x, incx, y, incy)
IMPLEMENTATION
DESCRIPTION
SSWAP swaps two real vectors.
CSWAP swaps two complex vectors.
SSWAP and CSWAP perform the following vector operation:
x <→ y
where x and y are real or complex vectors.
n Integer. (input)
Number of vector elements to be swapped. If n ≤ 0, SSWAP and CSWAP return without any
computation.
x SSWAP: Real array of dimension (n– 1) .  incx  + 1. (input and output)
CSWAP: Complex array of dimension (n– 1) .  incx  + 1. (input and output)
Vector to be swapped.
Increment between elements of x.
If incx = 0, the results will be unpredictable.
y SSWAP: Real array of dimension (n– 1) .  incy  + 1. (input and output)
CSWAP: Complex array of dimension (n– 1) .  incy  + 1. (input and output)
Vector to be swapped.
004– 2081– 002 73

SSWAP ( 3S ) SSWAP ( 3S )
NOTES
SSWAP and CSWAP are Level 1 Basic Linear Algebra Subprograms (Level 1 BLAS).
x(1– incx . (n– 1)), x(1– incx . (n– 2)), . . ., x(1)
y(1– incy . (n– 1)), y(1– incy . (n– 2)), . . ., y(1)
74 004– 2081– 002

NAME
INTRO_BLAS2 – Introduction to matrix-vector linear algebra subprograms
IMPLEMENTATION
DESCRIPTION
The linear algebra subprograms are written to run optimally on UNICOS and UNICOS/mk systems. These
subprograms use call-by-address convention when called by a Fortran or C program, or the assembler for
your system.
The Level 2 Basic Linear Algebra Subprograms (Level 2 BLAS) consist of CAM or CAL routines for real
and complex data. They handle matrix-vector operations. Only the single-precision real and complex data
types are supported.
Increment arguments for vectors
The description of a vector consists of the name of the array (x or y) followed by the storage spacing
(increment) in the array of vector elements (incx or incy). The increment can be positive or negative. When
a vector x consists of n elements, the corresponding actual array arguments must be of length at least
1+(n – 1) .  incx  . For a negative increment, the first element of x is assumed to be x (1+(n – 1) .  incx  .
Table of Level 2 BLAS routines
The following table describes these routines. If more than one routine name appears for a given block in the
table, the first name listed is the name of the man page that documents all routines listed in that block.
The table is in alphabetic order, except that each Hermitian matrix routine (any routine whose name begins
with CH) is grouped next to equivalent symmetric matrix routines (whose names begin with SS or CS). This
is because the Hermitian property is a type of symmetry.
Each routine in the table marked with an asterick (*) is an extension to the standard set of Level 2 BLAS
routines.
Multiplies a complex vector by a Hermitian y ←α Ax + β y CHBMV

band matrix
Multiplies a complex vector by a Hermitian y ←α Ax + β y CHEMV
matrix
H
Performs Hermitian rank 1 update of a A ←α xx + A CHER
Hermitian matrix
H H
Performs Hermitian rank 2 update of a A ← α xy + α yx + A CHER2
Hermitian matrix
004– 2081– 002 75

Multiplies a complex vector by a Hermitian y ← α Ax + β y CHPMV

packed matrix
H
Performs Hermitian rank 1 update of a A ← α xx + A CHPR
packed Hermitian matrix
H H
Performs Hermitian rank 2 update of a A ← α xy + α yx + A CHPR2
packed Hermitian matrix
T
Multiplies a real vector by a real general y ← α op(A)x + β y, op(A) = A or op(A) =A SGBMV
H
band matrix; multiplies a complex vector or op(A) = A (CGBMV only) CGBMV
by a complex general band matrix
T
Multiplies a real vector by a real general y ← α op(A)x + β y, op(A) = A or op(A) =A SGEMV
H
matrix; multiplies a complex vector by a or op(A) = A (CGEMV, ZGEMV only) CGEMV
complex general matrix
T
Performs rank 1 update of a real general A ←α xy + A SGER
matrix
H
Performs conjugated rank 1 update of a A ←α xy + A CGERC
T
Performs unconjugated rank 1 update of a A ←α xy + A CGERU
Adds a scalar multiple of a real or complex B ← α op(A) + β B SGESUM
matrix to a scalar multiple of another real
or complex matrix
Multiplies a real vector by a real symmetric y ← α Ax + β y SSBMV
band matrix
Multiplies a real vector by a real symmetric y ← α Ax + β y SSPMV
packed matrix
Multiplies a complex vector by a complex CSPMV*
symmetric packed matrix
T
Performs symmetric rank 1 update of a real A ← α xx + A SSPR
Performs symmetric rank 1 update of a CSPR*
complex symmetric packed matrix
T T
Performs two simultaneous symmetric rank A ← α xx + β yy + A CSSPR12*
1 updates of a real symmetric packed
matrix
76 004– 2081– 002


T T
Performs symmetric rank 2 update of a real A ← α xy + α yx + A SSPR2
Multiplies a real vector by a real symmetric y ← α Ax + β y SSYMV
matrix
Multiplies a complex vector by a complex CSYMV*
symmetric matrix
T
Performs symmetric rank 1 update of a real A ← α xx + A SSYR
symmetric matrix
Performs symmetric rank 1 update of a CSYR*
complex symmetric matrix
T T
Performs symmetric rank 2 update of a real A ← α xy + α yx + A CSSYR2
symmetric matrix
T
Multiplies a real vector by a real triangular x ← op(A)x, op(A) = A or op(A) = A or STBMV,
H
band matrix; multiplies a complex vector op(A) = A (CTBMV only) CTBMV
by a complex triangular band matrix
–1 T
Solves a complex triangular band system of x ← op(A) x, op(A) = A or op(A) = A or STBSV
H
equations op(A) = A (CTBSV only) CTBSV
T
Multiplies a real vector by a real triangular x ← op(A)x, op(A) = A or op(A) = A or STPMV
H
packed matrix; multiplies a complex vector op(A) = A (CTPMV only) CTPMV
by a complex triangular packed matrix
-1 T
Solves a real triangular packed system of x ← op(A) x, op(A) = A or op(A) = A or STPSV
H
equations; solves a complex triangular op(A) = A (CTPSV only) CTPSV
packed system of equations
T
Multiplies a real vector by a real triangular x ← op(A)x, op(A) = A or op(A) = A or STRMV
H
matrix; multiplies a complex vector by a op(A) = A (CTRMV only) CTRMV
complex triangular matrix
-1 T
Solves a real triangular system of x ← op(A) x, op(A) = A or op(A) = A or STRSV
H
equations; solves a complex triangular op(A) = A (CTRSV only) CTRSV
system of equations
SEE ALSO
Dongarra, J., J. Du Croz, S. Hammarling, and R. Hanson, "An Extended Set of FORTRAN Basic Linear
Algebra Subprograms," ACM Transactions on Mathematical Software, Vol. 14, No. 1, March 1988, pp. 1 –
17.
004– 2081– 002 77

CHBMV ( 3S ) CHBMV ( 3S )
NAME
CHBMV – Multiplies a complex vector by a complex Hermitian band matrix
SYNOPSIS
CALL CHBMV (uplo, n, k, alpha, a, lda, x, incx, beta, y, incy)
IMPLEMENTATION
DESCRIPTION
CHBMV performs the following matrix-vector operation where α and β are scalars, x and y are n-element
vectors, and A is an n-by-n Hermitian band matrix:
y ← α Ax+ β y
uplo Character*1. (input)
Specifies whether the upper or lower triangular part of the band matrix A is supplied, as follows:
uplo= ’U’ or ’u’: the upper triangular part of A is being supplied.
uplo= ’L’ or ’l’: the lower triangular part of A is being supplied.
n Integer. (input)
Specifies the order of matrix A. n ≥ 0.
k Integer. (input)
Specifies the number of superdiagonals of matrix A. k ≥ 0.
alpha Complex. (input)
Scalar factor α.
a Complex array of dimension (lda,n). (input)
Before entry with uplo = ’U’ or ’u’, the leading (k+1)-by-n part of array a must contain the
upper triangular band part of the Hermitian matrix, supplied column-by-column, with the leading
diagonal of the matrix in row k+1 of the array, the first superdiagonal starting at position 2 in
row k, and so on. The top left k-by-k triangle of array a is not referenced.
Before entry with uplo = ’L’ or ’l’, the leading (k+1)-by-n part of array a must contain the lower
triangular band part of the Hermitian matrix, supplied column-by-column, with the leading
diagonal of the matrix in row 1 of the array, the first subdiagonal starting at position 1 in row 2,
and so on. The bottom right k-by-k triangle of array a is not referenced.
The imaginary parts of the diagonal elements need not be set and are assumed to be 0. See the
EXAMPLES section for examples of Fortran code that transfer a band matrix from conventional
full matrix storage to band storage.
78 004– 2081– 002

lda Integer. (input)

Specifies the first dimension of a as declared in the calling program. lda ≥ (k+1).
x Complex array of dimension 1+(n– 1) .  incx  . (input)
Contains vector x.
Specifies the increment for the elements of x. incx must not be 0.
beta Complex. (input) Scalar factor α.
y Complex array of dimension 1+(n– 1) .  incy  . (input and output)
Contains vector y. On exit, the updated vector overwrites array y.
Specifies the increment for the elements of y. incy must not be 0.
NOTES
CHBMV is a Level 2 Basic Linear Algebra Subprogram (Level 2 BLAS).
When working backward (incx < 0 or incy < 0), this routine starts at the end of the vector and moves
x(1– incx . (n– 1)), x(1– incx . (n– 2)) , . . ., x(1)
y(1– incy . (n– 1)), y(1– incy . (n– 2)) , . . ., y(1)
EXAMPLES
The following program segment transfers the upper triangular part of a Hermitian band matrix from
conventional full matrix storage to band storage:
DO 20, J = 1, N
M = K + 1 - J
DO 10, I = MAX ( 1, J - K ), J
A( M + I, J ) = MAT RIX( I, J )
10 CON TINUE
20 CON TIN UE
The following program segment transfers the lower triangular part of a Hermitian band matrix from
DO 20, J = 1, N
M = 1 - J
DO 10, I = J, MIN ( N, J + K )
A( M + I, J ) = MATRIX ( I, J )
10 CON TINUE
20 CON TIN UE
004– 2081– 002 79

SEE ALSO
SSBMV(3S)
80 004– 2081– 002

CHEMV ( 3S ) CHEMV ( 3S )
NAME
CHEMV – Multiplies a complex vector by a complex Hermitian matrix
SYNOPSIS
CALL CHEMV (uplo, n, alpha, a, lda, x, incx, beta, y, incy)
IMPLEMENTATION
DESCRIPTION
CHEMV performs the following matrix-vector operation:
y ← α Ax + β y
where α and β are scalars, x and y are n-element vectors, and A is an n-by-n Hermitian matrix.
Specifies whether the upper or lower triangular part of array a is referenced, as follows:
uplo= ’U’ or ’u’: only the upper triangular part of a is referenced.
uplo= ’L’ or ’l’: only the lower triangular part of a is referenced.
n Integer. (input)
Scalar factor α.
a Complex array of dimension (lda,n). (input)
Before entry with uplo = ’U’ or ’u’, the leading n-by-n upper triangular part of array a must
contain the upper triangular part of the Hermitian matrix. The strictly lower triangular part of a
is not referenced.
Before entry with uplo = ’L’ or ’l’, the leading n-by-n lower triangular part of array a must
contain the lower triangular part of the Hermitian matrix. The strictly upper triangular part of a
is not referenced.
The imaginary parts of the diagonal elements need not be set and are assumed to be 0.
Specifies the first dimension of a as declared in the calling program.
Argument lda ≥ MAX(1,n).
Contains vector x.
004– 2081– 002 81

CHEMV ( 3S ) CHEMV ( 3S )

beta Complex. (input)
Scalar factor β. If beta is supplied as 0, y need not be set on input.
NOTES
CHEMV is a Level 2 Basic Linear Algebra Subprogram (Level 2 BLAS).
x(1– incx . (n– 1)), x(1– incx . (n– 2)) , . . ., x(1)
y(1– incy . (n– 1)), y(1– incy . (n– 2)) , . . ., y(1)
SEE ALSO
SSYMV(3S)
82 004– 2081– 002

CHER ( 3S ) CHER ( 3S )
NAME
CHER – Performs Hermitian rank 1 update of a complex Hermitian matrix
SYNOPSIS
CALL CHER (uplo, n, alpha, x, incx, a, lda)
IMPLEMENTATION
DESCRIPTION
CHER performs the following Hermitian rank 1 operation:
H
A ←α x x + A
H
where α is a real scalar, x is an n-element vector, x is the conjugate transpose of x, and A is an n-by-n
Hermitian matrix.
n Integer. (input)
alpha Real. (input)
Scalar factor α.
Contains vector x.
a Complex array of dimension (lda,n). (input and output)
is not referenced. On exit, the upper triangular part of the updated matrix overwrites the upper
triangular part of array a.
004– 2081– 002 83

CHER ( 3S ) CHER ( 3S )
is not referenced. On exit, the lower triangular part of the updated matrix overwrites the lower
The imaginary parts of the diagonal elements need not be set. They are assumed to be 0; on
exit, they are set to 0.
On entry, lda specifies the first dimension of a as declared in the calling program. lda ≥
MAX(1,n).
NOTES
CHER is a Level 2 Basic Linear Algebra Subprogram (Level 2 BLAS).
When working backward (incx < 0), this routine starts at the end of the vector and moves backward, as
follows:
x(1– incx . (n– 1)), x(1– incx . (n– 2)), . . ., x(1)
SEE ALSO
SSYR(3S)
84 004– 2081– 002

CHER2 ( 3S ) CHER2 ( 3S )
NAME
CHER2 – Performs Hermitian rank 2 update of a complex Hermitian matrix
SYNOPSIS
CALL CHER2 (uplo, n, alpha, x, incx, y, incy, a, lda)
IMPLEMENTATION
DESCRIPTION
CHER2 performs the following Hermitian rank 2 operation:
H H
A ← α xy + α yx + A
H H
where α is a scalar, α is the complex conjugate of α, x and y are n-element vectors, x and y conjugate
transposes of x and y, respectively, and A is an n-by-n Hermitian matrix.
n Integer. (input)
Scalar factor α.
Contains vector x.
y Complex array of dimension 1+(n– 1) .  incy  . (input)
Contains vector y.
a Complex array of dimension (lda,n). (input and output)
004– 2081– 002 85

CHER2 ( 3S ) CHER2 ( 3S )
Specifies the first dimension of a as declared in the calling program. lda ≥ MAX(1,n).
NOTES
CHER2 is a Level 2 Basic Linear Algebra Subprogram (Level 2 BLAS).
x(1– incx . (n– 1)), x(1– incx . (n– 2)) , . . ., x(1)
y(1– incy . (n– 1)), y(1– incy . (n– 2)) , . . ., y(1)
SEE ALSO
SSYR2(3S)
86 004– 2081– 002

CHPMV ( 3S ) CHPMV ( 3S )
NAME
CHPMV – Multiplies a complex vector by a packed complex Hermitian matrix
SYNOPSIS
CALL CHPMV (uplo, n, alpha, ap, x, incx, beta, y, incy)
IMPLEMENTATION
DESCRIPTION
CHPMV performs the following matrix-vector operation:
y ← α Ax + β y
where α and β are complex scalars, x and y are n-element vectors, and A is an n-by-n packed complex
Hermitian matrix.
Specifies whether the upper or lower triangular part of matrix A is packed into the array
argument ap, as follows:
uplo= ’U’ or ’u’: the upper triangular part of A is being supplied in the argument ap.
uplo= ’L’ or ’l’: the lower triangular part of A is being supplied in the argument ap.
n Integer. (input)
Scalar factor α.
n (n +1)
ap Complex array of dimension . (input)
2
Before entry with uplo = ’U’ or ’u’, array ap must contain the upper triangular part of the
Hermitian matrix packed sequentially, column-by-column, so that ap(1) contains A(1,1), ap(2)
contains A(1,2), ap(3) contains A(2,2), and so on.
Before entry with uplo = ’L’ or ’l’, array ap must contain the lower triangular part of the
Contains vector x.
004– 2081– 002 87

CHPMV ( 3S ) CHPMV ( 3S )

Contains vector y. On exit, y is overwritten by updated vector y.
NOTES
CHPMV is a Level 2 Basic Linear Algebra Subprogram (Level 2 BLAS).
x(1– incx . (n– 1)), x(1– incx . (n– 2)) , . . ., x(1)
y(1– incy . (n– 1)), y(1– incy . (n– 2)) , . . ., y(1)
SEE ALSO
SSPMV(3S)
88 004– 2081– 002

CHPR ( 3S ) CHPR ( 3S )
NAME
CHPR – Performs Hermitian rank 1 update of a packed complex Hermitian matrix
SYNOPSIS
CALL CHPR (uplo, n, alpha, x, incx, ap)
IMPLEMENTATION
DESCRIPTION
CHPR performs the following Hermitian rank 1 operation:
H
A ← α xx + A
H
where α is a real scalar, x is an n-element vector, x is the conjugate transpose of x, and A is an n-by-n
packed complex Hermitian matrix.
uplo= ’U’ or ’u’: the upper triangular part of A is supplied in the argument ap.
uplo= ’L’ or ’l’: the lower triangular part of A is supplied in the argument ap.
n Integer. (input)
Scalar factor α.
Contains vector x.
n (n +1)
ap Complex array of dimension . (input and output)
2
contains A(1,2), ap(3) contains A(2,2), and so on. On exit, the upper triangular part of the
updated matrix overwrites array ap.
004– 2081– 002 89

CHPR ( 3S ) CHPR ( 3S )
contains A(2,1), ap(3) contains A(3,1), and so on. On exit, the lower triangular part of the
NOTES
CHPR is a Level 2 Basic Linear Algebra Subprogram (Level 2 BLAS).
When working backward (incx < 0), this routine starts at the end of the vector and moves backward, as
follows:
x(1– incx . (n– 1)), x(1– incx . (n– 2)), . . ., x(1)
SEE ALSO
SSPR(3S)
90 004– 2081– 002

CHPR2 ( 3S ) CHPR2 ( 3S )
NAME
CHPR2 – Performs Hermitian rank 2 update of a packed complex Hermitian matrix
SYNOPSIS
CALL CHPR2 (uplo, n, alpha, x, incx, y, incy, ap)
IMPLEMENTATION
DESCRIPTION
CHPR2 performs the following Hermitian rank 2 operation:
H H
H H
where α is a scalar, α is the complex conjugate of α, x and y are n-element vectors, x and y conjugate
transposes of x and y, respectively, and A is an n-by-n packed complex Hermitian matrix.
n Integer. (input)
Scalar factor α.
Contains vector x.
Increment for the elements of x. incx must not be 0.
y Complex array of dimension 1+(n– 1) .  incy  . (input)
Contains vector y.
Increment for the elements of y. Argument incy must not be 0.
n (n +1)
ap Complex array of dimension . (input and output)
2
004– 2081– 002 91

CHPR2 ( 3S ) CHPR2 ( 3S )
NOTES
CHPR2 is a Level 2 Basic Linear Algebra Subprogram (Level 2 BLAS).
x(1– incx . (n– 1)), x(1– incx . (n– 2)) , . . ., x(1)
y(1– incy . (n– 1)), y(1– incy . (n– 2)) , . . ., y(1)
SEE ALSO
SSPR(3S)
92 004– 2081– 002

SGBMV ( 3S ) SGBMV ( 3S )
NAME
SGBMV, CGBMV – Multiplies a real or complex vector by a real or complex general band matrix
SYNOPSIS
CALL SGBMV (trans, m, n, kl, ku, alpha, a, lda, x, incx, beta, y, incy)
CALL CGBMV (trans, m, n, kl, ku, alpha, a, lda, x, incx, beta, y, incy)
IMPLEMENTATION
DESCRIPTION
SGBMV multiplies a real vector by a real general band matrix.
CGBMV multiplies a complex vector by a complex general band matrix.
SGBMV and CGBMV perform one of the following matrix-vector operations:
y ← α Ax + β y
T
y ←αA x+βy
H
y ←αA x+βy
where
• α and β are scalars,
• x and y are vectors
• A is an m-by-n band matrix with kl subdiagonals and ku superdiagonals
T
• A is the transpose of A
H
• A is the conjugate transpose of A
trans Character*1. (input)
Specifies the operation to be performed:
trans = ’N’ or ’n’: y ← α Ax + βy
T
trans = ’T’ or ’t’: y ← α A x + β y
T H
trans = ’C’ or ’c’: y ← α A x + β y (SGBMV), or y ← α A x + β y (CGBMV)
m Integer. (input)
Specifies the number of rows in matrix A. m ≥ 0.
n Integer. (input)
Specifies the number of columns in the matrix A. n ≥ 0.
004– 2081– 002 93

kl Integer. (input)
Specifies the number of subdiagonals of matrix A. kl ≥ 0.
ku Integer. (input)
Specifies the number of superdiagonals of matrix A. ku ≥ 0.
alpha SGBMV: Real. (input)
CGBMV: Complex. (input)
Scalar factor α.
a SGBMV: Real array of dimension (lda,n). (input)
CGBMV: Complex array of dimension (lda,n). (input)
Before entry, the leading (kl+ku+1)-by-n part of array a must contain the matrix of coefficients,
supplied column-by-column, with the leading diagonal of the matrix in row (ku+1) of the array,
the first superdiagonal starting at position 2 in row ku, the first subdiagonal starting at position 1
in row (ku+2), and so on. Elements in array a that do not correspond to elements in the band
matrix (such as the top left ku-by-ku triangle) are not referenced.
See the NOTES section for an example of Fortran code that transfers a band matrix from
conventional full matrix storage to band storage.
Specifies the first dimension of a as declared in the calling program. lda ≥ (kl+ku+1).
x SGBMV: Real array of dimension 1+(kx– 1) .  incx  . (input)
CGBMV: Complex array of dimension 1+(kx– 1) .  incx  . (input)
Contains the vector x. When trans = ’N’ or ’n’, kx is n; otherwise, it is m.
beta SGBMV: Real. (input)
CGBMV: Complex. (input)
Scalar factor β. When beta is supplied as 0, y need not be set on input.
y SGBMV: Real array of dimension 1+(ky– 1) .  incy  . (input and output)
CGBMV: Complex array of dimension 1+(ky– 1) .  incy  . (input and output)
Contains the vector y. When trans = ’N’ or ’n’, ky is m; otherwise, it is n. On exit, the updated
vector overwrites array y.
Specifies the increment for the elements of y.
incy must not be 0.
94 004– 2081– 002

NOTES
The following program segment transfers a band matrix from conventional full matrix storage to band
storage:
DO 20, J = 1, N
K = KU + 1 - J
DO 10, I = MAX (1, J - KU) , MIN (M, J + KL)
A(K + I, J) = MAT RIX (I, J)
10 CONTIN UE
20 CON TINUE
SGBMV and CGBMV are Level 2 Basic Linear Algebra Subprograms (Level 2 BLAS).
x(1– incx . (n– 1)), x(1– incx . (n– 2)) , . . ., x(1)
y(1– incy . (n– 1)), y(1– incy . (n– 2)) , . . ., y(1)
004– 2081– 002 95

SGEMV ( 3S ) SGEMV ( 3S )
NAME
SGEMV, CGEMV – Multiplies a real or complex vector by a real or complex general matrix
SYNOPSIS
CALL SGEMV (trans, m, n, alpha, a, lda, x, incx, beta, y, incy)
CALL CGEMV (trans, m, n, alpha, a, lda, x, incx, beta, y, incy)
IMPLEMENTATION
DESCRIPTION
SGEMV multiplies a real vector by a real general matrix.
CGEMV multiplies a complex vector by a complex general matrix.
SGEMV and CGEMV perform one of the following matrix-vector operations:
y ← α Ax + β y
T
y ←αA x+βy
H
y ←αA x+βy
where
• α and β are scalars,
• x and y are vectors
• A is an m-by-n general matrix
T
H
Specifies the operation to be performed:
trans = ’N’ or ’n’: y ← α Ax + βy
T
trans = ’T’ or ’t’: y ← α A x + β y
T H
trans = ’C’ or ’c’: y ← α A x + β y (SGEMV), or y ← α A x + β y (CGEMV)
m Integer. (input)
n Integer. (input)
Specifies the number of columns in matrix A. n ≥ 0.
96 004– 2081– 002

SGEMV ( 3S ) SGEMV ( 3S )
alpha SGEMV: Real. (input)

CGEMV: Complex. (input)
Scalar factor α.
a SGEMV: Real array of dimension (lda,n). (input)
CGEMV: Complex array of dimension (lda,n). (input)
Before entry, the leading m-by-n part of array a must contain the matrix of coefficients.
Specifies the first dimension of a as declared in the calling program. lda ≥ MAX(1,m).
x SGEMV: Real array of dimension 1+(kx– 1) .  incx  . (input)
CGEMV: Complex array of dimension 1+(kx– 1) .  incx  . (input)
Contains the vector x. When trans = ’N’ or ’n’, kx is n; otherwise, it is m.
beta SGEMV: Real. (input)
CGEMV: Complex. (input)
Scalar factor β. When beta is supplied as 0, y need not be set on input.
y SGEMV: Real array of dimension 1+(ky– 1) .  incy  . (input and output)
CGEMV: Complex array of dimension 1+(ky– 1) .  incy  . (input and output)
Contains the vector y. When trans = ’N’ or ’n’, ky is m; otherwise, it is n. When beta is
supplied as 0, y need not be set on input. On exit, the updated vector overwrites array y.
NOTES
SGEMV and CGEMV are Level 2 Basic Linear Algebra Subprograms (Level 2 BLAS).
x(1– incx . (n– 1)), x(1– incx . (n– 2)) , . . ., x(1)
y(1– incy . (n– 1)), y(1– incy . (n– 2)) , . . ., y(1)
004– 2081– 002 97

SGER ( 3S ) SGER ( 3S )
NAME
SGER, CGERC, CGERU – Performs rank 1 update of a real general matrix
SYNOPSIS
CALL SGER (m, n, alpha, x, incx, y, incy, a, lda)
CALL CGERC (m, n, alpha, x, incx, y, incy, a, lda)
CALL CGERU (m, n, alpha, x, incx, y, incy, a, lda)
IMPLEMENTATION
DESCRIPTION
SGER performs a rank 1 update of a real general matrix.
CGERC performs a conjugated rank 1 update of a complex general matrix.
CGERU performs an unconjugated rank 1 update of a complex general matrix.
SGER and CGERU perform the rank 1 operation:
T
A ← α xy + A
T
where y is the transpose of y, α is a scalar, x is an m-element vector, y is an n-element vector, and A is an
m-by-n matrix.
CGERC performs the rank 1 operation:
H
A ← α xy + A
H
where y is the conjugate transpose of y, α is a scalar, x is an m-element vector, y is an n-element vector,
and A is an m-by-n matrix.
m Integer. (input)
n Integer. (input)
Specifies the number of columns in matrix A. n ≥ 0.
alpha SGER: Real. (input)
CGERC, CGERU: Complex. (input)
Scalar factor α.
98 004– 2081– 002

SGER ( 3S ) SGER ( 3S )
x SGER: Real. (input)

Array of dimension 1+(m– 1) .  incx  .
Contains vector x.
y SGER: Real. (input)
Array of dimension 1+(n– 1) .  incy  .
Contains vector y.
a SGER: Real.
CGERC, CGERU: Complex.
Array of dimension (lda,n). (input and output)
Before entry, the leading m-by-n part of array a must contain the matrix of coefficients. On exit,
the updated matrix overwrites array a.
Specifies the first dimension of a as declared in the calling program. lda ≥ MAX(1,m).
NOTES
SGER, CGERC, and CGERU are Level 2 Basic Linear Algebra Subprograms (Level 2 BLAS).
When working backward (incx < 0 or incy < 0), these routines start at the end of the vector and move
x(1– incx . (n– 1)), x(1– incx . (n– 2)) , . . ., x(1)
y(1– incy . (n– 1)), y(1– incy . (n– 2)) , . . ., y(1)
004– 2081– 002 99

SGESUM ( 3S ) SGESUM ( 3S )
NAME
SGESUM, CGESUM – Adds a scalar multiple of a real or complex matrix to a scalar multiple of another real
or complex matrix
SYNOPSIS
CALL SGESUM (trans, m, n, alpha, a, lda, beta, b, ldb)
CALL CGESUM (trans, m, n, alpha, a, lda, beta, b, ldb)
IMPLEMENTATION
UNICOS/mk systems
These subroutines execute on a single processor and use private data only.
DESCRIPTION
SGESUM adds two real matrices with optional scaling; CGESUM adds two complex matrices.
B ← α op(A) + β B
where
• op(A) represents A, its transpose A T , or its conjugate transpose A H
• op(A) and B are m-by-n matrices
• α and β are scalars. β =0 is a special case, used to copy α . op (A ) to B. α =0 is a special case, used to
scale B.
Specifies whether the matrix A is transposed.
trans = ’N’ or ’n’: op(A) = A
T
trans = ’T’ or ’t’: op(A) = A
T H
trans = ’C’ or ’c’: op(A) = A (SGESUM), or op(A) = A (CGESUM)
m Integer. (input)
Specifies the number of rows in matrix op(A) and in matrix B.
n Integer. (input)
Specifies the number of columns in matrix op(A) and in matrix B.
alpha SGESUM: Real. (input)
CGESUM: Complex. (input)
Scalar factor α.
a SGESUM: Real array of dimension (lda,k). (input)
CGESUM: Complex array of dimension (lda,k). (input)
100 004– 2081– 002

SGESUM ( 3S ) SGESUM ( 3S )
When trans = ’N’ or ’n’, k is n; otherwise, it is m. When trans = ’N’ or ’n’, the leading m-by-n
part of the array a contains matrix A. When trans = ’T’ or ’t’ or trans = ’C’ or ’c’, the leading
n-by-m part or the array a contains matrix A, whose transpose or conjugate transpose will be
used in the matrix sum. If alpha = 0, a need not be specified on entry.
Specifies the first dimension of a as declared in the calling program. When trans = ’N’ or ’n’,
lda ≥ MAX(1,m); otherwise, lda ≥ MAX(1,n).
beta SGESUM: Real. (input)
CGESUM: Complex. (input)
Scalar factor β.
b SGESUM: Real array of dimension (ldb,n). (input/output)
CGESUM: Complex array of dimension (ldb,n). (input/output)
On entry, if beta ≠0, the m-by-n matrix b contains B. (If β = 0, b need not be specifed on
entry.) On exit, b is overwritten with the matrix sum α op (A ) + β B .
ldb Integer. (input)
The leading dimension of array b. ldb ≥ MAX(1,m).
EXAMPLES
An important use of SGESUM is to copy an array to another array, in which the second array may be a
temporary workspace that has a better data layout than the first array. For example, suppose array A was
declared as follows in the main program:
REA L A(1 024, 1024)
This data layout is particularity bad for Level 3 BLAS operations that must fit a block of A in the direct-
mapped cache of UNICOS/mk systems, because every column has exactly the same cache offset as every
other column. It might be worthwhile to operate on a block of A at a time by copying a part of A into a
second array B. Give B a leading dimension that is an odd multiple of 16, so that a 16-by-64 subblock of B
will fit in the cache:
REA L B(8 0, 64)
CDI R$ CACHE_ ALIGN B
The following call to SGESUM copies a 64-by-64 block of A to B:

CAL L SGE SUM (’N’, 64, 64 1.0 , A(1 ,1), 1024, 0.0, B(1,1) , 80)
Similarly, the following call copies a 64-by-64 block of the transpose of A to B:

CALL SGESUM (’T ’, 64, 64, 1.0 , A(1 ,1), 1024, 0.0, B(1,1) , 80)
SEE ALSO
SAXPBY(3S)
004– 2081– 002 101

SSBMV ( 3S ) SSBMV ( 3S )
NAME
SSBMV – Multiplies a real vector by a real symmetric band matrix
SYNOPSIS
CALL SSBMV (uplo, n, k, alpha, a, lda, x, incx, beta, y, incy)
IMPLEMENTATION
DESCRIPTION
SSBMV performs the following matrix-vector operation:
y ← α Ax + β y
where α and β are scalars, x and y are n-element vectors, and A is an n-by-n symmetric band matrix.
Specifies whether the upper or lower triangular part of band matrix A is supplied, as follows:
uplo= ’U’ or ’u’: the upper triangular part of A is being supplied.
uplo= ’L’ or ’l’: the lower triangular part of A is being supplied.
n Integer. (input)
k Integer. (input)
Specifies the number of superdiagonals of matrix A. k ≥ 0.
alpha Real. (input)
Scalar factor α.
a Real array of dimension (lda,n). (input)
Before entry with uplo = ’U’ or ’u’, the leading (k+1)-by-n part of array a must contain the
upper triangular band part of the symmetric matrix, supplied column-by-column, with the leading
diagonal of the matrix in row (k+1) of the array, the first superdiagonal starting at position 2 in
row k, and so on. The top left k-by-k triangle of array a is not referenced.
triangular band part of the symmetric matrix, supplied column-by-column, with the leading
See the NOTES section for examples of Fortran code that transfer upper and lower parts of
symmetric band matrices from conventional full matrix storage to band storage.
102 004– 2081– 002

SSBMV ( 3S ) SSBMV ( 3S )

lda ≥ (k+1).
x Real array of dimension 1+(n– 1) .  incx  . (input)
Contains vector x.
beta Real. (input)
Scalar factor β.
y Real array of dimension 1+(n– 1) .  incy  . (input and output)
NOTES
The following program segment transfers the upper triangular part of a symmetric band matrix from
DO 20, J = 1, N
M = K + 1 - J
DO 10, I = MAX ( 1, J - K ), J
A( M + I, J ) = MAT RIX( I, J )
10 CON TINUE
20 CON TIN UE
The following program segment transfers the lower triangular part of a symmetric band matrix from
DO 20, J = 1, N
M = 1 - J
DO 10, I = J, MIN( N, J + K )
A( M + I, J ) = MAT RIX( I, J )
10 CON TINUE
20 CON TIN UE
SSBMV is a Level 2 Basic Linear Algebra Subprogram (Level 2 BLAS).

x(1– incx . (n– 1)), x(1– incx . (n– 2)) , . . ., x(1)
y(1– incy . (n– 1)), y(1– incy . (n– 2)) , . . ., y(1)
004– 2081– 002 103

SSPMV ( 3S ) SSPMV ( 3S )
NAME
SSPMV, CSPMV – Multiplies a real or complex symmetric packed matrix by a real or complex vector
SYNOPSIS
CALL SSPMV (uplo, n, alpha, ap, x, incx, beta, y, incy)
CALL CSPMV (uplo, n, alpha, ap, x, incx, beta, y, incy)
IMPLEMENTATION
Only the real routine executes on UNICOS/mk systems (on a single processor, using only private data).
DESCRIPTION
SSPMV and CSPMV perform the following matrix-vector operation:
y ← α Ax + β y
where α and β are scalars, x and y are n-element vectors, and A is an n-by-n symmetric packed matrix.
n Integer. (input)
alpha SSPMV: Real. (input)
CSPMV: Complex. (input) Scalar factor α .
n (n +1)
ap SSPMV: real array of dimension . (input)
2
n (n +1)
CSPMV: complex array of dimension . (input)
2
symmetric matrix packed sequentially, column-by-column, so that ap(1) contains A(1,1), ap(2)
104 004– 2081– 002

SSPMV ( 3S ) SSPMV ( 3S )
x SSPMV: Real array of dimension 1+(n– 1) .  incx  . (input)

CSPMV: Complex array of dimension 1+(n– 1) .  incx  . (input)
Contains vector x.
beta SSPMV: Real. (input)
CSPMV: Complex. (input)
Scalar factor β . If beta is supplied as 0, y need not be set on input.
y SSPMV: Real array of dimension 1+(n– 1) .  incy  . (input and output)
CSPMV: Complex array of dimension 1+(n– 1) .  incy  . (input and output)
NOTES
SSPMV is a Level 2 Basic Linear Algebra Subprogram (Level 2 BLAS). CSPMV is an extension to Level 2
BLAS.
x(1– incx . (n– 1)), x(1– incx . (n– 2)) , . . ., x(1)
y(1– incy . (n– 1)), y(1– incy . (n– 2)) , . . ., y(1)
SEE ALSO
CHPMV(3S)
004– 2081– 002 105

SSPR ( 3S ) SSPR ( 3S )
NAME
SSPR, CSPR – Performs symmetric rank 1 update of a real or complex symmetric packed matrix
SYNOPSIS
CALL SSPR (uplo, n, alpha, x, incx, ap)
CALL CSPR (uplo, n, alpha, x, incx, ap)
IMPLEMENTATION
DESCRIPTION
SSPR and CSPR each perform the following symmetric rank 1 operation:
T
A ← α xx + A
T
where x is the transpose of x, α is a real or complex scalar, x is an n-element vector, and A is an n-by-n
symmetric packed matrix.
n Integer. (input)
alpha SSPR: Real. (input)
CSPR: Complex. (input)
Scalar factor α.
x SSPR: Real array of dimension 1+(n– 1) .  incx  . (input)
CSPR: Complex array of dimension 1+(n– 1) .  incx  . (input)
Contains vector x.
106 004– 2081– 002

SSPR ( 3S ) SSPR ( 3S )
n (n +1)
ap SSPR: Real array of dimension . (input and output)
2
n (n +1)
CSPR: Complex array of dimension . (input and output)
2
NOTES
SSPR is a Level 2 Basic Linear Algebra Subprogram (Level 2 BLAS). CSPR is an extension to Level 2
BLAS.
follows:
x(1– incx . (n– 1)), x(1– incx . (n– 2)), . . ., x(1)
SEE ALSO
CHPR(3S)
004– 2081– 002 107

SSPR2 ( 3S ) SSPR2 ( 3S )
NAME
SSPR2 – Performs symmetric rank 2 update of a real symmetric packed matrix
SYNOPSIS
CALL SSPR2 (uplo, n, alpha, x, incx, y, incy, ap)
IMPLEMENTATION
DESCRIPTION
SSPR2 performs the following symmetric rank 2 operation:
T T
T T
where x is the transpose of x, y is the transpose of y, α is a real scalar, x and y are n-element vectors,
and A is an n-by-n symmetric packed matrix.
n Integer. (input)
alpha Real. (input)
Scalar factor α.
Contains vector x.
y Real array of dimension 1+(n– 1) .  incy  . (input)
Contains vector y.
Increment for the elements of y. incy must not be 0.
108 004– 2081– 002

SSPR2 ( 3S ) SSPR2 ( 3S )
n (n +1)
ap Real array of dimension . (input and output)
2
NOTES
SSPR2 is a Level 2 Basic Linear Algebra Subprogram (Level 2 BLAS).
x(1– incx . (n– 1)), x(1– incx . (n– 2)) , . . ., x(1)
y(1– incy . (n– 1)), y(1– incy . (n– 2)) , . . ., y(1)
SEE ALSO
CHPR2(3S)
004– 2081– 002 109

SSPR12 ( 3S ) SSPR12 ( 3S )
NAME
SSPR12 – Performs two simultaneous symmetric rank 1 updates of a real symmetric packed matrix
SYNOPSIS
CALL SSPR12 (uplo, n, alpha, x, incx, beta, y, incy, ap)
IMPLEMENTATION
UNICOS systems
DESCRIPTION
SSPR12 performs the following matrix-vector operation:
T T
A ← α xx + β yy + A
T T
where x is the transpose of x, y is the transpose of y, α and β are real scalars, x and y are n-element
vectors, and A is an n-by-n real symmetric packed matrix.
uplo= ’L’ or ’l’; the lower triangular part of A is being supplied in the argument ap.
n Integer. (input)
alpha Real. (input)
Scalar factor α.
Contains vector x.
beta Real. (input)
Scalar factor β.
Contains vector y.
Increment for the elements of y. incy must not be 0.
n (n +1)
ap Real array of dimension . (input and output)
2
110 004– 2081– 002

SSPR12 ( 3S ) SSPR12 ( 3S )
NOTES
SSPR12 is an extension to the standard Level 2 Basic Linear Algebra Subprograms (Level 2 BLAS). It is
similar in function to the Level 2 BLAS routine SSPR2(3S) and is equivalent to two rank 1 updates.
For example,
CALL SSPR12 (UPLO, N,A LPHA,X ,IN CX, BET A,Y,IN CY,AP)
is equivalent to:
CALL SSPR(U PLO,N, ALP HA,X,I NCX ,AP )
CAL L SSP R(UPLO ,N,BET A,Y ,IN CY,AP)
x(1– incx . (n– 1)), x(1– incx . (n– 2)) , . . ., x(1)
y(1– incy . (n– 1)), y(1– incy . (n– 2)) , . . ., y(1)
004– 2081– 002 111

SSYMV ( 3S ) SSYMV ( 3S )
NAME
SSYMV, CSYMV – Multiplies a real or complex vector by a real or complex symmetric matrix
SYNOPSIS
CALL SSYMV (uplo, n, alpha, a, lda, x, incx, beta, y, incy)
CALL CSYMV (uplo, n, alpha, a, lda, x, incx, beta, y, incy)
IMPLEMENTATION
DESCRIPTION
SSYMV multiplies a real vector by a real symmetric matrix.
CSYMV multiplies a complex vector by a complex symmetric matrix.
SSYMV and CSYMV perform the following matrix-vector operation:
y ← α Ax + β y
where α and β are scalars, x and y are n-element vectors, and A is an n-by-n symmetric matrix.
Specifies whether the upper or lower triangular part of matrix A is being supplied, as follows:
uplo= ’U’ or ’u’: only the upper triangular part of A is being supplied.
uplo= ’L’ or ’l’: only the lower triangular part of A is being supplied.
n Integer. (input)
alpha SSYMV: Real. (input)
CSYMV: Complex. (input)
Scalar factor α.
a SSYMV: Real array of dimension (lda,n). (input)
CSYMV: Complex array of dimension (lda,n). (input)
contain the upper triangular part of the symmetric matrix. The strictly lower triangular part of a
is not referenced.
contain the lower triangular part of the symmetric matrix. The strictly upper triangular part of a
is not referenced.
112 004– 2081– 002

SSYMV ( 3S ) SSYMV ( 3S )

x SSYMV: Real array of dimension 1+(n– 1) .  incx  . (input)
CSYMV: Complex array of dimension 1+(n– 1) .  incx  . (input)
Contains the vector x.
beta SSYMV: Real. (input)
CSYMV: Complex. (input)
y SSYMV: Real array of dimension 1+(n– 1) .  incy  . (input and output)
CSYMV: Complex array of dimension 1+(n– 1) .  incy  . (input and output)
Contains the vector y. On exit, the updated vector overwrites array y.
NOTES
SSYMV is a Level 2 Basic Linear Algebra Subprogram (Level 2 BLAS). CSYMV is an extension to Level 2
BLAS.
x(1– incx . (n– 1)), x(1– incx . (n– 2)) , . . ., x(1)
y(1– incy . (n– 1)), y(1– incy . (n– 2)) , . . ., y(1)
SEE ALSO
CHEMV(3S)
004– 2081– 002 113

SSYR ( 3S ) SSYR ( 3S )
NAME
SSYR, CSYR – Performs symmetric rank 1 update of a real or complex symmetric matrix
SYNOPSIS
CALL SSYR (uplo, n, alpha, x, incx, a, lda)
CALL CSYR (uplo, n, alpha, x, incx, a, lda)
IMPLEMENTATION
UNICOS/mk systems
Only the real routine executes on UNICOS/mk systems, on a single processor, using only private data.
DESCRIPTION
SSYR and CSYR perform the following symmetric rank 1 operation:
T
A ← α xx + A
T
where x is the transpose of x, α is a real or complex scalar, x is an n-element vector, and A is an n-by-n
symmetric matrix.
n Integer. (input)
alpha SSYR: Real. (input)
CSYR: Complex. (input)
Scalar factor α.
x SSYR: Real array of dimension 1+(n– 1) .  incx  . (input)
CSYR: Complex array of dimension 1+(n– 1) .  incx  . (input)
Contains vector x.
a SSYR: Real array of dimension (lda,n). (input and output)
CSYR: Complex array of dimension (lda,n). (input and output)
114 004– 2081– 002

SSYR ( 3S ) SSYR ( 3S )
contain the upper triangular part of the symmetric matrix. The strictly lower triangular part of a
contain the lower triangular part of the symmetric matrix. The strictly upper triangular part of a
NOTES
SSYR is a Level 2 Basic Linear Algebra Subprogram (Level 2 BLAS). CSYR is an extension to Level 2
BLAS.
follows:
x(1– incx . (n– 1)), x(1– incx . (n– 2)), . . ., x(1)
SEE ALSO
CHER(3S)
004– 2081– 002 115

SSYR2 ( 3S ) SSYR2 ( 3S )
NAME
SSYR2 – Performs symmetric rank 2 update of a real symmetric matrix
SYNOPSIS
CALL SSYR2 (uplo, n, alpha, x, incx, y, incy, a, lda)
IMPLEMENTATION
On UNICOS/mk, this subroutine executes on a single processor and uses only private data
DESCRIPTION
SSYR2 performs the following symmetric rank 2 operation:
T T
T T
where α is a real scalar, y is the transpose of y, x is the transpose of x, x and y are n-element vectors, and
A is an n-by-n real symmetric matrix.
Specifies whether the upper or lower triangular part of matrix A is being supplied, as follows:
uplo= ’U’ or ’u’: only the upper triangular part of array a is referenced.
uplo= ’L’ or ’l’: only the lower triangular part of array a is referenced.
n Integer. (input)
alpha Real. (input)
Scalar factor α.
Contains vector x.
On entry, incx specifies the increment for the elements of x. incx must not be 0.
Contains vector y.
On entry, incy specifies the increment for the elements of y. incy must not be 0.
a Real array of dimension (lda,n). (input and output)
116 004– 2081– 002

SSYR2 ( 3S ) SSYR2 ( 3S )
Before entry with uplo=’U’ or ’u’, the leading n-by-n upper triangular part of array a must
contain the upper triangular part of the symmetric matrix and the strictly lower triangular part of
a is not referenced. On exit, the upper triangular part of the updated matrix overwrites the upper
Before entry with uplo=’L’ or ’l’, the leading n-by-n lower triangular part of array a must
contain the lower triangular part of the symmetric matrix and the strictly upper triangular part of
a is not referenced. On exit, the lower triangular part of the updated matrix overwrites the lower
NOTES
SSYR2 is a Level 2 Basic Linear Algebra Subprogram (Level 2 BLAS).
x(1– incx . (n– 1)), x(1– incx . (n– 2)) , . . ., x(1)
y(1– incy . (n– 1)), y(1– incy . (n– 2)) , . . ., y(1)
SEE ALSO
CHER2(3S)
004– 2081– 002 117

STBMV ( 3S ) STBMV ( 3S )
NAME
STBMV, CTBMV – Multiplies a real or complex vector by a real or complex triangular band matrix
SYNOPSIS
CALL STBMV (uplo, trans, diag, n, k, a, lda, x, incx)
CALL CTBMV (uplo, trans, diag, n, k, a, lda, x, incx)
IMPLEMENTATION
DESCRIPTION
STBMV multiplies a real vector by a real triangular band matrix.
CTBMV multiplies a complex vector by a complex triangular band matrix.
STBMV and CTBMV perform one of the following matrix-vector operations:
x ← Ax
T
x←A x
H
x ← A x (CTBMV only)
T H
where A is the transpose of A, A is the conjugate transpose of A, x is an n-element vector, and A may be
either a unit or nonunit n-by-n upper or lower triangular band matrix with (k+1) diagonals.
Specifies whether the matrix is upper or lower triangular, as follows:
uplo = ’U’ or ’u’: A is an upper triangular matrix.
uplo = ’L’ or ’l’: A is a lower triangular matrix.
trans Character *1. (input)
Specifies the operation to be performed, as follows:
trans = ’N’ or ’n’: x ← Ax
T
trans = ’T’ or ’t’: x ← A x
T H
trans = ’C’ or ’c’: x ← A x (STBMV), or x ← A x (CTBMV)
diag Character *1. (input)
Specifies whether A is unit triangular, as follows:
diag = ’U’ or ’u’: A is assumed to be unit triangular.
diag = ’N’ or ’n’: A is not assumed to be unit triangular.
118 004– 2081– 002

n Integer. (input)
k Integer. (input)
uplo = ’U’ or ’u’: k specifies the number of superdiagonals of matrix A.
uplo = ’L’ or ’l’: k specifies the number of subdiagonals of matrix A.
k ≥ 0.
a STBMV: Real array of dimension (lda,n). (input)
CTBMV: Complex array of dimension (lda,n). (input)
Before entry with uplo = ’U’ or ’u’, the leading (k+1)-by-n upper part of array a must contain
the upper triangular band part of the matrix of coefficients, supplied column-by-column, with the
leading diagonal of the matrix in row (k+1) of the array, the first superdiagonal starting at
position 2 in row k, and so on. The top left k-by-k triangle of array a is not referenced.
triangular band part of the matrix of coefficients, supplied column-by-column, with the leading
See the NOTES section for examples of Fortran code that transfer upper and lower triangular
band matrices from conventional full matrix storage to band storage.
When diag = ’U’ or ’u’, these routines assume that all elements of the array a that represent
diagonal elements of the matrix A are 1. In this case, neither of these routines will reference any
of the diagonal elements.
x STBMV: Real array of dimension 1+(n– 1) .  incx  . (input and output)
CTBMV: Complex array of dimension 1+(n– 1) .  incx  . (input and output)
Contains the vector x. On exit, the transformed vector overwrites array x.
NOTES
The following program segment transfers an upper triangular band matrix from conventional full matrix
storage to band storage:
DO 20, J = 1, N
M = K + 1 - J
DO 10, I = MAX ( 1, J - K ), J
A( M + I, J ) = MATRIX ( I, J )
10 CONTIN UE
20 CONTINUE
004– 2081– 002 119

The following program segment transfers a lower triangular band matrix from conventional full matrix
DO 20, J = 1, N
M = 1 - J
DO 10, I = J, MIN ( N, J + K )
A( M + I, J ) = MAT RIX ( I, J )
10 CON TIN UE
20 CON TIN UE
STBMV and CTBMV are Level 2 Basic Linear Algebra Subprograms (Level 2 BLAS).
follows:
x(1– incx . (n– 1)), x(1– incx . (n– 2)), . . ., x(1)
120 004– 2081– 002

STBSV ( 3S ) STBSV ( 3S )
NAME
STBSV, CTBSV – Solves a real or complex triangular banded system of equations
SYNOPSIS
CALL STBSV (uplo, trans, diag, n, k, a, lda, x, incx)
CALL CTBSV (uplo, trans, diag, n, k, a, lda, x, incx)
IMPLEMENTATION
DESCRIPTION
STBSV solves a real triangular banded system of equations.
CTBSV solves a complex triangular banded system of equations.
STBSV and CTBSV solve one of the following systems of equations, using the operation associated with
each:
Equations Operation
–1
Ax=b x←A x
T –T
A x=b x←A x
H –H
A x=b x←A x (CTBSV only)
where
• b and x are n-element vectors
• A is either a unit or nonunit n-by-n upper or lower triangular band matrix with (k+1) diagonals
–1
• A is the inverse of A
T
–T T
H
–H H
On input, the right-hand side vector b is stored in the array argument x. On output, the solution vector x
overwrites b in the same array argument x.
Specifies whether the matrix is an upper or lower triangular matrix, as follows:
004– 2081– 002 121


–1
trans = ’N’ or ’n’: x ← A x
–T
–T –H
trans = ’C’ or ’c’: x ← A x (STBSV), or x ← A x (CTBSV)
n Integer. (input)
k Integer. (input)
uplo = ’U’ or ’u’: k specifies the number of superdiagonals of matrix A.
uplo = ’L’ or ’l’: k specifies the number of subdiagonals of matrix A.
k ≥ 0.
a STBSV: Real array of dimension (lda,n). (input)
CTBSV: Complex array of dimension (lda,n). (input)
Before entry with uplo = ’U’ or ’u’, the leading (k+1)-by-n upper triangular part of array a must
contain the upper triangular band part of the matrix of coefficients, supplied column-by-column,
with the leading diagonal of the matrix in row (k+1) of the array, the first superdiagonal starting
at position 2 in row k, and so on. The top left k-by-k triangle of array a is not referenced.
triangular band part of the matrix of coefficients, supplied column-by-column, with the leading
When diag = ’U’ or ’u’, these routines assume that all elements of array a that represent
x STBSV: Real array of dimension 1+(n– 1) .  incx  . (input and output)
CTBSV: Complex array of dimension 1+(n– 1) .  incx  . (input and output)
Contains the vector x.
On input, x contains the right-hand side vector b. On output, the solution vector overwrites
array x.
122 004– 2081– 002


NOTES
The following program segment transfers an upper triangular band matrix from conventional full matrix
DO 20, J = 1, N
M = K + 1 - J
DO 10, I = MAX ( 1, J - K ), J
A( M + I, J ) = MATRIX ( I, J )
10 CONTIN UE
20 CONTINUE
The following program segment transfers a lower triangular band matrix from conventional full matrix
DO 20, J = 1, N
M = 1 - J
DO 10, I = J, MIN ( N, J + K )
A( M + I, J ) = MATRIX ( I, J )
10 CONTIN UE
20 CONTINUE
Tests for singularity or near-singularity are not included in STBSV or CTBSV. You must perform such tests
before calling these routines.
STBSV and CTBSV are Level 2 Basic Linear Algebra Subprograms (Level 2 BLAS).
follows:
x(1– incx . (n– 1)), x(1– incx . (n– 2)), . . ., x(1)
004– 2081– 002 123

STPMV ( 3S ) STPMV ( 3S )
NAME
STPMV, CTPMV – Multiplies a real or complex vector by a real or complex triangular packed matrix
SYNOPSIS
CALL STPMV (uplo, trans, diag, n, ap, x, incx)
CALL CTPMV (uplo, trans, diag, n, ap, x, incx)
IMPLEMENTATION
DESCRIPTION
STPMV and CTPMV perform one of the following matrix-vector operations:
x ← Ax
T
x←A x
H
x ← A x (CTPMV only)
T H
either a unit or nonunit n-by-n upper or lower triangular matrix.
T
T H
trans = ’C’ or ’c’: x ← A x (STPMV), or x ← A x (CTPMV)
diag Character*1. (input)
n Integer. (input)
124 004– 2081– 002

STPMV ( 3S ) STPMV ( 3S )
n (n +1)
ap STPMV: Real array of dimension . (input)
2
n (n +1)
CTPMV: Complex array of dimension . (input)
2
Before entry with uplo = ’U’ or ’u’, array ap must contain the upper triangular matrix packed
sequentially, column-by-column, so that ap(1) contains A(1,1), ap(2) contains A(1,2), ap(3)
contains A(2,2), and so on.
Before entry with uplo = ’L’ or ’l’, array ap must contain the lower triangular matrix packed
When diag = ’U’ or ’u’, these routines assume that all elements of the array a that represent
x STPMV: Real array of dimension 1+(n– 1) .  incx  . (input and output)
CTPMV: Complex array of dimension 1+(n– 1) .  incx  . (input and output)
NOTES
STPMV and CTPMV are Level 2 Basic Linear Algebra Subprograms (Level 2 BLAS).
follows:
x(1– incx . (n– 1)), x(1– incx . (n– 2)), . . ., x(1)
004– 2081– 002 125

STPSV ( 3S ) STPSV ( 3S )
NAME
STPSV, CTPSV – Solves a real or complex triangular packed system of equations
SYNOPSIS
CALL STPSV (uplo, trans, diag, n, ap, x, incx)
CALL CTPSV (uplo, trans, diag, n, ap, x, incx)
IMPLEMENTATION
DESCRIPTION
STPSV and CTPSV solve one of the following systems of equations, using the operation associated with
each:
Equations Operation
–1
Ax=b x←A x
T –T
A x=b x←A x
H –H
A x=b x←A x (CTPSV only)
where
• A is either a unit or nonunit n-by-n upper or lower triangular band matrix with (k+1) diagonals
–1
T
–T T
H
–H H
On input, the right-hand side vector b is stored in the array argument x. On output, the solution vector x
126 004– 2081– 002

STPSV ( 3S ) STPSV ( 3S )

–1
–T
–T –H
trans = ’C’ or ’c’: x ← A x (STPSV), or x ← A x (CTPSV)
n Integer. (input)
n (n +1)
ap STPSV: Real array of dimension . (input)
2
n (n +1)
CTPSV: Complex array of dimension . (input)
2
Before entry with uplo = ’U’ or ’u’, array ap must contain the upper triangular matrix packed
Before entry with uplo = ’L’ or ’l’, array ap must contain the lower triangular matrix packed
x STPSV: Real array of dimension 1+(n– 1) .  incx  . (input and output)
CTPSV: Complex array of dimension 1+(n– 1) .  incx  . (input and output)
Contains the vector b, then the vector x.
NOTES
Tests for singularity or near-singularity are not included in STPSV or CTPSV. You must perform such tests
before calling either routine.
STPSV and CTPSV are Level 2 Basic Linear Algebra Subprograms (Level 2 BLAS).
follows:
x(1– incx . (n– 1)), x(1– incx . (n– 2)), . . ., x(1)
004– 2081– 002 127

STRMV ( 3S ) STRMV ( 3S )
NAME
STRMV, CTRMV – Multiplies a real or complex vector by a real or complex triangular matrix
SYNOPSIS
CALL STRMV (uplo, trans, diag, n, a, lda, x, incx)
CALL CTRMV (uplo, trans, diag, n, a, lda, x, incx)
IMPLEMENTATION
DESCRIPTION
STRMV multiplies a real vector by a real triangular matrix.
CTRMV multiplies a complex vector by a complex triangular matrix.
STRMV and CTRMV perform one of the following matrix-vector operations:
x ← Ax
T
x←A x
H
x ← A x (CTRMV only)
T H
either a unit or nonunit n-by-n upper or lower triangular matrix.
Specifies whether the matrix is upper or lower triangular, as follows:
T
T H
trans = ’C’ or ’c’: x ← A x (STRMV), or x ← A x (CTRMV)
128 004– 2081– 002

STRMV ( 3S ) STRMV ( 3S )
n Integer. (input)
a STRMV: Real array of dimension (lda,n). (input)
CTRMV: Complex array of dimension (lda,n). (input)
contain the upper triangular matrix. The strictly lower triangular part of a is not referenced.
contain the lower triangular matrix. The strictly upper triangular part of a is not referenced.
diagonal elements of matrix A are 1. In this case, neither of these routines will reference any of
the diagonal elements.
Specifies the first dimension of a as declared in the calling program. lda must be at least
MAX(1,n).
x STRMV: Real array of dimension 1+(n– 1) .  incx  . (input and output)
CTRMV: Complex array of dimension 1+(n– 1) .  incx  . (input and output)
NOTES
STRMV and CTRMV are Level 2 Basic Linear Algebra Subprograms (Level 2 BLAS).
follows:
x(1– incx . (n– 1)), x(1– incx . (n– 2)), . . ., x(1)
004– 2081– 002 129

STRSV ( 3S ) STRSV ( 3S )
NAME
STRSV, CTRSV – Solves a real or complex triangular system of equations
SYNOPSIS
CALL STRSV (uplo, trans, diag, n, a, lda, x, incx)
CALL CTRSV (uplo, trans, diag, n, a, lda, x, incx)
IMPLEMENTATION
DESCRIPTION
STRSV solves a real triangular system of equations.
CTRSV solves a complex triangular system of equations.
STRSV and CTRSV solve one of the following systems of equations, using the operation associated with
each:
Equations Operation
–1
Ax=b x←A x
T –T
A x=b x←A x
H –H
A x=b x←A x (CTRSV only)
where
• A is either a unit or nonunit n-by-n upper or lower triangular matrix
–1
T
–T T
H
–H H
On input, the right-hand side vector b is stored in array argument x. On output, the solution vector x
130 004– 2081– 002


–1
–T
–T –H
trans = ’C’ or ’c’: x ← A x (STRSV), or x ← A x (CTRSV)
n Integer. (input)
a STRSV: Real array of dimension (lda,n). (input)
CTRSV: Complex array of dimension (lda,n). (input)
diagonal elements of matrix A are 1. In this case, neither of these routines will reference any of
the diagonal elements.
x STRSV: Real array of dimension 1+(n– 1) .  incx  . (input and output)
CTRSV: Complex array of dimension 1+(n– 1) .  incx  . (input and output)
On input, x contains the right-hand side vector b. On output, x is overwritten with the solution
vector x.
NOTES
Tests for singularity or near-singularity are not included in STRSV or CTRSV. You must perform such tests
before calling either routine.
004– 2081– 002 131

STRSV and CTRSV are Level 2 Basic Linear Algebra Subprograms (Level 2 BLAS).
follows:
x(1– incx . (n– 1)), x(1– incx . (n– 2)), . . ., x(1)
132 004– 2081– 002

NAME
INTRO_BLAS3 – Introduction to matrix-matrix linear algebra subprograms
IMPLEMENTATION
DESCRIPTION
The Level 3 Basic Linear Algebra Subprograms (Level 3 BLAS) consist of routines for unpacked real and
complex data. They handle matrix-matrix operations.
The following table describes these routines. If more than one routine name appears for a given block in the
table, the first name listed is the name of the man page that describes all routines listed in that block. For
complete information about each operation performed by the routine, see the individual man page for that
routine.
The table is in alphabetic order, except that each Hermitian matrix routine (any routine whose name begins
with CH) is grouped next to equivalent symmetric matrix routines (whose names begin with SS or CS). This
is because the Hermitian property is a type of symmetry.
Each routine in the table marked with an asterisk is an extension to the standard set of Level 3 BLAS
routines.
Copies a real matrix into another real B←A SCOPY2*

matrix; copies a complex matrix into CCOPY2*
another complex matrix (used by the
out-of-core routines only on
Cray Y-MP systems, see
INTRO_CORE(3S))
Multiplies a real general matrix by a C ← α op (A ) op (B ) + β C op (X ) = X or op (X ) = SGEMM
real general matrix; multiplies a X T or op (X ) = X H (CGEMM only) CGEMM
complex general matrix by a complex
general matrix
Multiplies a real general matrix by a C ← α op (A ) op (B ) + β C SGEMMS*
real general matrix, using a variation CGEMMS*
of Strassen’s algorithm; multiplies a
general matrix, using a variation of
Strassen’s algorithm
004– 2081– 002 133

Multiplies a real general matrix by a C ← α A B + β C or C ← α B A + β C SSYMM

real symmetric matrix; multiplies a CSYMM
symmetric matrix
Multiplies a complex general matrix by C ← αA B + βC C ← αB A + βC CHEMM
a Hermitian matrix
Performs symmetric rank 2k update of C ← α AB T + α BA T + β C SSYR2K
a real symmetric matrix; performs C ← αA T B + αB T A + βC CSYR2K
symmetric rank 2k update of a
complex symmetric matrix
Performs Hermitian rank 2k update of C ← αA B H + αB A H + βC CHER2K
a Hermitian matrix C ← αA H B + αB H A + βC
Performs symmetric rank k update of a C ← αA A T + βC C ← αA T A + βC SSYRK
real symmetric matrix; performs CSYRK
symmetric rank k update of a complex
symmetric matrix
Performs Hermitian rank k update of a C ← α A A H + β C or C ← α A H A + β C CHERK
Hermitian matrix
Multiplies a real general matrix by a B ← α op (A ) B B ← α B op (A ) STRMM
real triangular matrix; multiplies a CTRMM
triangular matrix
Solves a real triangular system of B ← α op (A −1) B B ← α B op (A −1) op (A ) = A or STRSM
equations with multiple right-hand op (A ) = A T or op (A ) = A H (CTRSM only) CTRSM
sides; solves a complex triangular
system of equations with multiple
right-hand sides
SEE ALSO
Dongarra, J., J. Du Croz, I. Duff, and S. Hammarling,"A Set of Level 3 Basic Linear Algebra Subprograms,"
ACM Transactions on Mathematical Software, Vol. 16, No. 1, March 1990, pp. 1 – 17.
134 004– 2081– 002

CHEMM ( 3S ) CHEMM ( 3S )
NAME
CHEMM – Multiplies a complex general matrix by a complex Hermitian matrix
SYNOPSIS
CALL CHEMM (side, uplo, m, n, alpha, a, lda, b, ldb, beta, c, ldc)
IMPLEMENTATION
DESCRIPTION
CHEMM multiplies a complex general matrix by a complex Hermitian matrix.
CHEMM performs one of the following matrix-matrix operations:
C ← αA B + βC
C ← αB A + βC
where α and β are scalars, A is a Hermitian matrix, and B and C are m-by-n matrices.
side Character*1. (input)
Specifies whether the Hermitian matrix A appears on the left or right in the operation, as
follows:
side = ’L’ or ’l’: C ← α A B + β C
side = ’R’ or ’r’: C ← α B A + β C
Specifies whether the upper or lower triangular part of the Hermitian matrix A is referenced, as
follows:
uplo = ’U’ or ’u’: only the upper triangular part of the Hermitian matrix is referenced.
uplo = ’L’ or ’l’: only the lower triangular part of the Hermitian matrix is referenced.
m Integer. (input)
Specifies the number of rows in matrix C. m must be ≥ 0.
n Integer. (input)
Specifies the number of columns in matrix C. n must be ≥ 0.
Scalar factor α.
a Complex array of dimension (lda,ka). (input)
Contains matrix A. When side = ’L’ or ’l’, ka is m; otherwise, it is n.
004– 2081– 002 135

Before entry with side = ’L’ or ’l’, the m-by-m part of array a must contain the Hermitian
matrix, such that:
• If uplo = ’U’ or ’u’, the leading m-by-m upper triangular part of array a must contain the
upper triangular part of the Hermitian matrix. The strictly lower triangular part of a is not
referenced.
• If uplo = ’L’ or ’l’, the leading m-by-m lower triangular part of array a must contain the
lower triangular part of the Hermitian matrix. The strictly upper triangular part of a is not
referenced.
Before entry with side = ’R’ or ’r’, the n-by-n part of array a must contain the Hermitian matrix,
such that:
• If uplo = ’U’ or ’u’, the leading n-by-n upper triangular part of array a must contain the
upper triangular part of the Hermitian matrix. The strictly lower triangular part of a is not
referenced.
• If uplo = ’L’ or ’l’, the leading n-by-n lower triangular part of array a must contain the lower
triangular part of the Hermitian matrix. The strictly upper triangular part of a is not
referenced.
The imaginary parts of the diagonal elements need not be set. They are assumed to be 0.
Specifies the first dimension of a as declared in the calling program. When side = ’L’ or ’l’, lda
≥ MAX(1,m); otherwise, lda ≥ MAX(1,n).
b Complex array of dimension (ldb,n). (input)
Contains matrix B. Before entry, the leading m-by-n part of array b must contain matrix B.
Specifies the first dimension of b as declared in the calling program. ldb ≥ MAX(1,m).
Scalar factor β. When beta is supplied as 0, c need not be set on input.
c Complex array of dimension (ldc,n). (input and output)
Contains matrix C.
Before entry, the leading m-by-n part of array c must contain matrix C, except when beta is 0; in
which case, c need not be set. On exit, the m-by-n updated matrix overwrites array c.
ldc Integer. (input)
Specifies the first dimension of c as declared in the calling program. ldc ≥ MAX(1,m).
136 004– 2081– 002

NOTES
CHEMM is a Level 3 Basic Linear Algebra Subprogram (Level 3 BLAS).
SEE ALSO
SSYMM(3S)
004– 2081– 002 137

CHER2K ( 3S ) CHER2K ( 3S )
NAME
CHER2K – Performs Hermitian rank 2k update of a complex Hermitian matrix
SYNOPSIS
CALL CHER2K (uplo, trans, n, k, alpha, a, lda, b, ldb, beta, c, ldc)
IMPLEMENTATION
DESCRIPTION
CHER2K performs a Hermitian rank 2k update of a complex Hermitian matrix.
CHER2K performs one of the following Hermitian rank 2k operations:
H H
C ← α AB + α BA + β C
H H
C ← α A B + α B A + βC
where the following is true:
• α and β are scalars;
H H
• A H and B are the conjugate transposes of A and B, respectively;
• C is an n-by-n Hermitian matrix;
• A and B and A and B are n-by-k matrices in the first operation listed previously, and k-by-n matrices in
the second.
Specifies whether the upper or lower triangular part of array c is referenced, as follows:
uplo = ’U’ or ’u’: only the upper triangular part of c is referenced.
uplo = ’L’ or ’l’: only the lower triangular part of c is referenced.
H H
trans = ’N’ or ’n’: C ← α AB + α BA + β C
H H
trans = ’C’ or ’c’: C ← α A B + α B A + βC
n Integer. (input)
Specifies the order of matrix C. n must be ≥ 0.
k Integer. (input)
On entry with trans = ’N’ or ’n’, k specifies the number of columns of matrices A and B.
138 004– 2081– 002

On entry with trans = ’C’ or ’c’, k specifies the number of rows of matrices A and B.
k must be ≥ 0.
Scalar factor α.
When trans = ’N’ or ’n’, ka is k; otherwise, it is n. Contains matrix A.
Before entry with trans = ’N’ or ’n’, the leading n-by-k part of array a must contain matrix A;
otherwise, the leading k-by-n part of array a must contain matrix A.
If trans = ’N’ or ’n’, lda ≥ MAX(1,n); otherwise, lda ≥ MAX(1,k).
b Complex array of dimension (ldb,kb). (input)
When trans = ’N’ or ’n’, kb is k; otherwise, it is n. Contains matrix B.
Before entry with trans = ’N’ or ’n’, the leading n-by-k part of array b must contain matrix B;
otherwise, the leading k-by-n part of array b must contain matrix B.
Specifies the first dimension of b as declared in the calling program. If trans = ’N’ or ’n’, ldb ≥
MAX(1,n); otherwise, ldb ≥ MAX(1,k).
beta Real. (input)
Scalar factor α.
c Complex array of dimension (ldc,n). (input)
Contains matrix C.
Before entry with uplo = ’U’ or ’u’, the leading n-by-n upper triangular part of array c must
contain the upper triangular part of the Hermitian matrix. The strictly lower triangular part of c
triangular part of array c.
Before entry with uplo = ’L’ or ’l’, the leading n-by-n lower triangular part of array c must
contain the lower triangular part of the Hermitian matrix. The strictly upper triangular part of c
The imaginary parts of the diagonal elements need not be set and are assumed to be 0. On exit,
they are set to 0.
Specifies the first dimension of c as declared in the calling program. ldc ≥ MAX(1,n).
004– 2081– 002 139

NOTES
CHER2K is a Level 3 Basic Linear Algebra Subprogram (Level 3 BLAS).
SEE ALSO
SSYR2K(3S)
140 004– 2081– 002

CHERK ( 3S ) CHERK ( 3S )
NAME
CHERK – Performs Hermitian rank k update of a complex Hermitian matrix
SYNOPSIS
CALL CHERK (uplo, trans, n, k, alpha, a, lda, beta, c, ldc)
IMPLEMENTATION
DESCRIPTION
CHERK performs a Hermitian rank k update of a complex Hermitian matrix.
CHERK performs one of the following Hermitian rank k operations:
H
C ← α AA + β C
H
C←αA A+β C
where the following is true:
• α and β are scalars;
H
• A is the conjugate transpose of A.
• C is an n-by-n Hermitian matrix;
• A is an n-by-k matrix in the first operation listed previously, and a k-by-n matrix in the second.
H
trans = ’N’ or ’n’: C ← α AA + β C
H
trans = ’C’ or ’c’: C ← α A A + β C
n Integer. (input)
k Integer. (input)
004– 2081– 002 141

CHERK ( 3S ) CHERK ( 3S )
On entry with trans = ’N’ or ’n’, k specifies the number of columns of matrix A.
On entry with trans = ’C’ or ’c’, k specifies the number of rows of matrix A.
k must be ≥ 0.
alpha Real. (input)
Scalar factor α.
When trans = ’N’ or ’n’, ka is k; otherwise, it is n. Contains matrix A.
Specifies the first dimension of a as declared in the calling program. If trans = ’N’ or ’n’, lda ≥
MAX(1,n); otherwise, lda ≥ MAX(1,k).
beta Real. (input)
Scalar factor β.
c Complex array of dimension (ldc,n). (input and output) Contains matrix C.
contain the upper triangular part of the Hermitian matrix. The strictly lower triangular part of c
contain the lower triangular part of the Hermitian matrix. The strictly upper triangular part of c
The imaginary parts of the diagonal elements need not be set and are assumed to be 0. On exit,
they are set to 0.
Specifies the first dimension of c as declared in the calling (sub)program. ldc ≥ MAX(1,n).
NOTES
CHERK is a Level 3 Basic Linear Algebra Subprogram (Level 3 BLAS).
SEE ALSO
SSYRK(3S)
142 004– 2081– 002

SCOPY2 ( 3S ) SCOPY2 ( 3S )
NAME
SCOPY2, CCOPY2 – Copies a real or complex matrix into another real or complex matrix
SYNOPSIS
CALL SCOPY2 (m, n, a, lda, b, ldb)
CALL CCOPY2 (m, n, a, lda, b, ldb)
IMPLEMENTATION
UNICOS systems
DESCRIPTION
SCOPY2 copies a real matrix into another real matrix.
CCOPY2 copies a complex matrix into another complex matrix.
SCOPY2 and CCOPY2 perform the following matrix operation:
B←A
where A and B are real or complex matrices.
m Integer. (input)
Number of rows of A and B.
n Integer. (input)
Number of columns of A and B.
a SCOPY2: Real array of dimension (lda,n). (input)
CCOPY2: Complex array of dimension (lda,n). (input)
Contains matrix from which to copy.
Leading dimension of array a.
b SCOPY2: Real array of dimension (ldb,n). (output)
CCOPY2: Complex array of dimension (ldb,n). (output)
Contains matrix into which to copy.
Leading dimension of array b.
004– 2081– 002 143

SCOPY2 ( 3S ) SCOPY2 ( 3S )
NOTES
SCOPY2 and CCOPY2 are extensions to the standard set of Level 3 Basic Linear Algebra Subprograms
(Level 3 BLAS). They are matrix analogues of the Level 1 BLAS vector copy routines SCOPY(3S) and
CCOPY(3S).
The 2 in the routine name means "two-dimensional."
This routine vectorizes along the rows or columns, whichever is longer, and processes the other direction in
parallel.
SEE ALSO
CCOPY(3S), SCOPY(3S), SGESUM(3S)
144 004– 2081– 002

SGEMM ( 3S ) SGEMM ( 3S )
NAME
SGEMM, CGEMM – Multiplies a real or complex general matrix by a real or complex general matrix
SYNOPSIS
CALL SGEMM (transa, transb, m, n, k, alpha, a, lda, b, ldb, beta, c, ldc)
CALL CGEMM (transa, transb, m, n, k, alpha, a, lda, b, ldb, beta, c, ldc)
IMPLEMENTATION
DESCRIPTION
SGEMM multiplies a real general matrix by a real general matrix.
CGEMM multiplies a complex general matrix by a complex general matrix.
SGEMM and CGEMM perform one of the matrix-matrix operations:
C ←α op(A) op(B) + β C
where op(X) is one of the following:
op(X) = X
T
op(X) = X
H
op(X) = X (CGEMM only)
where
• α and β are scalars
• A, B, and C are matrices
• op(A) is an m-by-k matrix
• op(B) is a k-by-n matrix
• C is an m-by-n matrix.
T
• X is the transpose of x
H
• X is the conjugate transpose of X.
004– 2081– 002 145

transa Character*1. (input)

Specifies the form of op (A ) to be used in the matrix multiplication, as follows:
transa = ’N’ or ’n’: op(A) = A
T
transa = ’T’ or ’t’: op(A) = A
T H
transa = ’C’ or ’c’, op(A) = A (SGEMM), or op(A) = A (CGEMM)
transb Character*1. (input)
Specifies the form of op(B) to be used in the matrix multiplication, as follows:
transb = ’N’ or ’n’: op(B) = B
T
transb = ’T’ or ’t’: op(B) = B
T H
transb = ’C’ or ’c’: op(B) = B (SGEMM), or op(B) = B (CGEMM)
m Integer. (input)
Specifies the number of rows in matrix op(A) and in matrix C. m must be ≥ 0.
n Integer. (input)
Specifies the number of columns in matrix op(B) and in matrix C. n must be ≥ 0.
k Integer. (input)
Specifies the number of columns of matrix op(A) and the number of rows of matrix op(B). k
must be ≥ 0.
alpha SGEMM: Real. (input)
CGEMM: Complex. (input)
Scalar factor α.
a SGEMM: Real array of dimension (lda,ka). (input)
CGEMM: Complex array of dimension (lda,ka). (input)
When transa = ’N’ or ’n’, ka is k; otherwise, it is m. Contains the matrix A.
Before entry with transa = ’N’ or ’n’, the leading m-by-k part of array a must contain matrix A;
otherwise, the leading k-by-m part of array a must contain matrix A.
When transa = ’N’ or ’n’, lda ≥ MAX(1,m); otherwise, lda ≥ MAX(1,k).
b SGEMM: Real array of dimension (ldb,kb). (input)
CGEMM: Complex array of dimension (ldb,kb). (input)
When transb = ’N’ or ’n’, kb is n; otherwise, it is k. Contains the matrix B.
Before entry with transb = ’N’ or ’n’, the leading k-by-n part of array b must contain matrix B;
otherwise, the leading n-by-k part of array b must contain matrix B.
Specifies the first dimension of b as declared in the calling program. When transb = ’N’ or ’n’,
ldb ≥ MAX(1,k); otherwise, ldb ≥ MAX(1,n).
146 004– 2081– 002

beta SGEMM: Real. (input)

CGEMM: Complex. (input)
c SGEMM: Real array of dimension (ldc,n). (input and output)
CGEMM: Complex array of dimension (ldc,n). (input and output)
Contains the matrix C.
which case, c need not be set. On exit, the m-by-n result matrix overwrites array c.
NOTES
SGEMM and CGEMM are Level 3 Basic Linear Algebra Subprograms (Level 3 BLAS).
SEE ALSO
SGEMMS(3S) to multiply general matrices by using Strassen’s algorithm
004– 2081– 002 147

SGEMMS ( 3S ) SGEMMS ( 3S )
NAME
SGEMMS, CGEMMS – Multiplies a real or complex general matrix by a real or complex general matrix, using
Strassen’s algorithm
SYNOPSIS
UNICOS systems:
CALL SGEMMS (transa, transb, m, n, k, alpha, a, lda, b, ldb, beta, c, ldc, work)
CALL CGEMMS (transa, transb, m, n, k, alpha, a, lda, b, ldb, beta, c, ldc, work)
UNICOS/mk systems:
CALL SGEMMS (transa, transb, m, n, k, alpha, a, lda, b, ldb, beta, c, ldc)
CALL CGEMMS (transa, transb, m, n, k, alpha, a, lda, b, ldb, beta, c, ldc)
IMPLEMENTATION
DESCRIPTION
SGEMMS multiplies a real general matrix by a real general matrix. CGEMMS multiplies a complex general
matrix by a complex general matrix.
SGEMMS and CGEMMS are implementations of the Winograd’s variation of Strassen’s algorithm for matrix
multiplication. The algorithm is descibed in the NOTES section of this man page. Because of the very
different order of operations performed by the Strassen’s algorithm, numerical results from SGEMMS and
CGEMMS may differ slightly from those of SGEMM and CGEMM.
On UNICOS systems, these routines are functionally equivalent to SGEMM and CGEMM except for the
addditional argument, work.
On UNICOS/mk systems, SGEMMS and CGEMMS are functionally equivalent to SGEMM and CGEMM except
for the following:
• m, n, k must be greater than 0.
• transa and transb = ’C’ or ’c’ is invalid in SGEMMS.
The UNICOS/mk version of these routines requires a workspace which is allocated, managed, and freed by
the routines.
SGEMMS and CGEMMS perform one of the matrix-matrix operations:
C ← α op (A ) op (B ) + β C
where op(X) is one of the following:
148 004– 2081– 002

op(X) = X
T
op(X) = X
H
op(X) = X (CGEMMS only)
where
• A, B, and C are matrices
• op(A) is an m-by-k matrix
• op(B) is a k-by-n matrix
• C is an m-by-n matrix
T
• X is the transpose of x
H
• X is the conjugate transpose of X.
Specifies the form of op(A) to be used in the matrix multiplication, as follows:
If transa = ’N’ or ’n’, op(A) = A
T
If transa = ’T’ or ’t’, op(A) = A
T H
In the UNICOS version, if transa = ’C’ or ’c’, op(A) = A (SGEMMS) or op(A) = A (CGEMMS)
H
In the UNICOS/mk version, if transa = ’C’ or ’c’, op(A) = A
transb Character*1. (input)
Specifies the form of op(B) to be used in the matrix multiplication, as follows:
If transb = ’N’ or ’n’, op(B) = B
T
If transb = ’T’ or ’t’, op(B) = B
T H
In the UNICOS version, if transb = ’C’ or ’c’: op(B) = B (SGEMMS) or op(B) = B (CGEMMS)
H
In the UNICOS/mk version, if transb = ’C’ or ’c’, op(B) = B
m Integer. (input)
Specifies the number of rows in matrix op(A) and in matrix C. m must be ≥ 0 on UNICOS
systems; m must be ≥ 1 for UNICOS/mk systems..
n Integer. (input)
Specifies the number of columns in matrix op(B) and in matrix C. n must be ≥ 0 for UNICOS
systems; n must be ≥ 1 for UNICOS/mk systems.
k Integer. (input)
Specifies the number of columns of matrix op(A) and the number of rows of matrix op(B). k
must be ≥ 0 for UNICOS systems; k must be ≥ 1 for UNICOS/mk systems.
004– 2081– 002 149

alpha SGEMMS: Real. (input)

CGEMMS: Complex. (input)
Scalar factor α.
a SGEMMS: Real array of dimension (lda,ka). (input)
CGEMMS: Complex array of dimension (lda,ka). (input)
When transa = ’N’ or ’n’, ka is k; otherwise, it is m. Contains the matrix A.
Before entry with transa = ’N’ or ’n’, the leading m-by-k part of array a must contain matrix A;
otherwise, the leading k-by-m part of array a must contain matrix A.
Specifies the first dimension of a as declared in the calling (sub)program. When transa = ’N’ or
’n’, lda ≥ MAX(1,m); otherwise, lda ≥ MAX(1,k).
b SGEMMS: Real array of dimension (ldb,kb). (input)
CGEMMS: Complex array of dimension (ldb,kb). (input)
When transb = ’N’ or ’n’, kb is n; otherwise, it is k. Contains the matrix B.
Before entry with transb = ’N’ or ’n’, the leading k-by-n part of array b must contain matrix B;
otherwise, the leading n-by-k part of array b must contain matrix B.
Specifies the first dimension of b as declared in the calling (sub)program.
When transb = ’N’ or ’n’, ldb ≥ MAX(1,k); otherwise, ldb ≥ MAX(1,n).
beta SGEMMS: Real. (input)
CGEMMS: Complex. (input)
c SGEMMS: Real array of dimension (ldc,n). (input and output)
CGEMMS: Complex array of dimension (ldc,n). (input and output)
which case, c need not be set. On exit, the m-by-n result matrix overwrites array c.
Specifies the first dimension of c as declared in the calling (sub)program. ldc ≥ MAX(1,m).
work User-allocated workspace required only in UNICOS version.
UNICOS SGEMMS: Real array of dimension 2.34 . MAX (m ,k ) . MAX (k ,n ).
UNICOS CGEMMS: Complex array of dimension 2.34 . MAX (m ,k ) . MAX (k ,n ).
On exit, work is overwritten.
150 004– 2081– 002

NOTES
SGEMMS and CGEMMS are extensions to the standard Level 3 Basic Linear Algebra Subprograms (Level 3
BLAS).
Strassen’s Algorithm
Strassen’s algorithm for matrix multiplication is a complex, recursive algorithm that performs the
multiplication in a manner completely different from the usual inner product method.
Suppose you want to multiply a pair of square matrices of order n. The typical inner product method for
matrix multiplication has an operations count on the order of n 3; the operations count for Strassen’s
2.8
algorithm is on the order of n . The trade-off is that Strassen’s algorithm requires an auxiliary work space.
The UNICOS implementations of SGEMMS and CGEMMS require an array work, supplied by the calling
program, of the following size (or equivalently, a real array of twice this dimension for CGEMMS):
2.34*MAX(m,k)*MAX(k,n)
The work array is overwritten, and no diagnostic is given if the supplied array is too small.
For small problem sizes of dimensions less than or equal to 128 on UNICOS systems and 360 on
UNICOS/mk systems, SGEMMS and CGEMMS call SGEMM and CGEMM, respectively, to compute the matrix
multiply. Only when the problem sizes are larger than the dimensions indicated above is the Strassen’s
algorithm used. Because of the very different order of operations carried out by Strassen’s algorithm,
numerical results of SGEMMS and CGEMMS may differ slightly from those of SGEMM and CGEMM.
SEE ALSO
SGEMM(3S) to multiply general matrices by using the more standard inner product algorithm
004– 2081– 002 151

SSYMM ( 3S ) SSYMM ( 3S )
NAME
SSYMM, CSYMM – Multiplies a real or complex general matrix by a real or complex symmetric matrix
SYNOPSIS
CALL SSYMM (side, uplo, m, n, alpha, a, lda, b, ldb, beta, c, ldc)
CALL CSYMM (side, uplo, m, n, alpha, a, lda, b, ldb, beta, c, ldc)
IMPLEMENTATION
DESCRIPTION
SSYMM multiplies a real general matrix by a real symmetric matrix.
CSYMM multiplies a complex general matrix by a complex symmetric matrix.
SSYMM and CSYMM perform one of the following matrix-matrix operations:
C ← α AB + β C
where α and β are scalars, A is a symmetric matrix, and B and C are m-by-n matrices.
Specifies whether the symmetric matrix A appears on the left or right in the operation, as
follows:
side = ’L’ or ’l’: C ← α A B + β C
side = ’R’ or ’r’; C ← α B A + β C
Specifies whether the upper or lower triangular part of the symmetric matrix A is referenced, as
follows:
uplo = ’U’ or ’u’: only the upper triangular part of the symmetric matrix is referenced.
uplo = ’L’ or ’l’: only the lower triangular part of the symmetric matrix is referenced.
m Integer. (input)
Specifies the number of rows in matrix C. m must be ≥ 0.
n Integer. (input)
Specifies the number of columns in matrix C. n must be ≥ 0.
alpha SSYMM: Real. (input)
CSYMM: Complex. (input)
Scalar factor α.
152 004– 2081– 002

a SSYMM: Real array of dimension (lda,ka). (input)

CSYMM: Complex array of dimension (lda,ka). (input)
When side = ’L’ or ’l’, ka is m; otherwise, it is n. Contains the matrix A.
Before entry with side = ’L’ or ’l’, the m-by-m part of array a must contain the symmetric
matrix A, such that:
• If uplo = ’U’ or ’u’, the leading m-by-m upper triangular part of array a must contain the
upper triangular part of the symmetric matrix. The strictly lower triangular part of a is not
referenced.
• If uplo = ’L’ or ’l’, the leading m-by-m lower triangular part of array a must contain the
lower triangular part of the symmetric matrix. The strictly upper triangular part of a is not
referenced.
Before entry with side = ’R’ or ’r’, the n-by-n part of array a must contain the symmetric matrix
A, such that:
• If uplo = ’U’ or ’u’, the leading n-by-n upper triangular part of array a must contain the
upper triangular part of the symmetric matrix. The strictly lower triangular part of a is not
referenced.
• If uplo = ’L’ or ’l’, the leading n-by-n lower triangular part of array a must contain the lower
triangular part of the symmetric matrix. The strictly upper triangular part of a is not
referenced.
Specifies the first dimension of a as declared in the calling program. When side = ’L’ or ’l’, lda
≥ MAX(1,m); otherwise, lda ≥ MAX(1,n).
b SSYMM: Real array of dimension (ldb,n). (input)
CSYMM: Complex array of dimension (ldb,n). (input)
Contains the matrix B. Before entry, the leading m-by-n part of array b must contain matrix B.
beta SSYMM: Real. (input)
CSYMM: Complex. (input)
c SSYMM: Real array of dimension (ldc,n). (input and output)
CSYMM: Complex array of dimension (ldc,n). (input and output)
Contains the matrix C. Before entry, the leading m-by-n part of array c must contain matrix C,
except when beta is 0; in which case, c need not be set. On exit, the m-by-n updated matrix
overwrites array c.
004– 2081– 002 153

NOTES
SSYMM and CSYMM are Level 3 Basic Linear Algebra Subprograms (Level 3 BLAS).
SEE ALSO
CHEMM(3S)
154 004– 2081– 002

SSYR2K ( 3S ) SSYR2K ( 3S )
NAME
SSYR2K, CSYR2K – Performs symmetric rank 2k update of a real or complex symmetric matrix
SYNOPSIS
CALL SSYR2K (uplo, trans, n, k, alpha, a, lda, b, ldb, beta, c, ldc)
CALL CSYR2K (uplo, trans, n, k, alpha, a, lda, b, ldb, beta, c, ldc)
IMPLEMENTATION
DESCRIPTION
SSYR2K performs a symmetric rank 2k update of a real symmetric matrix.
CSYR2K performs a symmetric rank 2k update of a complex symmetric matrix.
SSYR2K and CSYR2K perform one of the following symmetric rank 2k operations:
T T
C ← α AB + α BA + β C
T T
C←αA B+αB A+βC
where
• C is an n-by-n symmetric matrix
• A and B are n-by-k matrices in the first operation listed previously and k-by-n matrices in the second
T T
• A and B are transposes of A and B, respectively
T T
trans = ’N’ or ’n’: C ← α AB + α BA + β C
T T
trans = ’T’ or ’t’:C ← α A B + α B A + β C
n Integer. (input)
k Integer. (input)
004– 2081– 002 155

On entry with trans = ’N’ or ’n’, k specifies the number of columns of matrices A and B.
On entry with trans = ’T’ or ’t’, k specifies the number of rows of matrices A and B.
k must be ≥ 0.
alpha SSYR2K: Real. (input)
CSYR2K: Complex. (input) Scalar factor α.
a SSYR2K: Real array of dimension (lda,ka). (input)
CSYR2K: Complex array of dimension (lda,ka). (input)
When trans = ’N’ or ’n’, ka is k; otherwise, it is n. Contains the matrix A.
b SSYR2K: Real array of dimension (ldb,kb). (input)
CSYR2K: Complex array of dimension (ldb,kb). (input)
When trans = ’N’ or ’n’, kb is k; otherwise, it is n. Contains the matrix B.
Before entry with trans = ’N’ or ’n’, the leading n-by-k part of array b must contain matrix B;
otherwise, the leading k-by-n part of array b must contain matrix B.
Specifies the first dimension of b as declared in the calling program. If trans = ’N’ or ’n’, ldb ≥
MAX(1,n); otherwise, ldb ≥ MAX(1,k).
beta SSYR2K: Real. (input)
CSYR2K: Complex. (input)
Scalar factor β.
c SSYR2K: Real array of dimension (ldc,n). (input and output)
CSYR2K: Complex array of dimension (ldc,n). (input and output)
contain the upper triangular part of the symmetric matrix. The strictly lower triangular part of c
contain the lower triangular part of the symmetric matrix. The strictly upper triangular part of c
156 004– 2081– 002

NOTES
SSYR2K and CSYR2K are Level 3 Basic Linear Algebra Subprograms (Level 3 BLAS).
SEE ALSO
CHER2K(3S)
004– 2081– 002 157

SSYRK ( 3S ) SSYRK ( 3S )
NAME
SSYRK, CSYRK – Performs symmetric rank k update of a real or complex symmetric matrix
SYNOPSIS
CALL SSYRK (uplo, trans, n, k, alpha, a, lda, beta, c, ldc)
CALL CSYRK (uplo, trans, n, k, alpha, a, lda, beta, c, ldc)
IMPLEMENTATION
DESCRIPTION
SSYRK performs a symmetric rank k update of a real symmetric matrix.
CSYRK performs a symmetric rank k update of a complex symmetric matrix.
SSYRK and CSYRK perform one of the following symmetric rank k operations:
T
C ← α AA + β C
T
C←αA A+βC
T
where A is the transpose of A; α and β are scalars; C is an n-by-n symmetric matrix; A is an n-by-k matrix
in the first operation listed previously, and a k-by-n matrix in the second.
trans = ’N’ or ’n’: C ← α A A T + β C
trans = ’T’ or ’t’: C ← α A T A + β C
n Integer. (input)
k Integer. (input)
On entry with trans = ’N’ or ’n’, k specifies the number of columns of matrix A.
On entry with trans = ’T’ or ’t’, k specifies the number of rows of matrix A.
k must be ≥ 0.
158 004– 2081– 002

SSYRK ( 3S ) SSYRK ( 3S )
alpha SSYRK: Real. (input)

CSYRK: Complex. (input)
Scalar factor α.
a SSYRK: Real array of dimension (lda,ka). (input)
CSYRK: Complex array of dimension (lda,ka). (input)
When transa = ’N’ or ’n’, ka is k; otherwise, it is n. Contains the matrix A.
beta SSYRK: Real. (input)
CSYRK: Complex. (input)
Scalar factor β.
c SSYRK: Real array of dimension (ldc,n). (input and output)
CSYRK: Complex array of dimension (ldc,n). (input and output)
Contains the matrix C. Before entry with uplo = ’U’ or ’u’, the leading n-by-n upper triangular
part of array c must contain the upper triangular part of the symmetric matrix. The strictly
lower triangular part of c is not referenced. On exit, the upper triangular part of the updated
matrix overwrites the upper triangular part of array c.
contain the lower triangular part of the symmetric matrix. The strictly upper triangular part of c
NOTES
SSYRK and CSYRK are Level 3 Basic Linear Algebra Subprograms (Level 3 BLAS).
SEE ALSO
CHERK(3S)
004– 2081– 002 159

STRMM ( 3S ) STRMM ( 3S )
NAME
STRMM, CTRMM – Multiplies a real or complex general matrix by a real or complex triangular matrix
SYNOPSIS
CALL STRMM (side, uplo, transa, diag, m, n, alpha, a, lda, b, ldb)
CALL CTRMM (side, uplo, transa, diag, m, n, alpha, a, lda, b, ldb)
IMPLEMENTATION
DESCRIPTION
STRMM multiplies a real general matrix by a real triangular matrix.
CTRMM multiplies a complex general matrix by a complex triangular matrix.
STRMM and CTRMM perform one of the matrix-matrix operations:
B ←α op(A) B
B ←α B op(A)
where α is a scalar; B is an m-by-n matrix; A is either a unit or nonunit upper or lower triangular matrix,
and op(A) is one of the following:
• op(A) = A
• op(A) = A T
• op(A) = A H (CTRMM only)
where
• A T is the transpose of A
• A H is the conjugate transpose of A.
Specifies whether op (A ) multiplies B from the left or right, as follows:
side = ’L’ or ’l’: B ← α op (A ) B
side = ’R’ or ’r’: B ← α B op (A )
Specifies whether matrix A is an upper or lower triangular matrix, as follows:
160 004– 2081– 002


Specifies the form of op(A) to be used in the matrix multiplication, as follows:
transa = ’N’ or ’n’: op(A) = A
T
transa = ’T’ or ’t’, op(A) = A
T H
transa = ’C’ or ’c’: op(A) = A (STRMM), or op(A) = A (CTRMM)
m Integer. (input)
Specifies the number of rows in B. m must be ≥ 0.
n Integer. (input)
Specifies the number of columns in B. n must be ≥ 0.
alpha STRMM: Real. (input)
CTRMM: Complex. (input)
Scalar factor α. When alpha is 0, a is not referenced and b need not be set before entry.
a STRMM: Real array of dimension (lda,k). (input)
CTRMM: Complex array of dimension (lda,k). (input)
When side = ’L’ or ’l’, k is m; when side = ’R’ or ’r’, k is n. Contains the matrix A.
Before entry with uplo = ’U’ or ’u’, the leading k-by-k upper triangular part of array a must
Before entry with uplo = ’L’ or ’l’, the leading k-by-k lower triangular part of array a must
When diag = ’U’ or ’u’, the diagonal elements of a are not referenced, but they are assumed to
be unity.
When side = ’L’ or ’l’, lda ≥ MAX(1,m). When side = ’R’ or ’r’, lda ≥ MAX(1,n).
b STRMM: Real array of dimension (ldb,n). (input and output)
CTRMM: Complex array of dimension (ldb,n). (input and output)
Contains the matrix B.
Before entry, the leading m-by-n part of array b must contain matrix B. On exit, the transformed
matrix overwrites array b.
004– 2081– 002 161

NOTES
STRMM and CTRMM are Level 3 Basic Linear Algebra Subprograms (Level 3 BLAS).
162 004– 2081– 002

INTRO_FFT ( 3S ) INTRO_FFT ( 3S )
NAME
INTRO_FFT – Introduction to signal processing routines
IMPLEMENTATION
DESCRIPTION
The signal processing routines consist of Fast Fourier Transform (FFT) routines, filter routines, and
convolution routines.
Fast Fourier Transform Routines
These routines apply to one or more FFTs. The Standard FFT package, available only on UNICOS systems,
is discussed first. Then the superseded FFT routines, available on all Cray vector architectures, are
discussed.
Standard FFT package (UNICOS systems)
The following is a matrix of preferred FFT routines. These routines are preferred because they have more
functionality, are more generally applicable, and are more fully optimized than the superseded routines that
follow them. Each of these routines is multitasked, but they also are highly optimized for single-processor
use. Each routine can compute either a forward or inverse Fourier transform.
In this matrix, columns of the matrix represent input and output data types for the routines in each column:
• Complex-to-complex implies complex input and output. In this column, the routine name in parentheses
is the name of the equivalent UNICOS routine, which is provided in this release for backward
compatibility. Each routine named in this column has a man page in this section.
• Real-to-complex implies real input and complex output. Each routine named in this column has a man
page in this section.
• Complex-to-real implies complex input and real output. Each routine named in this column is
documented with the real-to-complex routine in the same row.
Rows of the matrix represent the number of dimensions for which the FFT is calculated for the routines in
each row:
• One-dimensional (single) calculates one FFT in one dimension.
• One-dimensional (multiple) calculates an FFT in one dimension for each column of a two-dimensional
matrix.
• Two-dimensional calculates one FFT in two dimensions.
• Three-dimensional calculates one FFT in three dimensions.
Those routines marked with an asterisk (*) are available on UNICOS/mk systems only.
004– 2081– 002 163

Dimensions Complex-to-complex Real-to-complex Complex-to-real
One-dimensional CCFFT (CFFT) SCFFT CSFFT

(single)
One-dimensional CCFFTM (MCFFT) SCFFTM CSFFTM
(multiple)
Two-dimensional CCFFT2D SCFFT2D CSFFT2D
(CFFT2D) PSCFFT2D* PCSFFT2D*
PCCFFT2d*
Three-dimensional CCFFT3D SCFFT3D CSFFT3D
(CFFT3D) PSCFFT3d* PCSFFT3D*
PCCFFT3D*
Superseded FFT routines

The following is a matrix of superseded FFT routines. Each routine has its own man page.
The columns of the matrix represent data types, as in the previous matrix. The rows of the matrix represent
the number of FFTs calculated by the routines in each row:
• Single calculates one FFT
• Multiple calculates an FFT for each column of a two-dimensional matrix
No two- and three-dimensional FFT routines are included among the superseded routines.
Number of
FFTs Complex-to-complex Real-to-complex Complex-to-real
Single CFFT2 SCFFT2 CSFFT2

Multiple CFFTMLT RFFTMLT RFFTMLT
(forward transform (inverse transform
only) only)
164 004– 2081– 002

Linear Digital Filter Routines

These filter routines are used for filter analysis and design, but they also solve more general problems. The
following table contains a summary of the filter routines. Each routine has its own man page.
Purpose Name
Computes a correlation of two vectors FILTERG

Computes a correlation of two vectors (assuming the filter FILTERS
coefficient vector is symmetric)
Solves the Weiner-Levinson linear equations OPFILT
Convolution Routines
The convolution routines compute the convolution of a complex sequence with one or more other complex
sequences. The following table contains a summary of the convolution routines. Each routine has its own
man page.
Purpose Name
Computes a standard complex convolution CCNVL

Computes a convolution using FFTs CCNVLF
UNICOS/mk Routines
These routines run only on UNICOS/mk systems. Each routine has its own man page.
Purpose Name
Performs the convolution of two sequences of real numbers SCONV

Performs the correlation of two sequences of real numbers SCORR
Performs the correlation of two sequences of real numbers SCORRS
(symmetric filter)
32-bit UNICOS/mk routines
Purpose Name
Applies a multitasked complex-to-complex FFT GGFFT

Performs the convolution of two sequences of real numbers HCONV
Performs the correlation of two sequences of real numbers HCORR
004– 2081– 002 165

Purpose Name
Performs the correlation of two sequences of real numbers HCORRS

Computes a real-to-complex or complex-to-real FFT HGFFT
GHFFT
Solves Weiner-Levinson linear equations HOPFILT
166 004– 2081– 002

CCFFT ( 3S ) CCFFT ( 3S )
NAME
CCFFT – Applies a multitasked complex-to-complex Fast Fourier Transform (FFT)
SYNOPSIS
CALL CCFFT (isign, n, scale, x, y, table, work, isys)
IMPLEMENTATION
On UNICOS/mk systems, this subroutine executes on a single processor and uses private data only.
DESCRIPTION
CCFFT computes the Fast Fourier Transform (FFT) of the complex vector x, and it stores the result in vector
y.
In FFT applications, it is customary to use zero-based subscripts; the formulas are simpler that way.
Suppose that the arrays are dimensioned as follows:
COMPLE X X(0 :N- 1), Y(0 :N- 1)
The output array is the FFT of the input array, using the following formula for the FFT:
n −1
Σ
. j .k
Yk = scale . X j . ωisign for k = 0, . . ., n −1
j =0
where
2.π.i
ω=e n
i = + √−1
π = 3.14159. . .
isign = ±1
Different authors use different conventions for which of the transforms, isign = +1 or isign = – 1, is the
forward or inverse transform, and what the scale factor should be in either case. You can make this routine
compute any of the various possible definitions, however, by choosing the appropriate values for isign and
scale.
The relevant fact from FFT theory is this: If you take the FFT with any particular values of isign and scale,
the mathematical inverse function is computed by taking the FFT with – isign and 1 /(n .scale ). In particular,
if you use isign = +1 and scale = 1.0 you can compute the inverse FFT by using isign = – 1 and
scale = 1.0 /n.
004– 2081– 002 167

The output array may be the same as the input array, provided that n has at least 2 factors.
On UNICOS/mk systems only: if the length of the FFT (i.e. n) is not factorizable into powers of 2, 3 and 5
(that is, when a fast mixed-radix algorithm cannot be used) the user may specify that a fast chirp-z
transform-based algorithm be used instead of a slow O(nˆ2) algorithm. The isys variable allows the user to
exercise this option. Setting the value of isys to 0 uses the slow algorithm while setting it to 1 flags the use
of the fast algorithm. Depending on the value of isys specified, the size of the table vector and workspace
vector vary.
isign Integer. (input)
Specifies whether to initialize the table array or to do the forward or inverse Fourier transform,
as follows:
If isign = 0, the routine initializes the table array and returns. In this case, the only arguments
used or checked are isign, n, and table.
If isign = +1 or – 1, the value of isign is the sign of the exponent used in the FFT formula.
n Integer. (input)
Size of the transform (the number of values in the input array). n ≥ 2.
scale Real. (input)
Scale factor. Each element of the output array is multiplied by scale after taking the Fourier
transform, as defined by the previous formula.
x Complex array of dimension (0:n– 1). (input)
Input array of values to be transformed.
y Complex array of dimension (0:n– 1). (output)
Output array of transformed values. The output array may be the same as the input array. In
that case, the transform is done in place and the input array is overwritten with the transformed
values.
table UNICOS: Real array of dimension 100 + 8 . n. (input or output)
UNICOS/mk: Real array of dimension 2n when isys = 0 and real array of dimension 12n when
isys = 1.
Table of factors and trigonometric functions.
If isign = 0, the routine initializes table (table is output only).
If isign = +1 or – 1, the values in table are assumed to be initialized already by a prior call with
isign = 0 (table is input only).
work UNICOS: Real array of dimension 8n. (workspace)
UNICOS/mk: Real array of dimension 4n when isys = 0 and real array of dimension 8n when
isys = 1 (workspace).
Work array. This is a scratch array used for intermediate calculations. Its address space must
be different address space from that of the input and output arrays.
168 004– 2081– 002

isys Integer. (Input)

On UNICOS/mk systems: If n is prime or not factorizable into powers of 2, 3 and 5 then
intializing isys = 1 results in the use of a fast chirp-z based FFT algorithm. When n is
factorizable into powers of 2, 3 and 5, then setting isys = 0 results in the fastest algorithm being
used. Setting isys = 1, in the latter case results in a slower algorithm.
On UNICOS systems, the value of isys must be set to 0.
NOTES
This section contains information about the algorithm for CCFFT, the initialization of the table array, the
declaration of dimensions for x and y arrays, some performance tips, and some implementation dependent
details.
Algorithm
UNICOS/mk:
The algorithm used is a variant of Agarwal’s algorithm when n is factorizable into powers of 2, 3 and 5. If
n is prime or is not factorizable into powers of 2, 3 and 5 then setting isys to 1 results in the use of a fast
(O(n log(n))) algorithm based on the chirp-z transform. For example, 120 and 256 are factorizable into
powers of 2, 3 and 5, but 254 = 2 . 127 is not factorizable. To obtain considerable reduction in time to
compute the FFT of a 254 length vector, the integer isys may be set to 1.
UNICOS systems:
The algorithm is the "four-step" method, in which the data is considered as a matrix of dimensions n1 by n2,
for which n1 . n2 = n , and the values of n1 and n2 are chosen for efficiency.
The rows are transformed, the phase factors are applied, the columns are transformed, and finally the matrix
is transposed to obtain the result.
Initialization
The table array stores the trigonometric tables used in calculation of the FFT. You must initialize table by
calling the routine with isign = 0 prior to doing the transforms. If the value of the problem size, n, does not
change, table does not have to be reinitialized.
Dimensions
In the preceding description, it is assumed that array subscripts were zero-based, as is customary in FFT
applications. Thus, the input and output arrays are declared as follows:
COM PLE X X(0 :N-1)
COMPLE X Y(0 :N- 1)
However, if you prefer to use the more customary Fortran style with subscripts starting at 1 you do not have
to change the calling sequence, as in the following (assuming N > 0):
COM PLEX X(N)
COM PLEX Y(N)
004– 2081– 002 169

Performance Tips
This routine computes an FFT for any value of n, but the performance for a given value of n depends on the
prime factorization of n. This fact is characteristic of all FFT algorithms.
Fastest performance is realized when n is a power of 2. In that case, the number of floating-point operations
is approximately 5nlog 2 (n).
If n contains factors of 3, computation time is slightly longer, because more floating-point operations are
required. If n contains powers of 5, it is longer still. Slowest performance is when n is a prime number. In
that case, the number of floating-point operations is approximately 8 . n 2 when isys = 0.
On UNICOS/mk systems only, if n is prime, setting isys = 1 results in the use of an algorithm whose
complexity is approximately the same as using a fast mixed-radix algorithm on a vector of twice the length.
The kernel routines are optimized for values of n that are products of powers of 2, 3, and 5.
(Because the kernel routines have a special case for multiples of 4, powers of 4 will be slightly faster than
odd powers of 2.)
Implementation-dependent Items
The UNICOS and UNICOS/mk FFT routines were designed so that they can be implemented efficiently on
many different architectures. The calling sequence is the same in any implementation. Certain details,
however, depend on the particular implementation. These details are confined to two areas:
• The first area is the size of the table and work arrays. Different systems may need different sizes. The
subroutine call requires no change, but you may have to change array sizes in the DIMENSION or type
statements that declare the arrays.
• The second area is the isys parameter array, an array that gives certain implementation-specific
information. All features and functions of the FFT routines specific to any particular implementation are
confined to this isys array. On any implementation, you can use the default values by using an argument
value of 0.
In the current UNICOS implementation, no special options are supported; therefore, you may specify that
the isys parameter always be given as a constant 0. Subsequent software releases may provide other
options.
EXAMPLES
These examples use the table and workspace sizes appropriate to UNICOS systems.
Example 1: Initialize the complex array table in preparation for doing an FFT of size 1024. Only the isign,
n, and table arguments are used in this case. You can use dummy arguments or zeros for the other
arguments in the subroutine call.
REAL TAB LE(100 + 8*1024)
CALL CCFFT( 0, 1024, 0.0 , DUM MY, DUM MY, TAB LE, DUM MY, 0)
170 004– 2081– 002

Example 2: x and y are complex arrays of dimension (0:1023). Take the FFT of x and store the results in y.
Before taking the FFT, initialize the table array, as in example 1.
COM PLE X X(0 :1023), Y(0 :10 23)
REA L TAB LE( 100 + 8*1024 )
REAL WORK(8 *10 24)
...
CAL L CCF FT( 0, 1024, 1.0 , X, Y, TAB LE, WOR K, 0)
CALL CCF FT(1, 102 4, 1.0, X, Y, TABLE, WOR K, 0)
Example 3: Using the same x and y as in example 2, take the inverse FFT of y and store it back in x. The
scale factor 1/1024 is used. Assume that the table array is already initialized.
CAL L CCF FT( -1, 102 4, 1.0/10 24.0, Y, X, TABLE, WOR K, 0)
Example 4: Do the same computation as in example 2, but assume that the lower bound of each array is 1,
rather than 0. No change was needed in the subroutine calls.
COM PLEX X(1024), Y(1 024 )
...
CALL CCF FT(0, 102 4, 1.0, X, Y, TABLE, WOR K, 0)
CAL L CCF FT( 1, 1024, 1.0 , X, Y, TAB LE, WORK, 0)
Example 5: Do the same computation as in example 4, but put the output back in array x to save storage
space. Assume that table is already initialized.
COMPLE X X(1024 )
...
CAL L CCF FT( 1, 1024, 1.0 , X, X, TAB LE, WOR K, 0)
SEE ALSO
CCFFTM(3S), SCFFT(3S), SCFFTM(3S)
004– 2081– 002 171

CCFFT2D ( 3S ) CCFFT2D ( 3S )
NAME
CCFFT2D – Applies a two-dimensional complex-to-complex Fast Fourier Transform (FFT)
SYNOPSIS
CALL CCFFT2D (isign, n1, n2, scale, x, ldx, y, ldy, table, work, isys)
IMPLEMENTATION
DESCRIPTION
CCFFT2D computes the two-dimensional complex Fast Fourier Transform (FFT) of the complex matrix X,
and it stores the results in the complex matrix Y.
COM PLEX X(0:n1 -1, 0:n 2-1 )
COM PLEX Y(0:n1 -1, 0:n 2-1 )
CCFFT2D computes the formula:

n1−1 n2−1 .k .k
Σ Σ
j . ω2 j
Yk ,k = scale .
1 2
X j ,j . ω1
1 2
1 1 2 2
for k 1 = 0, . . ., n1−1, k 2 = 0, . . ., n2−1
j =0 j =0
1 2
where
isign . 2 . π . i
ω1 = e isign n1
. 2 . π . i i = +√−1
ω2 = e n2
π = 3.14159. . .
isign = ±1
scale.
the mathematical inverse function is computed by taking the FFT with – isign and 1 / (n1.n2.scale). In
particular, if you use isign = +1 and scale = 1.0 for the forward FFT, you can compute the inverse FFT by
using isign = – 1 and scale = 1 /(n1.n2).
172 004– 2081– 002

UNICOS/mk systems only

If the values of either n1 or n2 are prime or not factorizable into powers of 2, 3 and 5 significant
improvements in computational time can be obtained by using the following initializations of isys which is a
vector of length 3.
If both n1 and n2 are factorizable into powers of 2, 3 and 5, and for example, n1 = 30 and n2 = 120 then
isys(1) = 2
isys(2) = 0
isys(3) = 0
If any one dimension is not factorizable into powers of 2, 3 and 5 then the following intializations of isys
yield the fastest times:
n1 not factorizable but n2 factorizable
isys(1) = 2
isys(2) = 1
isys(3) = 0
n1 factorizable but n2 not factorizable
isys(1) = 2
isys(2) = 0
isys(3) = 1
both n1 and n2 not factorizable
isys(1) = 2
isys(2) = 1
isys(3) = 1
Here isys(1) indicates the dimension of the matrix over which the FFT is being performed.
If the numbers n1 and n2 are not known ahead of time, then isys(2) and isys(3) could be initialized to 0 and
the routine would compute correct results for n1 and n2, albeit slowly, if either n1 or n2 were prime.
The storage requirements for the vector table depend on the values of the isys vector.
This feature does not exist for UNICOS systems and isys is ignored on those machines.
Specifies whether to initialize the table array or to do the forward or inverse transform as
follows:
used or checked are isign, n1, n2, table.
n1 Integer. (input)
Transform size in the first dimension. If n1 is not positive, CCFFT2D returns without
performing a transform.
004– 2081– 002 173

n2 Integer. (input)
Transform size in the second dimension. If n2 is not positive, CCFFT2D returns without
scale Real. (input)
Scale factor. Each element of the output array is multiplied by scale factor after taking the
Fourier transform, as defined previously.
x Complex array of dimension (0:ldx– 1, 0:n2– 1). (input)
ldx Integer. (input)
The number of rows in the x array, as it was declared in the calling program (the leading
dimension of x). ldx ≥ MAX(n1, 1).
y Complex array of dimension (0:ldy– 1, 0:n2– 1). (output)
Output array of transformed values. The output array may be the same as the input array, in
which case, the transform is done in place (the input array is overwritten with the transformed
values). In this case, it is necessary that ldx = ldy.
ldy Integer. (input)
The number of rows in the y array, as it was declared in the calling program (the leading
dimension of y). ldy ≥ MAX(n1, 1).
table UNICOS systems: real array of dimension 100 + 2(n1 + n2). (input or output)
UNICOS/mk systems: Real array of dimension 2(n1 + n2) if both isys(2) and isys(3) are equal to
zero. Private real vector of length 12(n1 + n2) if either isys(2) or isys(3) is equal to 1. (input or
output)
work UNICOS systems: real array of dimension 512 . MAX(n1, n2). (scratch output)
UNICOS/mk systems: Real array of dimension 2 . n1 . n2 (scratch output)
be different from that of the input and output arrays.
isys UNICOS systems: ignored.
UNICOS/mk systems: Integer array of length 3. (input)
isys(1) = 2
isys(2) = 0 (if n1 is factorizable into powers of 2, 3 and 5)
1 ( if n1 is not factorizable into powers of 2, 3 and 5)
174 004– 2081– 002

See PCCFFT2D(3S) for a more detailed explanation of the isys parameter.
NOTES
This section contains information about the algorithm for CCFFT2D, the initialization of the table array, the
details.
The following notes are for UNICOS systems only. CCFFT2D(3S) on UNICOS/mk systems provides the
functionality of PCCFFT2D(3S) on a single PE. For notes about CCFFT2D on UNICOS/mk systems, see
PCCFFT2D(3S).
Algorithm
CCFFT2D uses a routine very much like CCFFTM(3S) to do multiple FFTs first on all columns in an input
matrix and then on all of the rows.
Initialization
The table array stores factors of n1 and n2 and also trigonometric tables that are used in calculation of the
FFT. This table must be initialized by calling the routine with isign = 0. If the values of the problem sizes,
n1 and n2, do not change, the table does not have to be reinitialized.
Dimensions
COMPLE X X(0 :ldx-1 , 0:n 2-1 )
COM PLE X Y(0 :ldy-1, 0:n 2-1 )
However, the calling sequence does not change if you prefer to use the more customary Fortran style with
subscripts starting at 1. The same values of ldx and ldy would be passed to the subroutine even if the input
and output arrays were dimensioned as follows:
COM PLE X X(l dx, n2)
COM PLE X Y(l dy, n2)
Performance Tips
This routine computes an FFT for any values of n1 and n2, but the performance depends on the prime
factorizations of n1 and n2. This fact is characteristic of all FFT algorithms.
Fastest performance is realized when both n1 and n2 are powers of 2. In that case, the number of floating-
point operations is approximately 5 . n1 . n2 . log 2 (n1 . n2).
If either n1 or n2 contains factors of 3, computation time is slightly longer, because more floating-point
operations are required. If they contain powers of 5, it is longer still.
The kernel routines are optimized for values of n1 and n2 that are products of powers of 2, 3, and 5.
004– 2081– 002 175

In the UNICOS systems implementation, it is very important to make the leading dimensions of the arrays
odd numbers (or, if that is not possible, make them an odd multiple of 2) to avoid memory bank conflicts.
The UNICOS and UNICOS/mk FFT routines were designed so that they could be implemented efficiently on
however, depend on the particular implementation. These details are confined to three areas:
• The first area is the size of the table and work arrays. Different systems may need different sizes. No
change is required to the subroutine call, but you may have to change array sizes in the DIMENSION or
type statements that declare the arrays.
• The second area is the isys parameter array, an argument that gives certain implementation-specific
information. All features and functions of the FFT routines that are specific to any particular
implementation are confined to this isys array. On any implementation, you can use the default values by
using an argument value of 0.
In the UNICOS systems implementation, no special options are supported; therefore, you can always
specify the isys parameter as a constant 0. Subsequent software releases may provide other options.
• The third area is the issue of which problem sizes or dimensions give optimal performance in a particular
implementation. See the Performance Tips subsection.
EXAMPLES
All examples here are for UNICOS systems only.
Example 1: Initialize the TABLE array in preparation for doing a two-dimensional FFT of size 128 by 256.
In this case only the isign, n1, n2, and table arguments are used; you can use dummy arguments or zeros for
other arguments.
REA L TAB LE( 100 + 2*( 128 + 256))
CAL L CCF FT2 D (0, 128, 256 , 0.0 , DUM MY, 1, DUM MY, 1,
& TAB LE, DUM MY, 0)
Example 2: X and Y are complex arrays of dimension (0:128, 0:255). The first 128 elements of each
column contain data. For performance reasons, the extra element forces the leading dimension to be an odd
number. Take the two-dimensional FFT of X and store it in Y. Initialize the TABLE array, as in example 1.
COM PLE X X(0 :12 8, 0:2 55)
COM PLE X Y(0 :12 8, 0:2 55)
REA L TAB LE( 100 + 2*( 128 + 256 ))
REA L WOR K(5 12* 256 )
...
CAL L CCF FT2 D(0 , 128 , 256 , 1.0 , X, 129, Y, 129 , TAB LE, WORK, 0)
CAL L CCF FT2 D(1 , 128 , 256, 1.0, X, 129 , Y, 129 , TAB LE, WOR K, 0)
176 004– 2081– 002

Example 3: With X and Y as in example 2, take the inverse FFT of Y and store it back in X. The scale
1
factor is used. Assume that the TABLE array is already initialized.
128.256
CALL CCFFT2D(- 1, 128, 256 , 1.0 /(128. 0*2 56.0), Y, 129 ,
& X, 129 , TAB LE, WOR K, 0)
rather than 0. The subroutine calls are not changed.
COMPLEX X(1 29, 256)
COMPLEX Y(1 29, 256)
...
CALL CCFFT2 D(0 , 128 , 256 , 1.0 , X, 129 , Y, 129, TABLE, WOR K, 0)
CAL L CCF FT2D(1, 128, 256 , 1.0 , X, 129 , Y, 129 , TAB LE, WOR K, 0)
Example 5: Do the same computation as in example 4, but put the output back in array X to save storage
space. Assume that the TABLE array is already initialized.
COMPLE X X(1 29, 256)
...
CAL L CCF FT2D(1, 128, 256 , 1.0 , X, 129 , X, 129 , TAB LE, WOR K, 0)
SEE ALSO
CCFFT(3S), CCFFT3D(3S), CCFFTM(3S), SCFFT(3S), SCFFT2D(3S), SCFFT3D(3S), SCFFTM(3S)
004– 2081– 002 177

NAME
CCFFT3D – Applies a three-dimensional complex-to-complex Fast Fourier Transform (FFT)
SYNOPSIS
CALL CCFFT3D (isign, n1, n2, n3, scale, x, ldx, ldx2, y, ldy, ldy2, table, work, isys)
IMPLEMENTATION
DESCRIPTION
CCFFT3D computes the three-dimensional complex FFT of the complex matrix X, and it stores the results in
the complex matrix Y.
In FFT applications, it is customary to use zero-based subscripts; the formulas are simpler that way. So
suppose the arrays are dimensioned as follows:
COM PLEX X(0:n1 -1, 0:n 2-1 , 0:n 3-1 )
COM PLEX Y(0:n1 -1, 0:n 2-1 , 0:n 3-1 )
CCFFT3D computes the formula:

n1−1 n2−1 n3−1 .k .k .k k 1 = 0, . . ., n1−1
Σ Σ Σ
j . ω2 j . ω3 j
Yk k k
1, 2, 3
= scale . X j ,j ,j . ω1
1 2 3
1 1 2 2 3 3
for k 2 = 0, . . ., n2−1
j j
1=0
j 2=0 3=0 k 3 = 0, . . ., n3−1
where: isign . 2 . π . i
ω1 = e n1
i = +√−1
isign . 2 . π . i
ω2 = e n2
π = 3.14159. . .
isign . 2 . π . i
ω3 = e n3
isign = ±1
scale.
the mathematical inverse function is computed by taking the FFT with – isign and 1 /(n1 . n2 . n3 . scale).
In particular, if you use isign = +1 and scale = 1.0 for the forward FFT, you can compute the inverse FFT
by using isign = – 1 and scale = 1/(n1 . n2 . n3).
178 004– 2081– 002


If the values of either n1, n2, or n3 are prime or not factorizable into powers of 2, 3 and 5 significant
improvements in computational time can be obtained by using the following initializations of isys, which is a
vector of length 4.
The first element of isys indicates the dimension of the problem, that is, isys(1) = 3. The next three elements
of isys indicate if the lengths n1, n2 and n3 are factorizable into powers of 2, 3 and 5. isys(2) is set to 0 if
n1 is factorizable into powers of 2, 3 and 5 and is set to 1 otherwise. Similarly, isys(3) and isys(4) are set to
zero if n2 and n3 are factorizable into powers of 2, 3 and 5 and set to 1 if they are not.
For example, if n1 = 256, n2 = 240, and n3 = 254, the best computational time is obtained by setting the
following:
isys(1) = 3 (dimension of the problem)
isys(2) = 0
isys(3) = 0
isys(4) = 1
If the numbers n1, n2, and n3 are not known ahead of time, then isys(2), isys(3), and isys(4) could be
initialized to 0 and the routine would compute correct result, albeit slowly, if either n1, n2, or n3 were not
factorizable into powers of 2, 3, and 5.
UNICOS systems
The isys parameter is used to choose between two multitasking strategies and correspondingly different
amounts of workspace to be provided. A brief discussion about the significance of the isys parameter is
provided in the following argument list.
as follows:
used or checked are isign, n1, n2, n3, and table.
n1 Integer. (input)
Transform size in the first dimension. If n1 is not positive, CCFFT3D returns without
computing a transform.
n2 Integer. (input)
Transform size in the second dimension. If n2 is not positive, CCFFT3D returns without
n3 Integer. (input)
Transform size in the third dimension. If n3 is not positive, CCFFT3D returns without
004– 2081– 002 179

scale Real. (input)

transform, as defined previously.
x Complex array of dimension (0:ldx– 1, 0:ldx2– 1, 0:n3– 1). (input)
The first dimension of x, as it was declared in the calling program (the leading dimension of x).
ldx ≥ MAX(n1, 1).
ldx2 Integer. (input)
The second dimension of x, as it was declared in the calling program. ldx2 ≥ MAX(n2, 1).
y Complex array of dimension (0:ldy– 1, 0:ldy2– 1, 0:n3– 1). (output)
which case, the transform is done in place; that is, the input array is overwritten with the
transformed values. In this case, it is necessary that ldx = ldy, and ldx2 = ldy2.
The first dimension of y, as it was declared in the calling program (the leading dimension of y).
ldy ≥ MAX(n1, 1).
ldy2 Integer. (input)
The second dimension of y, as it was declared in the calling program. ldy2 ≥ MAX(n2, 1).
table UNICOS systems: real array of dimension 100 + 2(n1 + n2 + n3). (input or output)
UNICOS/mk systems: Real array of dimension 2(n1 + n2 + n3) if isys(2), isys(3), and isys(4)
are all equal to zero. Private real vector of length 12(n1 + n2 + n3) if either isys(2), isys(3), or
isys(4) is equal to 1. (input or output)
Table of factors and trigonometric functions. If isign = 0, the routine initializes table (table is
output only). If isign = +1 or – 1, the values in table are assumed to be initialized already by a
prior call with isign = 0 (table is input only).
work UNICOS systems: real array of dimension 512 . MAX(n1, n2, n3) when isys = 0 and of
dimension 4 . NCPUS . MAX(n1 . n2, n2 . n3, n3 . n1) when isys = 1. (scratch output)
When isys = 0, the parallel performance of this routine may be bad for small problem sizes.
Setting isys to 1 and providing the additional memory will significantly enhance parallel
performance. The NCPUS parameter is the environment variable that is set to indicate the
maximum number of CPUs that can be used in the application. The default value is 4.
UNICOS/mk systems: Real array of dimension 2(n1 . n2 . n3) (scratch output)
isys UNICOS systems: Integer array of dimension (1). (input)
isys = 0 or 1 depending on the amount of workspace the user can provide to the routine.
180 004– 2081– 002

UNICOS/mk systems: Integer array of dimension 4. (input)

isys(1) = 3
1 (if n1 is not factorizable into powers of 2, 3 and 5)
1 (if n2 is not factorizable into powers of 2, 3 and 5)
NOTES
CCFFT3D is the generalization of CCFFT2D to three dimensions. All of the notes for CCFFT2D apply,
with the obvious modifications for three dimensions.
EXAMPLES
The following examples are for UNICOS systems only. CCFFT3D(3S) on UNICOS/mk systems provides
the functionality of PCCFFT3D(3S) on a single PE. For notes on CCFFT3D(3S) on UNICOS/mk systems,
see PCCFFT3D(3S).
In all the examples shown below isys is set to 0. For better performance on small size 3D FFTs, setting isys
= 1 and providing adequate workspace would yield better performance.
Example 1: Initialize the TABLE array in preparation for doing a three-dimensional FFT of size 128 by 128
by 128. In this case, only the isign, n1, n2, n3, and table arguments are used; you can use dummy
arguments or zeros for other arguments.
REA L TAB LE( 100 + 2*( 128 + 128 + 128))
CAL L CCF FT3 D (0, 128, 128, 128, 0.0, DUMMY, 1, 1, DUM MY, 1, 1,
Example 2: X and Y are complex arrays of dimension (0:128, 0:128, 0:128). The first 128 elements of each
dimension contain data; for performance reasons, the extra element forces the leading dimensions to be odd
numbers. Take the three-dimensional FFT of X and store it in Y. Initialize the TABLE array, as in example
1.
COM PLE X X(0 :12 8, 0:1 28, 0:1 28)
COM PLE X Y(0 :12 8, 0:1 28, 0:1 28)
REA L TAB LE( 100 + 2*( 128 + 128 + 128))
REA L WOR K(5 12* 128 )
...
CAL L CCF FT3 D(0 , 128, 128 , 128 , 1.0 , DUM MY, 1, 1,
& DUM MY, 1, 1, TAB LE, WOR K, 0)
CAL L CCF FT3 D(1 , 128, 128, 128, 1.0 , X, 129 , 129 ,
& Y, 129 , 129 , TAB LE, WOR K, 0)
004– 2081– 002 181

1
factor is used. Assume that the TABLE array is already initialized.
1283
CAL L CCF FT3D(- 1, 128 , 128 , 128 , 1.0 /(1 28. 0**3), Y, 129 , 129 ,
& X, 129 , 129 , TAB LE, WORK, 0)
rather than 0. The subroutine calls do not change.
COMPLEX X(129, 129 , 129 )
COM PLEX Y(129, 129 , 129 )
...
CAL L CCF FT3 D(0, 128 , 128 , 128 , 1.0 , DUM MY, 1, 1,
& DUMMY, 1, 1, TAB LE, WORK, 0)
CAL L CCF FT3D(1, 128, 128, 128, 1.0, X, 129 , 129 ,
& Y, 129 , 129 , TABLE, WOR K, 0)
Example 5: Do the same computation as in example 4, but put the output back in the array X to save
storage space. Assume that the TABLE array is already initialized.
COMPLE X X(1 29, 129, 129)
...
CALL CCFFT3 D(1 , 128 , 128 , 128 , 1.0 , X, 129, 129,
& X, 129, 129, TABLE, WOR K, 0)
SEE ALSO
CCFFT(3S), CCFFT2D(3S), CCFFTM(3S), SCFFT(3S), SCFFT2D(3S), SCFFT3D(3S), SCFFTM(3S)
182 004– 2081– 002

CCFFTM ( 3S ) CCFFTM ( 3S )
NAME
CCFFTM – Applies multiple multitasked complex-to-complex Fast Fourier Transforms (FFTs)
SYNOPSIS
CALL CCFFTM (isign, n, lot, scale, x, ldx, y, ldy, table, work, isys)
IMPLEMENTATION
DESCRIPTION
CCFFTM computes the FFT of each column of the complex matrix X, and it stores the results in the columns
of complex matrix Y.
Suppose the arrays are dimensioned as follows:
COMPLE X X(0 :ld x-1 , 0:lot- 1)
COMPLE X Y(0 :ld y-1 , 0:l ot- 1)
where ldx ≥ n, ldy ≥ n.

Then column L of the output array is the FFT of column L of the input array, using the following formula
for the FFT:
n −1
Σ Xj
. j .k
Yk ,L = scale . . ωisign for k = 0, . . ., n −1, L = 0, . . ., lot −1
j =0
where:
2 . π . i
ω=e n
i = +√−1
π = 3.14159. . . isign = ±1
lot = Number of columns to transform
scale.
the mathematical inverse function is computed by taking the FFT with – isign and 1 / (n . scale). In
using the following: isign = – 1 and scale = 1.0 / n.
004– 2081– 002 183


as follows:
If isign = 0, the routine initializes table and returns. In this case, the only arguments used or
checked are isign, n, and table.
n Integer. (input)
Size of each transform (the number of elements in each column of the input and output matrix to
be transformed). Performance depends on the value of n, as explained in the NOTES section. n
≥ 0; if n = 0, the routine returns.
lot Integer. (input)
The number of transforms to be computed (lot size). This is the number of elements in each
row of the input and output matrix. lot ≥ 0. If lot = 0, the routine returns.
scale Real. (input)
Scale factor. Each element of the output array is multiplied by the scale factor after taking the
x Complex array of dimension (0:ldx– 1, 0:lot– 1). (input)
The number of rows in x, as it was declared in the calling program (the leading dimension of X).
ldx ≥ MAX(n, 1).
y Complex array of dimension (0:ldy– 1, 0:lot– 1). (output)
Output array of transformed values. Each column of the output array, y, is the FFT of the
corresponding column of the input array, x, computed according to the preceding formula.
The output array may be the same as the input array. In that case, the transform is done in place.
The input array is overwritten with the transformed values. In this case, it is necessary that ldx
= ldy.
The number of rows in the Y array, as it was declared in the calling program (the leading
dimension of Y). ldy ≥ MAX(n, 1).
table UNICOS systems: Real array of dimension 100 + 2n. (input or output)
UNICOS/mk systems: Real array of dimension 2n.
Table of trigonometric functions.
184 004– 2081– 002

work UNICOS systems: Real array of dimension 4 . lot . n . (scratch output)

UNICOS/mk systems: Real array of dimension 4n.
be different from the input and output arrays.
isys Integer array of dimension (0:isys(0)). (input and output)
The first element of the array specifies how many more elements are in the array. Use isys to
specify certain processor-specific parameters or options.
If isys(0) = 0, the default values of such parameters are used. In this case, you can specify the
argument value as the scalar integer constant 0.
If isys(0) > 0, isys(0) gives the upper bound of the isys array. Therefore, if il = isys(0), user-
specified parameters are expected in isys(1) through isys(il).
NOTES
This section contains information about the algorithm for CCFFTM, the initialization of the table array, the
declaration of dimensions for x and y arrays, some performance tips, and some implementation-dependent
details.
Algorithm
UNICOS only: CCFFTM uses decimation-in-frequency type FFT. It takes the FFT of the columns and
vectorizes the operations along the rows of the matrix. Thus, the vector length in the calculations depends
on the row size, and the strides for vector loads and stores are the leading dimensions, ldx and ldy.
On UNICOS/mk systems, this routine is not optimized.
Initialization
The table array stores the trigonometric tables used in calculation of the FFT. You must initialize the table
array by calling the routine with isign = 0 prior to doing the transforms. If the value of the problem size, n,
does not change, table does not have to be reinitialized.
Dimensions
COM PLEX X(0:ldx-1 , 0:l ot- 1)
COM PLEX Y(0:ldy-1 , 0:l ot- 1)
The calling sequence does not have to change, however, if you prefer to use the more customary Fortran
style with subscripts starting at 1. The same values of ldx and ldy would be passed to the subroutine even if
the input and output arrays were dimensioned as follows:
COM PLEX X(ldx, lot)
COM PLEX Y(ldy, lot)
004– 2081– 002 185

Performance Tips
Fastest performance is realized when n is a power of 2. In that case, the number of floating-point operations
is approximately 5 . lot . n . log 2 (n)
required. If n contains powers of 5, it is longer still. Slowest performance is when n is a prime number. In
2
that case, the number of floating-point operations is approximately 8 . lot . n .
The kernel routines are optimized for values of n that are products of powers of 2, 3, and 5. Because the
kernel routines have a special case for multiples of 4, even powers of 2 will be slightly faster than odd
powers of 2.
In this implementation, to avoid memory bank conflicts, it is very important to make the leading dimensions
of the arrays odd numbers (or, if that is not possible, make them an odd multiple of 2). To attain best
vectorization performance, the lot size should be at least 64, and preferably, it should be a multiple of 64.
however, depend on the particular implementation. These details are confined to three areas:
subroutine call requires no change, but you may have to change the array sizes in the DIMENSION or
type statements that declare the arrays.
specifying an argument value of 0.
specify the isys parameter as a constant 0. Subsequent software releases may provide other options.
EXAMPLES
Example 1: Initialize the TABLE array in preparation for doing an FFT of size 128. Only the isign, n, and
table arguments are used in this case. You can use dummy arguments or zeros for the other arguments in
the subroutine call.
REA L TAB LE(100 + 2*1 28)
CALL CCFFTM (0, 128, 0, 0., DUM MY, 1, DUM MY, 1, TAB LE, DUM MY, 0)
186 004– 2081– 002

Example 2: X and Y are complex arrays of dimension (0:128) by (0:55). The first 128 elements of each
column contain data. For performance reasons, the extra element forces the leading dimension to be an odd
number. Take the FFT of the first 50 columns of X and store the results in the first 50 columns of Y.
Before taking the FFT, initialize the TABLE array, as in example 1.
COM PLEX X(0:128, 0:5 5)
COM PLE X Y(0 :128, 0:5 5)
REA L TAB LE( 100 + 2*128)
REAL WORK(4 *12 8*50)
...
CALL CCFFTM (0, 128, 50, 1.0 , X, 129 , Y, 129 , TAB LE, WOR K, 0)
factor 1/128 is used. Assume that the TABLE array is already initialized.
CAL L CCF FTM(-1, 128, 50, 1./ 128 ., Y, 129 , X, 129 , TAB LE, WOR K,0 )
COM PLEX X(129, 55)
COM PLEX Y(129, 55)
...
space. Assume that the TABLE array is already initialized.
COMPLE X X(1 29, 55)
...
CALL CCFFTM (1, 128, 50, 1.0 , X, 129 , X, 129 , TAB LE, WOR K, 0)
SEE ALSO
CCFFT(3S), SCFFT(3S), SCFFTM(3S)
004– 2081– 002 187

CCNVL ( 3S ) CCNVL ( 3S )
NAME
CCNVL – Computes the convolution of a complex sequence with one or more other complex sequences
SYNOPSIS
CALL CCNVL (nh, nx, m, ny, h, inc1h, x, inc1x, inc2x, y, inc1y, inc2y)
IMPLEMENTATION
UNICOS systems
DESCRIPTION
CCNVL computes the convolution of the complex sequence h with one or more complex sequences x.
nh Integer. (input)
Number of elements in the h sequence. nh ≥ 0. If nh = 0, CCNVL zeroes out all elements of
output matrix y.
nx Integer. (input)
Number of elements in each sequence of x values. nx ≥ 0. If nx = 0, CCNVL zeroes out all
elements of output matrix y.
m Integer. (input)
Number of sequences of x values. m ≥ 0. If m = 0, CCNVL returns without calculating a
convolution.
ny Integer. (input)
Number of elements in output sequence y. ny ≥ 0. If ny = 0, CCNVL returns without calculating
a convolution.
h Complex array of dimension nh. (input)
Input sequence to be convolved with x.
inc1h Integer. (input)
Address increment between elements in array h. inc1h must not be zero.
x Complex array of dimension (nx, m). (input)
Input matrix to be convolved with h.
inc1x Integer. (input)
Address increment between elements in each sequence of x values. inc1x must not be zero.
Address increment between sequences of x values. inc2x must not be 0.
y Complex array of dimension (ny, m). (output)
Output matrix of convolutions.
188 004– 2081– 002

inc1y Integer. (input)

Address increment between elements in each sequence of y values. inc1y must not be 0.
Address increment between sequences of y values. inc2y must not be 0.
Calculating a Convolution
Suppose h and x are two sequences of complex numbers, having nh and nx elements, respectively. As is
customary in signal processing applications, let the subscripts start at 0, so that
 h   x 
 0
  0

h x
h =  ..  and x =  .. 
1 1
 .   . 
 hnh −1   xnx −1 
The convolution product, y = h . x , is the sequence that has nh + nx – 1 elements defined by the following:
y0 = h 0x 0
y1 = h 1x 0 + h 0x 1
y2 = h 2x 0 + h 1x 1 + h 0x 2
y3 = h 3x 0 + h 2x 1 + h 1x 2 + h 0x 3
..
.
ynh +nx −2 = hnh −1xnx −1
In the CCNVL routine, the number of terms in the output sequence is specified by an argument, ny. If
ny < nh + nx – 1 the sequence y is just truncated. If ny > nh + nx – 1 the terms beyond y(nh + nx – 2) are
set to 0.
Multiple Convolutions
CCNVL can actually compute several convolutions in one call. The input sequence h is always a vector, but
the input x can be a matrix. In this case, CCNVL convolves h with each column of x, resulting in a column
of the output matrix, y.
NOTES
The following notes define the convolution more precisely, and discuss its uses and performance.
Convolution Definition
The precise definition of convolution computed by CCNVL is as follows:
Let h be a sequence of nh elements and X be a matrix with m columns, and nx elements in each column, as
follows:
 x x 0,1 x 0,2 . . . x 0,m −1 
 h0   0,0 
 h   x 1,0 x 1,1 x 1,2 . . . x 1,m −1 
 1   
h =  h.2  X =  x 2,0 x 2,1 x 2,2 . . . x 2,m −1 
. . .. .. .. ..
 .   .. . . . . 
 h nh −1   
 xnx −1,0 xnx −1,1 xnx −1,2 . . . xnx −1,m −1 
004– 2081– 002 189

Then each column of the output matrix:

 y y 0,1 y 0,2 . . . y 0,m −1 
 0,0 
 y 1,0 y 1,1 y 1,2 . . . y 1,m −1 
 
Y =  y 2,0 y 2,1 y 2,2 . . . y 2,m −1 
. .. .. .. ..
 .. . . . . 
 
 yny −1,0 yny −1,1 yny −1,2 . . . yny −1,m −1 
is obtained by convolving h with the corresponding column of X, so that:

MIN (k ,nh −1)
yk ,j = Σ
i =MAX (0,k −nx +1)
hi xk −i , j
A complex convolution is similar to the multiplication of complex polynomials. You can think of the
sequence h as a sequence of coefficients of the polynomial
H (z ) = h 0 + h 1z + h 2z 2 + h 3z 3 + . . . + hnh −1z nh −1
Similarly, each column
 x 
 0,j
.. 
xj =  . 
 xnx −1,j 
of the matrix X can be considered the coefficients of each of the polynomials
X j (z ) = x 0,j + x 1z + x 2,j z 2 + x 3,j z 3 + . . . + xnx −1,j z nx −1
The convolution product h and each column y j = h . x j is the sequence whose elements are the coefficients
of the product polynomial
Y j (z) = H(z)X j (z)
The operation of convolution is commutative, so that h . x = x . h. In this subroutine, however, h and x are
not interchangeable, because h is restricted to be a vector, but x can be a matrix of one or more vectors, all
of the same length.
Uses for Convolution
Convolutions have numerous applications in signal processing, where the convolution operation is sometimes
called filtering. The sequence h might represent a filter, and the matrix x might represent a set of input
signals. The output matrix y would represent the output signals obtained by filtering (convolving) x with h.
Performance
If the NCPUS environment variable is set and greater than 1, CCNVL multitasks on m; that is, it performs the
convolutions of successive x sequences in parallel.
190 004– 2081– 002

This routine is efficient for any value of the arguments. For long sequences, however, there is a faster
algorithm that uses a Fourier transform technique. For details, see the CCNVLF(3S) routine.
SEE ALSO
CCNVLF(3S)
004– 2081– 002 191

CCNVLF ( 3S ) CCNVLF ( 3S )
NAME
CCNVLF – Computes the convolution of a complex sequence with one or more other complex sequences by
using a Fourier transform method
SYNOPSIS
CALL CCNVLF (nh, nx, m, ny, h, inc1h, x, inc1x, inc2x, y, inc1y, inc2y, table, ntable,
work, nwork)
IMPLEMENTATION
UNICOS systems
DESCRIPTION
CCNVLF computes the convolution of the complex sequence h with one or more complex sequences x.
CCNVLF has exactly the same effect as the CCNVL(3S) routine. The difference is in the algorithm.
CCNVL(3S) computes the convolution directly, but CCNVLF uses a Fourier transform method, using a
routine similar to CCFFTM(3S). CCNVLF requires additional space for tables and workspace, but for long
sequences, it can be significantly faster than CCNVL(3S).
See the CCNVL(3S) man page for a definition of the convolution product that is computed by both routines.
nh Integer. (input)
Number of elements in sequence h. nh ≥ 0. If nh = 0, CCNVLF zeroes out all elements of
output matrix y.
nx Integer. (input)
Number of elements in each sequence of x values. nx ≥ 0. If nx = 0, CCNVLF zeroes out all
elements of output matrix y.
m Integer. (input)
Number of sequences of x values. m ≥ 0. If m = 0, CCNVLF returns without calculating a
convolution.
ny Integer. (input)
Number of elements in output sequence y. ny ≥ 0. If ny = 0, CCNVLF returns without
calculating a convolution.
h Complex array of dimension nh. (input)
Input sequence to be convolved with x.
inc1h Integer. (input)
Address increment between elements in array h. inc1h must not be zero.
x Complex array of dimension (nx, m). (input)
Input matrix to be convolved with h.
192 004– 2081– 002


Address increment between elements in each sequence of x values. inc1x must not be zero.
Address increment between sequences of x values. inc2x must not be 0.
y Complex array of dimension (ny, m). (output)
Output matrix of convolutions.
Address increment between elements in each sequence of y values. inc1y must not be 0.
Address increment between sequences of y values. inc2y must not be 0.
table Real array of dimension ntable. (input and output)
Table of factors and trigonometric function values.
ntable Integer. (input)
Size of array ntable. The value of ntable should be at least 2(nh + nx) + 100.
work Real array of dimension nwork. (scratch output)
nwork Integer. (input)
Size of array work. The value of nwork should be at least 6(nh+nx)(m+1).
NOTES
The computed output values y are the same as those computed by routine CCNVL(3S). See the CCNVL(3S)
man page for a definition of the convolution product.
The algorithm of this routine uses the famous Convolution Theorem, which states that the Fourier transform
of a convolution is the product of the Fourier transforms of the original sequences.
This routine performs a Fast Fourier Transform (FFT) on each on the sequences h and x, and an inverse FFT
on the product to compute the convolution. In each case, the order of each FFT is n = nh + nx.
The routine works correctly for any value of n, but as with all FFT routines, the performance depends on the
prime factorization of n. For the best performance, n should be a power of 2. If n is a moderately large
number that is a product of powers of 2, 3, and 5, you will still get very good performance. To obtain a
good value of n, the input sequences can be padded with zeros, if necessary. See the CCFFTM(3S) man page
for general information about FFTs.
The table array is initialized on the first call to routine CCNVLF. It is not reinitialized in subsequent calls
unless the value of n changes.
004– 2081– 002 193

If the NCPUS environment variable is set and greater than 1, this routine multitasks on m; that is, it performs
the convolutions of successive x sequences in parallel.
SEE ALSO
CCFFTM(3S), CCNVL(3S)
194 004– 2081– 002

CFFT ( 3S ) CFFT ( 3S )
NAME
CFFT – Applies a multitasked complex Fast Fourier Transform (FFT)
SYNOPSIS
CALL CFFT (isign, n, scale, x, incx, y, incy, table, ntable, work, nwork)
IMPLEMENTATION
UNICOS systems
DESCRIPTION
CFFT computes the FFT of the complex vector x, and it stores the result in vector y. For most purposes,
CFFT is superseded by the FFT routine CCFFT(3S).
Suppose arrays X and Y are dimensioned as follows:
COMPLE X X(0 :N- 1), Y(0 :N- 1)
Array X contains the input vector x:

x 0 , x 1 , x 2 , . . ., x n– 1
and CFFT computes the output vector y in the array Y:
y 0 , y 1 , y 2 ,. . ., y n– 1
according to the following formula:
n −1
yk = scale Σ
j =0
x j ω jk , for k = 0, 1, . . . , n −1
where
(isign )2πi
ω=e n
isign = ±1
π = 3.14159. . . e = 2.71828. . .
i = √−1
forward or inverse transform, and what the scale factor should be in either case. In this routine, when
isign = +1 it is called the forward transform, and when isign = – 1 it is called the inverse transform.
004– 2081– 002 195


Specifies whether to initialize the table array or to do the forward or inverse Fourier transform:
isign = 0 Initializes the table array
isign = +1 Computes the forward transform
isign = – 1 Computes the inverse transform
n Integer. (input)
Order of transform (the number of values in the input (or output) array). If n ≤ 0, the CFFT
returns without calculating a transform.
scale Real. (input)
Real scale factor. Each element of the output array is multiplied by scale after taking the
Fourier transform, as defined by the preceding formula.
x Complex array element. (input)
First element to be used in an array of values to be transformed. The array of input values has
the dimension  incx (n– 1)+1.
The increment between successive complex array elements in input array. To use every element,
set incx = 1. incx must not be 0.
y Complex array element. (output)
First element to be output in an array of transformed values.
The array of output values has the dimension  incy (n– 1)+1. The output array can be the same
as the input array. In that case, the transform is done in place, provided that the arrays are the
same size and that incx = incy.
The increment between successive complex array elements in the complex output array. To use
every element, set incy = 1. incy must not be 0.
table Real array of dimension ntable. (input or output)
Table of factors and trigonometric functions. This array can be initialized by a call to CFFT
with isign = 0.
Number of (real) words in the table array. The value of ntable should be at least 8n + 100. If
the value of ntable does not provide enough space, CFFT prints an error message and stops.
Work array. This is a scratch array used for intermediate calculations. It must be a different
address space from the input and output arrays.
Number of (real) words in the work array. The value of nwork should be at least 12n. If the
value of nwork does not provide enough space, CFFT prints an error message and stops.
196 004– 2081– 002

NOTES
This section contains information about the algorithm for CFFT, the initialization of the table array, the size
of the table and work arrays, and some performance tips.
Algorithm
The algorithm for CFFT is the "Four Step FFT," which is as follows:
Let n be the order of the transform.
Let n = n1 . n2; n1 and n2 are close to the square root of n, and they are chosen for performance. Then:
1. Perform n1 simultaneous n2-point FFTs on the n data elements, treated as an n1-by-n2 matrix.
jk
2. Multiply the resulting matrix by the phase factors α .
3. Transpose the resulting data array, treated as an n1-by-n2 matrix, into an n2-by-n1 matrix.
4. Perform n2 simultaneous n1-point FFTs on the n data elements, treated as an n2-by-n1 matrix.
CFFT includes a special case for n2 = 1, in which case, a conventional FFT is done.
Initialization
The table array is used to store factors of n1 and n2 and trigonometric tables that are used in calculation of
the FFT. You can initialize table explicitly by calling the routine with isign = 0. If you do not initialize
table, the routine does so automatically on the first call. If the value of the problem size, n, does not change
between calls, the table does not need to be reinitialized. If you call the routine with a different value of n
without first reinitializing the table, the routine reinitializes the table automatically.
Re-initialization of table is relatively time-consuming. If you are continually changing the problem size, you
might consider using more than one table array so that it will not have to be reinitialized on each subroutine
call.
If you initialize the table explicitly by calling the routine with isign = 0, the only arguments that are
significant are isign, n, table, and ntable. In this case, the other arguments are ignored.
The value of ntable is checked when the table is initialized to verify that the table space you provided is
large enough. If it is not, the routine stops after printing an error message, which indicates the amount of
table space required. (See the following subsection.)
Size of Table and Work Arrays
The precise sizes of the table and work arrays depend on the numbers n1 and n2 in the factorization of
n = n1 . n2.
ntable = 100 + 2(n1 + n2 + np)
nwork = 4np
where np = 2n if n2 is odd,
(2n + n1) if n2 is even
004– 2081– 002 197

Because the user does not know in advance the values of n1 and n2, the estimates given in the preceding
argument list may be used in all cases. If insufficient table or workspace is provided, the subroutine stops
after printing an error message that tells exactly how much space was needed.
Performance Tips
CFFT computes an FFT for any value of n, but the performance for a given value of n depends on the
factorization of n. This is characteristic of all FFT algorithms.
Best performance is realized when n is a power of 2. In that case, the number of arithmetic operations is
proportional to nlog 2 (n).
Performance is slightly worse when n contains factors of 3; it is even worse when n contains powers of 5.
The worst performance is when n is a prime number. In that case, the number of operations is proportional
2
to n . The kernel routines are optimized for values of n that are products of powers of 2, 3, and 5.
CFFT is rather slow for small values of n (for example, n < 128) because in such cases, the vector lengths
are very short. For small n, however, performance should not matter unless you are performing many
transforms. In this case, you should use the MCFFT(3S) routine (multiple complex FFT). MCFFT(3S)
vectorizes in the "lot direction," and performance can be quite good even for small values of n.
CFFT runs in multitasked mode for large values of n. If
MIN (n1, n2)
≥ 16
ncpus
where ncpus is the number of CPUs being used, the calculation runs in multitasked mode. The values of n
must be fairly large to realize an appreciable performance gain from multitasking, however, because the
vector lengths are proportional to the square root of n.
EXAMPLES
The following is a test program for CFFT. It computes the FFT of a random sequence of complex numbers,
first using the direct definition of the Fourier Transform, and then using CFFT. Afterward, it compares the
results. Finally, it computes the inverse transform (dividing by N), and compares with the original data.
PAR AMETER (N = 4*3 *5*7)
COM PLEX I, W, X(0 :N-1), Y(0 :N-1), YY( 0:N -1)
PAR AMETER (NT ABLE = 100 + 8*N, NWORK = 12* N)
REA L TAB LE( NTABLE ), WOR K(N WORK)
PAR AME TER (I = (0. 0, 1.0))
LOGICA L LFW D, LIN V
*-------- ------ --- --------- --- --- ------ ------ ------
* Ini tializ e input arr ay, X, wit h ran dom
* comple x num bers.
DO 10, J = 0, N-1
X(J) = CMPLX( RAN F(), RANF() )
10 CON TINUE
*-------- ------ --- --------- --- ------ ------ ------ ---
198 004– 2081– 002

* Com put e YY = the Fou rie r Tra nsf orm of X,

* usi ng the def initio n of the Fourie r transf orm .
PI = ATA N2( 0.0 , -1. 0)

W = EXP (2* PI* I/N)
DO 30, K = 0, N-1
YY( K) = 0.
DO 20, J = 0, N-1
YY( K) = YY( K) + X(J)*W **( J*K)
20 CON TIN UE
30 CON TIN UE
*-- ------ --- --- --- --- --- ------ --- --- --- ------ --- ---
* Com put e Y = the Fou rie r Tra nsf orm of X,
* usi ng cff t.
CAL L CFF T(+ 1, N, 1.0 , X, 1, Y, 1,

& TAB LE, NTA BLE , WOR K, NWO RK)
*-- ------ --- --- --- --- ------ ------ --- ------ --- --- ---
* Com par e Y and YY.
LFW D = .TR UE.

DO 40, J = 0, N-1
ERR OR = ABS (Y( J) - YY( J))/AB S(Y (J) )
LFW D = LFW D .AND. (ER ROR .LE . 1.E -6)
40 CON TIN UE
IF (.N OT. LFW D) PRINT *, ’Faile d for war d tes t’
IF (LF WD) PRI NT *, ’Forwa rd tra nsf orm OK’
*-- --- --- --- --- --- --- --- --- --- ------ --- --- --- ------
* Com put e the inv ers e tra nsform of Y,
* and sto re it back in Y.
CAL L CFF T(- 1, N, 1.0 /N, Y, 1, Y, 1,

*-- ------ --- --- --- --- ------ ------ --- ------ --- --- ---
* Com par e the tra nsf orm ed Y array wit h the
* ori gin al X arr ay.
LIN V = .TR UE.

DO 50, J = 0, N-1
ERR OR = ABS (X(J) - Y(J ))/ ABS (X( J))
LIN V = LIN V .AN D. (ER ROR .LE. 1.0 E-6 )
50 CON TIN UE
IF (.N OT. LIN V) PRI NT *, ’Fa iled inv ers e tes t’
IF (LI NV) PRI NT *, ’In verse tra nsf orm OK’
004– 2081– 002 199

IF (LFWD .AN D. LINV) PRINT *, ’Te st succee ded ’

END
SEE ALSO
CCFFT(3S), which supersedes most uses of CFFT
CCFFT2D(3S), CFFT2D(3S) to calculate a two-dimensional FFT. CCFFT2D(3S) supersedes most uses of
CFFT2D(3S).
CCFFT3D(3S), CFFT3D(3S) to calculate a three-dimensional FFT. CCFFT3D(3S) supersedes most uses of
CFFT3D(3S).
CCFFTM(3S), MCFFT(3S) to calculate multiple one-dimensional FFTs. CCFFTM(3S) supersedes most uses
of MCFFT(3S).
200 004– 2081– 002

CFFT2 ( 3S ) CFFT2 ( 3S )
NAME
CFFT2 – Applies a complex Fast Fourier Transform (FFT)
SYNOPSIS
CALL CFFT2 (init, ix, n, x, work, y)
IMPLEMENTATION
UNICOS systems
DESCRIPTION
CFFT2 performs the following calculation:
n −1
2πi
Σ xj
2
yk = exp (± j k ) for k = 0, . . ., n– 1, where i = – 1
j =0 n
The sign of the exponent is the same as the sign of the argument ix. This routine has the following
arguments:
init Integer. (input)
If nonzero, generates sine and cosine tables in work. If 0, calculates FFTs by using sine and
cosine tables of the previous call.
ix Integer. (input)
>0 Calculates a forward transform
<0 Calculates an inverse transform
n Integer. (input)
m
Size of the Fourier transform (2 , where m ≥ 3).
x Complex array of dimension n. (input)
Input vector. Range of x:
n 102466
≤ xi ≤ , for i = 1,2,. . .,n.
102466 n
Vector x can be equivalenced to the work vector. In this case, scratch work overwrites the
input values.
work Complex array of dimension 5 . n / 2. (scratch output)
Work storage vector.
y Complex array of dimension n. (output)
Result vector.
SEE ALSO
CCFFT(3S) (which supersedes CFFT2 only on Cray Y-MP systems), CCFFTM(3S), CRFFT2(3S),
RCFFT2(3S)
004– 2081– 002 201

CFFT2D ( 3S ) CFFT2D ( 3S )
NAME
CFFT2D – Applies a multitasked two-dimensional complex Fast Fourier Transform (FFT)
SYNOPSIS
CALL CFFT2D (isign, n1, n2, scale, x, inc1x, inc2x, y, inc1y, inc2y, table, ntable, work,
nwork)
IMPLEMENTATION
UNICOS systems
DESCRIPTION
CFFT2D computes the two-dimensional complex Fourier Transform of each column of the complex matrix
X, and it stores the results in the complex matrix Y. For most purposes, CFFT2D is superseded by
CCFFT2D(3S).
Suppose the matrices are stored in Fortran arrays dimensioned as follows:
COM PLEX X(0:N1 -1, 0:N 2-1 )
COM PLEX Y(0:N1 -1, 0:N 2-1 )
CFFT2D computes the following formula:
n1−1 n2−1
j1.k1 j2.k2
Y k1,k2 = scale Σ Σ
j1=0 j2=0
X j1,j2 ω1 ω2 for k1 = 0, . . ., n1– 1 k2 = 0, . . ., n2– 1
where:
(isign )2πi
ω1 = e n1
isign = ±1
π = 3.14159. . . e = 2.71828. . .
(isign )2πi
i = √−1 ω2 = e n2
In this documentation, when isign = +1 it is called the forward transform, and when isign = – 1 it is called
the inverse transform.
Specifies whether to initialize the table array, or whether to do the forward or inverse transform:
202 004– 2081– 002

n1 Integer. (input)
Transform size in the first dimension. If n1 is not positive, CFFT2D returns without performing
a transform.
n2 Integer. (input)
Transform size in the second dimension. If n2 is not positive, CFFT2D returns without
scale Real. (input)
Real scale factor. Each element of the output array is multiplied by scale after taking the
x Complex array. (input)
x increment in the first dimension (the address increment between successive complex row
elements of input array x). To use every row element in a given column, set inc1x = 1. inc1x
must not be 0.
x increment in the second dimension (the address increment between successive complex column
elements of input array x). To use every column element in a given row, set inc1x to be twice
the leading dimension of the complex array x. inc2x must not be 0.
y Complex array. (output)
Output array of transformed values. The output array may be the same as the input array. In
that case, the transform is done in place.
y increment in the first dimension (the address increment between successive complex row
elements of output array y). To use every row element in a given column, set inc1y = 1. inc1y
must not be 0.
y increment in the second dimension (the address increment between successive complex column
elements of output array y). To use every column element in a given row, set inc1y to be twice
the leading dimension of the complex array y. inc2y must not be 0.
Table of factors and trigonometric functions. This array may be initialized by a call to CFFT2D
with isign = 0.
Number of (real) words in table. The value of ntable should be at least 2(n1 + n2) + 100. If
not enough space is provided, CFFT2D prints an error message and stops.
work Real array. (scratch output)
Work array of size nwork. This is a scratch array used for intermediate calculations. It must be
a different address space from the input and output arrays.
004– 2081– 002 203


Number of words in the work array. The value of nwork should be at least
4(MAX(n1, n2)MIN(n1, n2, 16ncpus)) where ncpus is the number of CPUs used in the
calculation. If not enough space is provided, CFFT2D prints an error message and stops.
NOTES
This section includes information about the algorithm for CFFT2D, initialization of arrays, the significance
of the increment arguments, and performance.
Algorithm
CFFT2D uses MCFFT(3S) to do multiple FFTs, first on all of the columns of the input matrix and then on
all of the rows.
Initialization
The table array stores factors of n1 and n2 and also trigonometric tables that are used in the calculation of
the FFT. You can initialize table explicitly by calling the routine with isign = 0. If you do not initialize
table, the routine does so automatically on the first call. If the values of the problem size, n1 and n2, do not
change, the table does not need to be reinitialized. If you call the routine with different values of n1 and n2
without first reinitializing the table, the routine will reinitialize the table automatically.
Reinitialization of table is relatively time-consuming. If you are continually changing the problem size, you
might consider using more than one table array, so that it will not have to be reinitialized on each subroutine
call.
If you initialize the table explicitly by calling the routine with isign = 0, the only arguments that are
significant are isign, n1, n2, table, and ntable. In this case, the other arguments are ignored.
large enough. If it is not, the routine stops after printing an error message, which indicates the amount of
table space required.
Increment Arguments
The inc1x, inc2x, inc1y, and inc2y increment arguments describe how the matrices are stored in Fortran
arrays. These arguments are the link between the mathematical matrices and their representation in computer
memory.
Consider the following 4-by-5 matrix X:
X(1,1) X(1 ,2) X(1,3) X(1 ,4) X(1,5)
X(2,1) X(2,2) X(2 ,3) X(2 ,4) X(2 ,5)
X(3,1) X(3 ,2) X(3,3) X(3,4) X(3 ,5)
X(4,1) X(4,2) X(4 ,3) X(4 ,4) X(4 ,5)
Suppose that this matrix is declared by the following Fortran statement:

COMPLE X X(4 ,5)
204 004– 2081– 002

Fortran stores matrices "by column", in the following order:

X(1,1) , X(2 ,1) , X(3 ,1), X(4,1) , X(1 ,2), X(2,2) . . .
Thus, the increment in the first dimension, inc1x, is 1. The increment in the second dimension, inc2x, is the
(address) distance between X(1,1) and X(1,2), which is 4, the leading dimension of X. Generally, the
increment in the second dimension is the leading dimension of the array as it is declared in the Fortran
program.
The increment arguments are not directly related to the values of n1 and n2, except that the matrix must fit
in the allocated address space.
Performance Tips
CFFT2D works for any values of the arguments, subject only to the restrictions as described. The
performance of this algorithm, however, depends on the values of the following arguments:
• n1 and n2 (the problem size in each dimension)
• inc1x, inc2x, inc1y, inc2y (the increment arguments)
• nwork (the amount of workspace)
Each of these factors are considered separately in the following subsections.
Performance relative to the problem size
CFFT2D computes an FFT for any values of n1 and n2, but the performance depends on the factorization of
these numbers. This is characteristic of all FFT algorithms.
Best performance is realized when n1 and n2 are each a power of 2. In that case, the number of arithmetic
operations in the calculation is proportional to n1.n2.log 2 (n1.n2).
Performance is slightly worse when n1 or n2 contain factors of 3. It is worse if n1 or n2 contain factors of 5.
Worst performance is when n1 and n2 are prime numbers. In that case, the number of arithmetic operations
2
in the calculation is proportional to (n1 . n2) .
The kernel routines are optimized for values of n1 and n2 that are products of powers of 2, 3, and 5. The
values of n1 and n2 also relate to vectorization and multitasking performance. Each of the dimensions is
used as a vector length for part of the calculation. Thus, as with all vector calculations, performance is less
than optimal if either n1 or n2 is small (for example, < 8).
If either of the dimensions is large enough, CFFT2D will multitask. If
MIN (n1,n2)
≥16
ncpus
where ncpus is the number of CPUs being used, the entire calculation runs in multitasked mode.
Performance relative to the increment arguments
The increment arguments have no effect on the algorithm itself, but their values are significant for memory
contention.
004– 2081– 002 205

The stride for vector loads is, alternately, inc1x and inc2x. To avoid memory bank conflicts, neither number
should be a large multiple of 2. Best performance occurs when both numbers are odd. One way to do this
is to make the leading dimension of array x an odd number when the array is declared in the calling
program.
Likewise, the stride for vector stores are inc1y and inc2y, and the best performance occurs when both
numbers are odd.
Performance relative to the amount of workspace
To do all of the FFTs in one lot, the workspace required (in real words of storage) is nwork = 4 . n1 . n2.
If n1 and n2 are large, this amounts to a lot of memory. You can provide less workspace and still obtain
very good performance. At a minimum, you need the following amount of storage, in (real) words:
nwork = 4(MAX(n1, n2)MIN(n1, n2, 16ncpus))
where ncpus is the number of CPUs being used. If you give a value of nwork in the range:
4(MAX(n1, n2)MIN(n1, n2, 16ncpus)) ≤ nwork < 4(n1n2)
CFFT2D divides the work into lots, in which the size of each lot is sufficiently small to be accommodated
by the workspace provided. For best performance, nwork should be at least 128(n1n2)ncpus.
EXAMPLES
The following program computes the forward and inverse two-dimensional Fourier transform of a random
matrix of complex numbers and compares the result with the original matrix.
PARAMETER (N1 = 256 , N2 = 300 )
COMPLE X X(N 1, N2) , Y(N 1, N2)
PARAME TER (NTABL E = 100 + 2*( N1 + N2) )
PAR AMETER (NW ORK = 4*N 1*N2)
REAL TABLE( NTABLE ), WOR K(NWOR K)
LOGICAL LPASS
*----- --- ------ ------ --- ------ --- --- --- ------ ------
* Fil l array X wit h ran dom com ple x num bers.
DO 2, J = 1, N2
DO 1, I = 1, N1
X(I ,J) = CMPLX( RAN F(), RANF() )
1 CON TIN UE
2 CONTINUE
*----------- --- ------ ------ --- --- ------ --- --- --- ---
* Comput e Y = 2-D Fou rie r tra nsf orm of X.
CAL L CFF T2D(+1 , N1, N2, 1.0 ,

& X, 1, N1, Y, 1, N1,
& TABLE, NTA BLE , WOR K, NWO RK)
*----- --- ------ ------ --- ------ --- --- --- ------ ------
206 004– 2081– 002

* Com put e Y = inv ers e 2-D tra nsf orm of Y.
CAL L CFF T2D (-1 , N1, N2, 1.0 /(N 1*N 2),
& Y, 1, N1, Y, 1, N1,
& TABLE, NTA BLE, WORK, NWO RK)
*-- --- --- --- --- --- --- --- --- --- ------ --- --- --- ------
* Com par e X and Y.
LPA SS = .TR UE.

DO 5, J = 1, N2
DO 4, I = 1, N1
ERR OR = ABS (X( I,J)-Y (I, J)) / ABS(X( I,J ))
LPA SS = LPA SS .AND. (ER ROR .LE . 1.0 E-6 )
4 CON TIN UE
5 CON TIN UE
IF (.N OT. LPA SS) PRI NT *,’ Fai led the tes t’
IF (LP ASS ) PRI NT *, ’Pa sse d the test’
END
SEE ALSO
CCFFT(3S), CFFT(3S) to calculate a one-dimensional FFT. CCFFT(3S) supersedes most uses of CFFT(3S).
CCFFT2D(3S), which supersedes most uses of CFFT2D
CFFT3D(3S).
of MCFFT(3S).
004– 2081– 002 207

NAME
CFFT3D – Applies a multitasked three-dimensional complex Fast Fourier Transform (FFT)
SYNOPSIS
CALL CFFT3D (isign, n1, n2, n3, scale, x, inc1x, inc2x, inc3x, y, inc1y, inc2y, inc3y,
table, ntable, work, nwork)
IMPLEMENTATION
UNICOS systems
DESCRIPTION
CFFT3D computes the three-dimensional complex Fourier transform of the complex matrix X, and it stores
the results in the complex matrix Y. For most purposes, CFFT3D is superseded by CCFFT3D(3S).
On this man page, the first dimension of a three-dimensional matrix is defined as the row dimension, the
second dimension is the column dimension, and the third dimension is the plane dimension.
Suppose that the matrices are stored in Fortran arrays, which are declared as follows:
COM PLEX X(0:N1 -1, 0:N 2-1 , 0:N 3-1 )
COM PLEX Y(0:N1 -1, 0:N 2-1 , 0:N 3-1 )
CFFT3D computes the following formula:

n1−1 n2−1 n3−1
j1.k1 j2.k2 j3.k3
Y k1,k2,k3 = scale Σ j2=0
j1=0
Σ j3=0
Σ X j1, j2, j3 ω1 ω2 ω3
for k1 = 0,. . .,n1– 1, k2 =0, . . ., n2– 1, k3 =0, . . ., n3– 1

where:
isign . 2 . π . i
ω1 = e n1
isign = ±1
isign . 2 . π . i
ω2 = e n2
e = 2.71828. . .
isign . 2 . π . i
ω3 = e n3
π = 3.14159. . .
i =√−1
forward or the inverse transform, and what the scale factor should be in either case. In this documentation,
when isign = +1, it is called the forward transform, and when isign = – 1, it is called the inverse transform.
as follows:
208 004– 2081– 002


n1 Integer. (input)
Transform size in the first dimension. If n1 is not positive, CFFT3D returns without computing
any transform.
n2 Integer. (input)
Transform size in the second dimension. If n2 is not positive, CFFT3D returns without
computing any transform.
n3 Integer. (input)
Transform size in the third dimension. If n3 is not positive, CFFT3D returns without computing
any transform.
scale Real. (input)
First element to be used in an input array of values to be transformed.
Input array increment in the first dimension (the address increment between successive complex
array row elements in a given column and plane of the input array). To access successive row
elements in a given column and plane of the declared input array, set inc1x = 1. inc1x must not
be 0.
Input array increment in the second dimension (the address increment between successive
complex array column elements in a given row and plane of the input array). To access
successive column elements in a given row and plane of the declared input array, set inc2x to be
the declared leading dimension of the input array. inc2x must not be 0.
Input array increment in the third dimension (the address increment between successive complex
array plane elements in a given row and column of the input array). To access successive plane
elements in a given row and column of the declared input array, set inc3x to be the product of
the two leading dimensions of the input array. inc3x must not be 0.
First element to be output in the array of transformed values. The output array may be the same
as the input array, in which case, the transform is done in place if the following are true:
inc1x = inc1y
inc2x = inc2y
inc3x = inc3y
004– 2081– 002 209


Output array increment in the first dimension (the address increment between successive complex
array row elements in a given column and plane of the output array). To access successive row
elements in a given column and plane of the declared input array, set inc1y = 1. inc1y must not
be 0.
Output array increment in the second dimension (the address increment between successive
complex array column elements in a given row and plane of the output array). To access
successive column elements in a given row and plane of the declared input array, set inc2y to be
the declared leading dimension of the input array. inc2y must not be 0.
Output array increment in the third dimension (the address increment between successive
complex array plane elements in a given row and column of the output array). To access
successive plane elements in a given row and column of the declared output array, set inc3y to
be the product of the two leading dimensions of the output array. inc3y must not be 0.
Table of factors and trigonometric functions. This array can be initialized by a call to CFFT3D
with isign = 0.
Number of (real) words in the table array. The value of ntable should be at least
2(n1 + n2 + n3) + 100. If the value of ntable does not provide enough space, CFFT3D prints an
error message and stops.
work Real array. (scratch output)
Work array of size nwork. This is a scratch array used for intermediate calculations. It must be
a different address space from the input and output arrays.
Number of words in the work array. The value of nwork should be at least 64(MAX(n1, n2, n3)).
If the value of nwork does not provide enough space, CFFT3D prints an error message and
stops.
NOTES
This section includes information about the algorithm for CFFT3D, table initialization, increment arguments,
and performance tips.
Algorithm
CFFT3D uses MCFFT(3S) to do multiple FFTs first on all of the rows, then on all of the columns, and then
on all of the planes of the input matrix.
210 004– 2081– 002

Table Initialization
The table array stores factors of n1, n2, and n3 and also trigonometric tables that are used in calculation of
the FFT. You can initialize table explicitly by calling CFFT3D with isign = 0. If you do not initialize
table, CFFT3D does so automatically on the first call. If the values of the problem size, n1, n2, and n3, do
not change, table does not need to be reinitialized. If you call CFFT3D with different values of n1, n2, and
n3 without reinitializing table first, CFFT3D reinitializes table automatically.
might consider using more than one table array, so that it will not have to be reinitialized on each call to
CFFT3D.
If you initialize table explicitly by calling the routine with isign = 0, the only arguments that are significant
are isign, n1, n2, n3, table, and ntable. In this case, the other arguments are ignored.
CFFT3D checks the value of ntable to ensure that enough space is available to store the entire table. If
ntable is not large enough, the routine stops after printing an error message, which indicates the amount of
table space required.
Increment Arguments
The inc1x, inc2x, inc3x, inc1y, inc2y, and inc3y increment arguments describe how the matrices are stored in
Fortran arrays. These arguments are the link between the mathematical matrices and their representation in
computer memory. The use of these increment arguments allows complete generality in specifying the
matrices. Because CFFT3D deals with three-dimensional matrices, some explanation is necessary.
Consider the following 2-by-3-by-4 matrix X:
X(1 ,1,1) X(1 ,2,1) X(1 ,3, 1)
X(2,1, 1) X(2,2, 1) X(2,3, 1)
X(1 ,1,2) X(1 ,2,2) X(1 ,3, 2)

X(2,1, 2) X(2,2, 2) X(2 ,3,2)
X(1 ,1,3) X(1 ,2,3) X(1 ,3, 3)

X(2,1, 3) X(2,2, 3) X(2,3, 3)
X(1 ,1,4) X(1 ,2,4) X(1 ,3, 4)

X(2,1, 4) X(2,2, 4) X(2 ,3,4)
Suppose that this matrix is declared by the Fortran statement:

COM PLEX X(2,3,4)
Fortran stores matrices "by column," meaning that it stores the matrix so that the first index changes most
rapidly and the last index changes least rapidly, which results in the following order:
004– 2081– 002 211

X(1 ,1, 1) –> X(2 ,1, 1) –> X(1 ,2, 1) –> X(2 ,2, 1) –> X(1 ,3, 1) –> X(2 ,3, 1) –>
X(1 ,1, 2) –> X(2 ,1, 2) –> X(1 ,2, 2) –> X(2 ,2, 2) –> X(1 ,3, 2) –> X(2 ,3, 2) –>
X(1 ,1, 3) –> X(2 ,1, 3) –> X(1 ,2, 3) –> X(2 ,2, 3) –> X(1 ,3, 3) –> X(2 ,3, 3) –>
X(1 ,1, 4) –> X(2 ,1, 4) –> X(1 ,2, 4) –> X(2 ,2, 4) –> X(1 ,3, 4) –> X(2 ,3, 4)
Thus, the increment in the first dimension, inc1x, is 1. The increment in the second dimension, inc2x, is the
(address) distance between X(1,1,1) and X(1,2,1), which is 2, the leading dimension of X.
The increment in the third dimension, inc3x, is the (address) distance between X(1,1,1) and X(1,1,2),
which is 6. This number 6 is the product of the first two leading dimensions of X.
Generally, the increment in the second dimension is the leading dimension of the array as it is declared in
the Fortran program, and the increment in the third dimension is the product of the two leading dimensions
of the array.
The increment arguments are not directly related to the values of n1, n2, and n3, except that the matrix must
fit in the allocated address space.
Negative increments are legal. If a row, column, or plane increment is negative, the address given as the x
or y argument should be the address of the first element used in the array (last in memory) by row number,
column number, or plane number.
Performance Tips
CFFT3D works for any values of the arguments, subject only to the restrictions given previously. The
• n1, n2, n3: problem size in each dimension
• inc1x, inc2x, inc3x, inc1y, inc2y, inc3y: increment arguments
• nwork: (amount of workspace)
Each of these factors is considered separately in the following subsections.
Performance relative to the problem size
CFFT3D computes an FFT for any value of n1, n2, and n3, but the performance depends on the factorization
of these numbers. This is characteristic of all FFT algorithms.
Best performance is realized when n1, n2, and n3 are each a power of 2. In that case the number of
arithmetic operations in the calculation is proportional to
n1 . n2 . n3 . log 2 (n1 . n2 . n3).
Performance is slightly worse when n1, n2, or n3 contain factors of 3. It is worse if n1, n2, or n3 contain
factors of 5. Worst performance is when n1, n2, and n3 are prime numbers. In that case, the number of
2
arithmetic operations in the calculation is proportional to (n1 . n2 . n3) .
The kernel routines are optimized for values of n1, n2, and n3 that are products of powers of 2, 3, and 5.
The values of n1, n2, and n3 also relate to vectorization and multitasking performance. Each of the
dimensions is used as a vector length for part of the calculation. Thus, as with all vector calculations,
performance will be less than optimum if either n1, n2, or n3 is small (for example, < 8).
212 004– 2081– 002

If any of the dimensions is large enough, CFFT3D will multitask. If

MIN (n1,n2,n3)
≥16,
ncpus
where ncpus is the number of CPUs being used, the entire calculation runs in multitasked mode.
Performance relative to the increment arguments
contention.
The stride for vector loads alternates between inc1x, inc2x, and inc3x. Likewise, the strides for vector stores
are inc1y, inc2y, and inc3y. To avoid memory bank conflicts, none of these numbers should be a multiple of
a large power of 2. Best performance occurs when all these numbers are odd. To ensure this, declare both
the input and output arrays with odd numbers for both of the two leading dimensions.
The size of the workspace, nwork, is also relevant to performance. To do all of the FFTs in one lot requires
the following amount of workspace (in real words of storage):
nwork = 4(MAX(n1,n2)MAX(n2,n3))
If n1, n2, and n3 are large, this amounts to a lot of memory. You can provide less workspace and still
obtain very good performance. At a minimum, you need the following (in real words of storage):
nwork = 4(MAX(n1,n2,n3)MIN(n1,n2,n3,16ncpus))
where ncpus is the number of CPUs being used. If you specify less than this minimum, CFFT3D generates
an error message. If you give a value of nwork in the range:
4(MAX(n1,n2,n3) MIN(n1,n2,n3,16ncpus)) ≤ nwork < 4((MAX(n1,n2)MAX(n2,n3))
CFFT3D divides the work into lots, in which the size of each lot is sufficiently small to be accommodated
by the workspace provided. For best performance, nwork should be at least 128(n1 . n2 . n3 . ncpus).
EXAMPLES
The following program computes the forward and inverse two-dimensional Fourier transform of a random
matrix of complex numbers and compares the result with the original matrix.
PARAME TER (N1 = 16, N2 = 18, N3 = 25)
COMPLE X X(N 1, N2, N3) , Y(N 1, N2, N3)
PAR AMETER (NT ABL E = 100 + 2*(N1 + N2 + N3) )
PAR AMETER (NW ORK = 4*N 2*N 3)
REA L TAB LE( NTABLE ), WOR K(N WORK)
LOG ICAL LPASS
*-------- --- ------ ------ --- ------ --- --- --- --- --- ---
* Fill array X with random com plex number s.
DO 3, K = 1, N3
DO 2, J = 1, N2
DO 1, I = 1, N1
X(I ,J, K) = CMPLX( RAN F() , RAN F() )
004– 2081– 002 213

1 CONTIN UE
2 CONTIN UE
3 CONTIN UE
*----- --- ------ ------ --- ------ --- --- --- ------ ------
* Com put e Y = 3-D Fourie r tra nsf orm of X.
CALL CFF T3D(+1 , N1, N2, N3, 1.0 ,
& X, 1, N1, N1* N2, Y, 1, N1, N1* N2,
*----------- --- ------ ------ --- ------ --- --- --- --- ---
* Comput e Y = Invers e 3-D tra nsform of Y.
CALL CFF T3D(-1 , N1, N2, N3, 1.0 /(N 1*N 2*N 3),
& Y, 1, N1, N1* N2, Y, 1, N1, N1* N2,
*----------- --- ------ ------ --- ------ --- --- --- --- ---
* Compare X and Y.
LPA SS = .TR UE.
DO 6, K = 1, N3
DO 5, J = 1, N2
DO 4, I = 1, N1
ERR OR = ABS (X(I,J ,K) -Y( I,J ,K))/A BS(X(I ,J,K))
LPASS = LPA SS .AN D. (ERROR .LE . 1.0 E-6 )
4 CON TINUE
5 CONTIN UE
6 CONTIN UE
IF (.N OT. LPASS) PRINT *,’ Failed the test’
IF (LP ASS) PRINT *, ’Pa sse d the test’
END
SEE ALSO
CCFFT(3S), CFFT(3S) to calculate a one-dimensional FFT. CCFFT(3S) supersedes most uses of CFFT(3S).
CFFT2D(3S).
CCFFT3D(3S), which supersedes most uses of CFFT3D
of MCFFT(3S).
214 004– 2081– 002

CFFTMLT ( 3S ) CFFTMLT ( 3S )
NAME
CFFTMLT – Applies complex-to-complex Fast Fourier Transforms (FFTs) on multiple input vectors
SYNOPSIS
CALL CFFTMLT (ar, ai, work, trigs, ifax, inc, jump, n, lot, isign)
IMPLEMENTATION
UNICOS systems
DESCRIPTION
This routine is inow obsolete. It has been replaced by CCFFTM. See the CCFFTM man page for details on
its use.
CFFTMLT applies complex-to-complex FFTs on more than one input vector, as follows:
(ar (jump .l +inc .k +1),ai (jump .l +inc .k +1)) =
n −1
isign .i .2.π. j .k )
Σ exp(
j =0 n
(ar (jump .l +inc . j +1), ai (jump .l +inc . j +1))
for
k = 0,1,. . .,n– 1
l = 0, . . ., lot– 1,
i = √−1
This calculation is performed for each of the n vectors in the input.
Vectorization is achieved by doing parallel transforms, with vector length = lot.
ar Real array of dimension n . lot. (input and output)
On input, it contains the real part of the input data. On output, it contains the real part of the
transformed data.
ai Real array of dimension n . lot. (input and output)
On input, it contains the imaginary part of the input data. On output, it contains the imaginary
part of the transformed data.
work Real array of dimension 4 . n . lot. (scratch output)
Work storage array.
trigs Real array of dimension 2*n. (input)
Must be initialized to contain sine and cosine tables. The following call initializes both trigs
and ifax:
CAL L CFTFAX (n,ifax,trigs)
004– 2081– 002 215

CFFTMLT ( 3S ) CFFTMLT ( 3S )
ifax Integer array of dimension 19. (input)

Contains a previously prepared list of factors of n.
inc Integer. (input)
The increment within each data vector.
jump Integer. (input)
The increment between the start of each data vector. inc and jump apply to both the real and
imaginary parts of the data. To obtain best performance, jump should be an odd number.
n Integer. (input)
Length of the data vectors. On UNICOS systems, n ≥ 0.
Any value of n that is not valid causes CFTFAX to return the error code ifax(1) = – 99.
The number of data vectors.
isign = +1 Fourier analysis (forward transform)
isign = – 1 Fourier synthesis (inverse transform)
NOTES
In the division by n, the normalization used by CFFTMLT differs from that used by CFFT2, CRFFT2, and
RCFFT2.
SEE ALSO
CCFFTM(3S), which supersedes this routine only on Cray Y-MP systems
RFFTMLT(3S) to calculate multiple real-to-complex or complex-to-real FFTs
216 004– 2081– 002

CRFFT2 ( 3S ) CRFFT2 ( 3S )
NAME
CRFFT2 – Applies a complex-to-real Fast Fourier Transform (FFT)
SYNOPSIS
CALL CRFFT2 (init, ix, n, x, work, y)
IMPLEMENTATION
UNICOS systems
DESCRIPTION
CRFFT2 calculates the following:
n −1
2πi
yk = Σ xj
j =0
exp (±
n
jk ) for k = 0,1,. . .,n– 1

If nonzero, generates sine and cosine tables in work. If 0, calculates FFT by using sine and
ix Integer. (input)
> 0 Calculates a forward transform (analysis).
< 0 Calculates an inverse transform (synthesis).
n Integer. (input)
m
Size of the Fourier transform (2 , for some m ≥ 3).
x Complex array of dimension (n / 2) + 1. (input)
Input vector.
n 102466
Range of x: 2466
≤ xi ≤ for i = 1,2,. . .,n.
10 n
work Complex array of dimension (3 . n/2) + 2. (input)
y Real array of dimension n. (input)
Result vector.
NOTES
x j elements are complex and related by x j = x ((n– j)) for j = 1,2,. . .,(n / 2).
Only the first (n / 2)+1 elements are stored in x.
004– 2081– 002 217

CRFFT2 ( 3S ) CRFFT2 ( 3S )
SEE ALSO
CFFT2(3S), RCFFT2(3S)
SCFFT(3S) for a description of CSFFT, a routine that supersedes CRFFT2 only on UNICOS systems
218 004– 2081– 002

DESCINIT3D ( 3S ) DESCINIT3D ( 3S )
NAME
DESCINIT3D – Initializes a descriptor vector that contains information about the distribution of a
three-dimensional (3D) array across a 3D grid of processors
SYNOPSIS
CALL DESCINIT3D (desc, nx, ny, nz, nxpp, nypp, nzpp, pesx, pesy, pesz, ictxt, lldx, lldy,
info)
IMPLEMENTATION
UNICOS/mk systems
DESCRIPTION
DESCINIT3D initializes a descriptor vector desc with information about the distribution of a 3D array A
across a 3D grid of processors. The information contained in this descriptor vector allows any routine that
uses distributed 3D arrays to know how the data is distributed across the processors. To specify a lower
dimensional grid of processors, initialize the corresponding entries in the descriptor vector to be 1.
Description of the Distributed Data
Consider a 3D array A, which is passed to a distributed library routine to be operated on. Let this 3D array
A of global size nx-by-ny-by-nz be distributed over a 3D grid of processors of size npx-by-npy-by-npz where
N$PES = npx x npy x npz.
To specify a two-dimensional (2D) grid of processors, the dimension any one of npx, npy, or npz could be
initialized to 1.
Each processor is assigned an address to denote its location in the 3D grid. The routine that initializes the
3D grid is called GRIDINIT3D(3S), and the user must first call it before calling DESCINIT3D (see the
man pages for GRIDINIT3D(3S)). This sets up the processor set as a 3D grid of processors. If you
initialized a 3D grid of size npx-by-npy-by-npz, the call to GRIDINIT3D(3S) would be as follows:
CALL GRIDIN IT3 D (ictxt, npx, npy, npz)
Other support routines are provided to help manage 3D-processor grids:

GRIDINFO3D(3S) Provides information about the processor grid and must be called after
GRIDINIT3D(3S) if necessary.
PCOORD3D(3S) Determines the grid coordinates of the processor given the processing element (PE)
number.
PNUM3D(3S) Determines the PE number given the grid coordinates.
As allowed by Fortran D or High-Performance Fortran (HPF), the array A could be distributed across the
processor grid in one of four ways across each dimension, that is, degenerate, block, block-cyclic, and cyclic.
Descriptor desc specifies this distribution.
004– 2081– 002 219

The nxpp, nypp, and nzpp arguments are initialized to the block size along each of the dimensions. Consider
the X dimension. If all of the data along this dimension will reside on the same processor (degenerate
distribution), nxpp would have the same value as nx. If the distribution is block, nxpp would be initialized
to ICEIL(nx, npx). If the distribution were cyclic, nxpp would be initialized to 1, and if the distribution
were block-cyclic, nxpp would be initialized to the corresponding block size.
Distribution along X Dimension Value of nxpp
Degenerate nxpp = nx
Block nxpp = ICEIL(nx, npx)
Cyclic nxpp = 1
Block-cyclic nxpp = block size desired
The nypp and nzpp arguments are initialized accordingly.
As an example, consider an array A of size 128-by-200-by-100 distributed on a 128-processor 2D grid of
size 1-by-16-by-8, as follows:
nx = 128
ny = 200
nz = 100
npx = 1
npy = 16
npz = 8
Let the distribution be degenerate along the X axis, block along the Y axis, and block-cyclic with a size of 4
along the Z axis, then
nxpp = 128
nypp = ICEIL( 200 ,16) = 13
nzpp = 4
The pesx, pesy, and pesz arguments are the grid coordinates of the processor specifying the location of the
first element of the global array A (that is, the processor that owns A(1,1,1)).
If the first element is in processor pes, then pesx, pesy, and pesz can be obtained by a call to
PCOORD3D(3S), as follows:
CALL PCOORD3D (ictxt, pes, pesx, pesy, pesz)
The first global element of the array A given by A(1,1,1) is usually located in processor 0. Therefore, the
following is true:
pesx = 0
pesy = 0
pesz = 0
220 004– 2081– 002

However, in some cases it is advantageous to align array A in a slightly skewed manner in regard to another
array to avoid some communication. The following example illustrates this in the one-dimensional case.
Consider two vectors X and Y of length N that are involved in the computation (globally speaking) of a third
vector Z, as follows:
do i = 1, N
Z(i ) = X(i ) + Y(m od( i+N /2, N))
end do
In this example, the vector Y is to be stored in a skewed manner in regard to X so that the first element of X
will reside on the same processor that has Y(mod(1+N/2),N). If pesx were this processor, in the
descriptor for the vector X, the user would pass pesx to the routine to initialize that variable. You can
extend this idea to the other two dimensions.
However, as mentioned earlier, most applications would not require this flexibility in the data distribution;
therefore, pesx, pesy, and pesz in these applications would be initialized to 0.
The ictxt argument is a handle that describes the 3D partitioning of the set of processors done by
GRIDINIT3D(3S).
The lldx and lldy arguments are the leading dimensions of the local array in each processor that stores a
share of the global data.
If the distribution along the X or Y axes were degenerate, lldx ≥ nx and lldy ≥ ny, respectively.
If the distribution were block along either dimension, lldx ≥ ICEIL(nx,npx) and lldy ≥ ICEIL(ny,npy).
If the distribution were cyclic along either dimension, lldx ≥ INT(nx/npx) + 1 and lldy ≥ INT(ny/npy) + 1.
If the distribution were block-cyclic along either dimension with a block size of nxpp and nypp,
lldx ≥ INT(nx/(npx*nxpp)) + nxpp and lldy ≥ INT(ny/(npy*nypp)) + nypp.
The following example uses the previous example with this change: where the array A of size
128-by-200-by-100 was distributed on a 128-processor 2D grid of size 1-by-16-by-8 with the data along the
X axis being degenerate and the data along the Y axis being block, the following is true:
nx = 128
ny = 200
nz = 100
npx = 1
npy = 16
npz = 8
lldx ≥ 128 and lldy ≥ 13
004– 2081– 002 221

The DESCINIT3D routine accepts the following arguments.

desc Vector of length 12. (output)
Contains information about the distribution of 3D data across a 3D grid of processors.
nx Integer. (input)
Global size of the array along the X axis.
ny Integer. (input)
Global size of the array along the Y axis.
nz Integer. (input)
Global size of the array along the Z axis.
nxpp Integer. (input)
Block size of the distribution along the X axis.
nypp Integer. (input)
Block size of the distribution along the Y axis.
nzpp Integer. (input)
Block size of the distribution along the Z axis.
pesx Integer. (input)
X coordinate of the processor address that specifies the location of element (1,1,1) of the global
array.
pesy Integer. (input)
Y coordinate of the processor address that specifies the location of element (1,1,1) of the global
array.
pesz Integer. (input)
Z coordinate of the processor address that specifies the location of element (1,1,1) of the global
array.
ictxt Integer. (input)
The context variable initialized by GRIDINIT3D(3S). This is a handle that describes the grid.
lldx Integer. (input)
Local leading X dimension of the local array that contains a processors share of the global array.
lldy Integer. (input)
Local leading Y dimension of the local array that contains a processors share of the global array.
info Integer. (output)
Variable to indicate error status. A value of 0 is returned in the info argument if all of the
arguments passed to DESCINIT3D have legal values. A nonzero value is returned if any of the
arguments have illegal values.
222 004– 2081– 002

NOTES
The GRIDINIT3D(3S) routine must be called somewhere in the program before the first call to
DESCINIT3D.
SEE ALSO
GRIDINFO3D(3S), GRIDINIT3D(3S), PCOORD3D(3S), PNUM3D(3S)
004– 2081– 002 223

FILTERG ( 3S ) FILTERG ( 3S )
NAME
FILTERG – Computes a correlation of two vectors
SYNOPSIS
CALL FILTERG (a, m, d, n, o)
IMPLEMENTATION
UNICOS systems
DESCRIPTION
FILTERG computes a correlation of two vectors.
Given the following:
(a i ) i = 1,. . .,m Filter coefficients
(d j ) j = 1,. . .,n Data
FILTERG computes the following:
m
oi = Σ
j =1
a j di +j −1 i =1,. . . n−m +1

a Real array of dimension m. (input)
Vector of filter coefficients.
m Integer. (input)
Number of filter coefficients.
d Real array of dimension n. (input)
Data vector.
n Integer. (input)
Number of data points.
o Real array of dimension n– m+1. (output)
Resulting vector.
SEE ALSO
FILTERS(3S)
224 004– 2081– 002

FILTERS ( 3S ) FILTERS ( 3S )
NAME
FILTERS – Computes a correlation of two vectors (symmetric coefficient)
SYNOPSIS
CALL FILTERS (a, m, d, n, r)
IMPLEMENTATION
UNICOS systems
DESCRIPTION
FILTERS computes the same correlation as FILTERG(3S) except that it assumes the filter coefficient vector
is symmetric.
Given the following:
m 
(c i ) i = 1, . . .,  
 2 
(d j ) j=1,. . . n
m  m
  = for m even, and (m+1)/2 for m odd.
 
2 2
This is called the ceiling function.
FILTERS computes the following when m is an odd number:
(m −1)
2
ri = Σ
j =1
a j . (di +j −1 + di +m −j ) + a (m +1) . d
i +(
m +1)
2 2
i=1, . . ., n– m+1
FILTERS computes the following when m is an even number:
m
2
ri = Σ aj
j =1
. (di +j −1 + di +m −j )
i=1, . . ., n– m+1
a Real array of dimension  m / 2  . (input)
Symmetric filter coefficient vector.
m Integer. (input)
Formal length of vector a. The actual length of a is as indicated previously.
004– 2081– 002 225

FILTERS ( 3S ) FILTERS ( 3S )
d Real array of dimension n. (input)

Data vector.
n Integer. (input)
Number of data points.
r Array of dimension n– m+1. (output)
Resulting vector.
SEE ALSO
FILTERG(3S)
226 004– 2081– 002

GGFFT ( 3S ) GGFFT ( 3S )
NAME
GGFFT – Applies a multitasked complex-to-complex Fast Fourier Transform (FFT)
SYNOPSIS
CALL GGFFT (isign, n, scale, x, y, table, work, isys)
IMPLEMENTATION
UNICOS/mk systems
DESCRIPTION
GGFFT computes the Fast Fourier Transform (FFT) of the complex vector x, and it stores the result in vector
y.
COMPLE X(KIND =4) X(0 :N- 1), Y(0 :N- 1)
The output array is the FFT of the input array, using the following formula for the FFT:
n −1
Σ
. j .k
Yk = scale . X j . ωisign for k = 0, . . ., n −1
j =0
where
2.π.i
ω=e n
i = +√−1
π = 3.14159. . .
isign = ±1
scale.
the mathematical inverse function is computed by taking the FFT with – isign and 1 / (n . scale). In
using isign = – 1 and scale = 1.0/n.
The output array may be the same as the input array, provided that n has at least 2 factors.
004– 2081– 002 227


isign INTEGER(KIND=8). (input)
as follows:
Size of the transform; that is, the number of values in the input array (all systems): n ≥ 2
scale REAL(KIND=4). (input)
transform, as defined by the preceding formula.
x COMPLEX(KIND=4) array of dimension (0:n– 1). (input)
y COMPLEX(KIND=4) array of dimension (0:n– 1). (output)
transformed values.
table REAL(KIND=4) array of dimension 2n. (input or output)
Table of factors and trigonometric functions. If isign = 0, the routine initializes table (table is
output only). If isign = +1 or – 1, the values in table are assumed to be initialized already by a
prior call with isign = 0 (table is input only).
work REAL(KIND=4) array of dimension 4n. (input or output)
be different address space from that of the input and output arrays.
isys INTEGER(KIND=8)array of dimension (0:isys(0)). (input and output)
The first element of the array specifies how many more elements are in the array.
Use isys to specify certain processor-specific parameters or options.
If isys(0) = 0, the default values of such parameters are used. In this case, the argument value
can be given as the scalar integer constant 0.
If isys(0) > 0, isys(0) gives the upper bound of the isys array; that is, if il = isys(0), user-
specified parameters are expected in isys(1) through isys(il).
228 004– 2081– 002

NOTES
This section contains information about the algorithm for GGFFT, the initialization of the table array, the
details.
Algorithm
The algorithm used is a variant of Agarwal’s algorithm.
Initialization
The table array stores the trigonometric tables used in calculation of the FFT. You must initialize table by
calling the routine with isign = 0 prior to doing the transforms. If the value of the problem size, n, does not
change, table does not have to be reinitialized.
Dimensions
COMPLE X(KIND =4) X(0 :N- 1)
COMPLE X(KIND =4) Y(0 :N- 1)
However, if you prefer to use the more customary Fortran style with subscripts starting at 1 you do not have
to change the calling sequence, as in (assuming N > 0):
COMPLE X(KIND =4) X(N )
COMPLE X(KIND =4) Y(N )
Performance Tips
Fastest performance is realized when n is a power of 2; in which case, the number of floating-point
operations is approximately 5n . log 2 (n).
required. If n contains powers of 5, it is longer still. Slowest performance is when n is a prime number; in
2
which case, the number of floating-point operations is approximately 8n .
The kernel routines are optimized for values of n that are products of powers of 2, 3, and 5. (Because the
kernel routines have a special case for multiples of 4, powers of 4 will be slightly faster than odd powers of
2.)
subroutine call requires no change, but you may have to change array sizes in the DIMENSION or type
statements that declare the arrays.
004– 2081– 002 229

• The second area is the isys parameter array, an array that gives certain implementation-specific
information. All features and functions of the FFT routines specific to any particular implementation are
confined to this isys array. On any implementation, you can use the default values by using an argument
value of 0.
EXAMPLES
Example 1: Initialize the complex array TABLE in preparation for doing an FFT of size 1024. Only the
ISIGN, N, and TABLE arguments are used in this case; you can use dummy arguments or zeros for the
other arguments in the subroutine call.
REAL(KIND =4) TABLE( 100 + 8*1024 )
CALL GGFFT( 0, 1024, 0.0 , DUMMY, DUM MY, TAB LE, DUMMY, 0)
Example 2: X and Y are complex arrays of dimension (0:1023). Take the FFT of X and store the results in
Y. Before taking the FFT, initialize the TABLE array, as in example 1.
COMPLEX(KIND =4) X(0 :10 23) , Y(0 :10 23)
REAL TAB LE(100 + 8*1 024 )
REAL WOR K(8 *1024)
...
CALL GGF FT(0, 102 4, 1.0 , X, Y, TAB LE, WOR K, 0)
Example 3: Using the same X and Y as in example 2, take the inverse FFT of Y and store it back in X. The
scale factor 1/1024 is used. Assume that the TABLE array is already initialized.
CALL GGF FT(-1, 1024, 1.0 /1024. 0, Y, X, TAB LE, WORK, 0)
rather than 0. No change was needed in the subroutine calls.
COMPLEX X(1024), Y(1 024 )
...
space. Assume that TABLE is already initialized.
COMPLE X X(1 024)
...
CALL GGF FT(1, 102 4, 1.0 , X, X, TAB LE, WORK, 0)
SEE ALSO
CCFFT(3S), HGFFT(3S), SCFFT(3S),
230 004– 2081– 002

HCONV ( 3S ) HCONV ( 3S )
NAME
HCONV – Performs the convolution of two sequences of real numbers
SYNOPSIS
CALL HCONV (nh, nx, ny, h, x, y)
IMPLEMENTATION
UNICOS/mk systems
DESCRIPTION
HCONV computes the convolution of the filter sequence h with the data sequence x, producing the output
sequence y.
Suppose h and x are two sequences of real numbers, having nh and nx elements, respectively. As is
customary in signal processing applications, let the subscripts start at 0, therefore:
h = h(0), h(1), . . . h(nh – 1)
x = x(0), x(1), . . . x(nx – 1)
The "convolution product," y, is the sequence having elements defined by:
y(0) = h(nh– 1) . x(0) + h(nh– 2) . x(1) + . . . + h(0) . x(nh– 1)
y(1) = h(nh– 1) . x(1) + h(nh– 2) . x(2) + . . . + h(0) . x(nh)
y(2) = h(nh– 1) . x(2) + h(nh– 2) . x(3) + . . . + h(0) . x(nh+1)
This example definition assumes nx > nh.
The precise definition of the convolution is:
Yk = Σ H (nh −1−j ) . x (k +j )
0≤j ≤min
for 0 ≤ k ≤ ny−1.
The number of terms in the output sequence is specified by an argument, ny. If ny < nx, then the output
sequence is just truncated. If ny > nx, then zeros are appended to the output sequence.
By choosing ny > nx − nh+1, the routine does what is sometimes called "post-tapered" convolution. The
effect is as though the data sequence, x, were padded on the end with zeros, except that no zeros are actually
stored and no multiplications by zero are actually done.
nh INTEGER(KIND=8). (input)
Specifies the number of elements in the filter sequence, h. nh ≥ 0.
nx INTEGER(KIND=8). (input)
Specifies the number of elements in the data sequence, x. nx ≥ 0.
004– 2081– 002 231

HCONV ( 3S ) HCONV ( 3S )
ny INTEGER(KIND=8). (input)
Specifies the number of elements in the output sequence, y. ny ≥ 0.
h REAL(KIND=4) array of dimension (0, nh−1). (input)
Specifies the input sequence of filter values.
x REAL(KIND=4) array of dimension (0, nx−1). (input)
Specifies the input sequence of data values.
y REAL(KIND=4) array of dimension (0, ny−1). (output)
Specifies the output matrix of convolutions.
NOTES
If ny = 0, the routine just returns. If either nh = 0 or nx = 0, the routine will zero the first ny elements in y
and return.
EXAMPLES
REAL(K IND=4) h(0 :2), x(0 :3), y(0:7)

DATA (h(i), i = 0, 2) / 1.0 , 2.0 , 3.0 /
DATA (x( i), i = 0, 3) / 4.0 , 5.0 , 6.0 , 7.0 /
CALL HCONV( 3, 4, 8, h, x, y)
PRINT *, y
The output produced is:

28., 34. , 32. , 21. , 0., 0., 0., 0.
SEE ALSO
HCORR(3S), HCORRS(3S), SCONV(3S)
232 004– 2081– 002

HCORR ( 3S ) HCORR ( 3S )
NAME
HCORR – Performs the correlation of two sequences of real numbers
SYNOPSIS
CALL HCORR (nh, nx, ny, h, x, y)
IMPLEMENTATION
UNICOS/mk systems
DESCRIPTION
HCORR computes the correlation of the filter sequence h with the data sequence x, producing the output
sequence y.
customary in signal processing applications, let the subscripts start at 0, so
h = h(0), h(1), . . ., h(nh – 1)
x = x(0), x(1), . . ., x(nx – 1)
The "correlation product", y, is the sequence having elements defined by:
y(0) = h(0) . x(0) + h(1) . x(1) + . . . + h(nh – 1) . x(nh – 1)
y(1) = h(0) . x(1) + h(1) . x(2) + . . . + h(nh – 1) . x(nh)
y(2) = h(0) . x(2) + h(1) . x(3) + . . . + h(nh – 1) . x(nh + 1)
This example definition assumes that nx ≥ nh.
The precise definition is as follows:
Yk = Σ H (nh −1−j ) . x (k +j ) for 0 ≤ k ≤ny −1
0≤j ≤MIN
The number of terms in the output sequence is specified by the argument ny. If ny < nx, the output sequence
is just truncated. If ny > nx, zeros are appended to the output sequence.
By choosing ny > nx – nh + 1, the routine does what is sometimes called "post-tapered" correlation. The
stored and no multiplications by zero are actually done. This routine has the following arguments:
nh INTEGER(KIND=8). (input)
nx INTEGER(KIND=8). (input)
Specifies the number of elements in the sequence of data sequence, x. nx ≥ 0.
ny INTEGER(KIND=8). (input)
h REAL(KIND+4) array of dimension (0, nh−1). (input)
004– 2081– 002 233

HCORR ( 3S ) HCORR ( 3S )

NOTES
If ny = 0, the routine returns. If either nh = 0 or nx = 0, the routine will zero the first ny elements in y and
return.
EXAMPLES
REAL(K IND=4) h(0 :2), x(0 :3), y(0:7)

DATA (h(i), i = 0, 2) / 1.0 , 2.0 , 3.0 /
DATA (x( i), i = 0, 3) / 4.0 , 5.0 , 6.0 , 7.0 /
CALL HCORR( 3, 4, 8, h, x, y)
PRINT *, y

32., 38. , 20. , 7., 0., 0., 0., 0.
SEE ALSO
HCONV(3S), HCORRS(3S), SCORR(3S)
234 004– 2081– 002

HCORRS ( 3S ) HCORRS ( 3S )
NAME
HCORRS – Performs the correlation of two sequences of real numbers (symmetric filter)
SYNOPSIS
CALL HCORRS (nh, nx, ny, h, x, y)
IMPLEMENTATION
UNICOS/mk systems
DESCRIPTION
HCORRS computes the correlation of the symmetric filter sequence h with the data sequence x, producing the
output sequence y. The filter, h, is assumed to be symmetric about its middle.
The computation carried out by HCORRS is exactly the same as that done by routine HCORR, with one
exception: the filter, h, is assumed to be symmetric, so only the first half of the elements are accessed. The
values of the second half are inferred from the first half and do not actually have to be supplied by the
calling routine.
To review the definition of correlation (not necessarily assuming a symmetric filter), suppose h and x are two
sequences of real numbers, having nh and nx elements, respectively. As is customary in signal processing
applications, let the subscripts start at 0, so
h = h(0), h(1), . . ., h(nh – 1)
x = x(0), x(1), . . ., x(nx – 1)
y(0) = h(0) . x(0) + h(1) . x(1) + . . . + h(nh – 1) . x(nh – 1)
y(1) = h(0) . x(1) + h(1) . x(2) + . . . + h(nh – 1) . x(nh)
y(2) = h(0) . x(2) + h(1) . x(3) + . . . + h(nh – 1) . x(nh + 1)
This example definition assumes that nx ≥ nh.)
The precise definition of correlation is as follows:
0≤j ≤MIN
The HCORRS routine makes the assumption that the filter is symmetric; in other words, that h(nh − j) = h(j),
for 0 ≤ j ≤ nh / 2.
Only the elements h(0) through h(nh/2) are accessed by the routine. The last half of the filter values are not
accessed and do not actually have to be supplied by the calling routine.
004– 2081– 002 235

HCORRS ( 3S ) HCORRS ( 3S )
By choosing ny > nx − nh+1, the routine does what is sometimes called "post-tapered" correlation. The
nh Integer. (input)
Specifies the number of elements in the filter sequence, h.
nh ≥ 0.
nx Integer. (input)
Specifies the number of elements in the data sequence, x.
nx ≥ 0.
ny Integer. (input)
Specifies the number of elements in the output sequence, y.
ny ≥ 0.
h REAL(KIND=4) array of dimension (0, nh/2). (input)
Specifies the input sequence of filter values. Only values h(0) through h(nh/2) are accessed; the
second half of the filter values are inferred from the symmetry of h.
Specifies the output sequence.
NOTES
and return.
EXAMPLES
REA L(K IND=4) h(0:2), x(0 :3), y(0:7)

DATA (h( i), i = 0, 2) / 1.0, 2.0, 3.0 /
DATA (x(i), i = 0, 3) / 4.0 , 5.0 , 6.0 , 7.0 /
CALL HCO RRS(5, 4, 8, h, x, y)
pri nt *, y

46., 38., 20., 7., 0., 0., 0., 0.
SEE ALSO
HCONV(3S), HCORR(3S), SCORRS(3S)
236 004– 2081– 002

HGFFT ( 3S ) HGFFT ( 3S )
NAME
HGFFT, GHFFT – Computes a real-to-complex or complex-to-real Fast Fourier Transform (FFT)
SYNOPSIS
CALL HGFFT (isign, n, scale, x, y, table, work, isys)
CALL GHFFT (isign, n, scale, x, y, table, work, isys)
IMPLEMENTATION
UNICOS/mk systems
DESCRIPTION
HGFFT computes the FFT of the real array X, and it stores the results in the complex array Y. GHFFT
computes the corresponding inverse complex-to-real transform.
In FFT applications, it is customary to use zero-based subscripts; the formulas are simpler that way. First
the function of HGFFT is described. Suppose that the arrays are dimensioned as follows:
REAL(K IND=4) X(0 :n-1)
COMPLE X(KIND =4) Y(0 :n/ 2)
Then the output array is the FFT of the input array, using the following formula for the FFT:
n −1
n
Σ
. j .k
Yk = scale X j . ωisign for k = 0, . . .,
j =0 2
where
2.π.i
ω=e n
i = +√−1
π = 3.14159. . .
isign = ±1
forward or inverse transform, and what the scale factor should be in either case. You can make these
routines compute any of the various possible definitions, however, by choosing the appropriate values for
isign and scale.
The relevant fact from FFT theory is this: If you call HGFFT with any particular values of isign and scale,
the mathematical inverse function is computed by calling GHFFT with – isign and 1 / (n . scale). In
particular, if you use isign = +1 and scale = 1.0 in HGFFT for the forward FFT, you can compute the
inverse FFT by using GHFFT with isign = – 1 and scale = 1.0/n.
004– 2081– 002 237


isign INTEGER(KIND=8). (input)
as follows:
Size of transform. If n ≤ 2, HGFFT returns without calculating the transform.
scale REAL(KIND=4). (input)
transform, as defined in the preceding formula.
x HGFFT: REAL(KIND=4) array of dimension (0:n– 1). (input)
GHFFT: COMPLEX(KIND=4) array of dimension (0:n/2). (input)
y HGFFT: COMPLEX(KIND=4) array of dimension (0:n/2). (output)
GHFFT: REAL(KIND=4) array of dimension (0:n– 1). (output)
Output array of transformed values.
The output array, Y, is the FFT of the the input array, X, computed according to the preceding
formula. The output array may be equivalenced to the input array in the calling program. Be
careful when dimensioning the arrays, in this case, to allow for the fact that the complex array
contains two (real) words more than the real array.
table REAL(KIND=4) array of dimension (2n). (input or output)
If isign = 0, the table array is initialized to contain trigonometric tables needed to compute an
FFT of size n.
isign = 0.
work REAL(KIND=4) array of dimension 2n.
Work array used for intermediate calculations. Its address space must be different from that of
the input and output arrays.
isys INTEGER(KIND=8) array of dimension (0:isys(0)). (input and output)
The first element of the array specifies how many more elements are in the array. You may use
isys to specify certain processor-specific parameters or options.
238 004– 2081– 002

argument value as the scalar integer constant 0. If isys(0)>0, isys(0) gives the upper bound of
the isys array; that is, if il=isys(0), user-specified parameters are expected in isys(1) through
isys(il).
Real-to-complex FFTs
Notice in the preceding formula that there are n real input values, and n / 2 + 1 complex output values. This
property is characteristic of real-to-complex FFTs.
The mathematical definition of the Fourier transform takes a sequence of n complex values and transforms it
to another sequence of n complex values. A complex-to-complex FFT routine, such as GGFFT(3S), will take
n complex input values, and produce n complex output values. In fact, one easy way to compute a real-to-
complex FFT is to store the input data in a complex array, then call routine GGFFT to compute the FFT.
You get the same answer when using the HGFFT routine.
The reason for having a separate real-to-complex FFT routine is efficiency. Because the input data is real,
you can make use of this fact to save almost half of the computational work.
The theory of Fourier transforms tells us that for real input data, you have to compute only the first n/2 + 1
complex output values, because the remaining values can be computed from the first half of the values by
the following simple formula:
Y(k)=conjg(Y(n-k)) for n / 2 ≤ k ≤ n-1
where the notation conjg(z) represents the complex conjugate of z.
In fact, in many applications, the second half of the complex output data is never explicitly computed or
stored. Likewise, as explained below, only the first half of the complex data has to be supplied for the
complex-to-real FFT.
Another implication of FFT theory is that, for real input data, the first output value, Y(0), will always be a
real number; therefore, the imaginary part will always be 0. If n is an even number, Y(n/2) will also be real
and thus, have zero imaginary part.
Complex-to-real FFTs
Consider the complex-to-real case. The effect of the computation is given by the preceding formula, but
with X complex and Y real.
Generally, the FFT transforms a complex sequence into a complex sequence. However, in a certain
application we may know the output sequence is real. Often, this is the case because the complex input
sequence was the transform of a real sequence. In this case, you can save about half of the computational
work.
According to the theory of Fourier transforms, for the output sequence, Y, to be a real sequence, the
following identity on the input sequence, X, must be true:
X(k) = conjg(X(n-k)) for n / 2 ≤k ≤ n-1
And, in fact, the input values X(k) for k > n/2 need not be supplied; they can be inferred from the first half
of the input.
004– 2081– 002 239

Thus, in the complex-to-real routine, GHFFT, the arrays can be dimensioned as follows:
COMPLE X(K IND=4) X(0:n/ 2)
REAL(K IND=4) Y(0:n- 1)
There are n / 2 + 1 complex input values and n real output values. Even though only n/2 + 1 input values
are supplied, the size of the transform is still n in this case, because implicitly you are using the FFT
formula for a sequence of length n.
Another implication of the theory is that X(0) must be a real number (that is, it must have zero imaginary
part). Also, if n is even, X(n/2) must also be real. Routine GHFFT assumes that these values are real; if you
specify a nonzero imaginary part, it is ignored.
NOTES
The table array stores the trigonometric tables used in calculation of the FFT. This table must be initialized
by calling the routine with isign = 0 prior to doing the transforms. The table does not have to be
reinitialized if the value of the problem size, n, does not change. Because HGFFT and GHFFT use the same
format for table, either can be used to initialize it (GGFFT uses a different table format).
Dimensions
applications. Thus, the input and output arrays are declared (assuming n > 0):
REAL(KIND =4) X(0:n- 1)
COMPLEX(K IND =4) Y(0 :n/ 2)
No change is needed in the calling sequence; however, if you prefer you can use the more customary Fortran
style with subscripts starting at 1, as in the following:
REAL(K IND =4) X(n )
COMPLEX(K IND =4) Y(n /2 + 1)
Performance Tips
These routines will compute an FFT for any value of n, provided only that n is an even number, n ≥ 2,
Performance for a given value of n depends on the prime factorization of n. This fact is characteristic of all
FFT algorithms.
operations is approximately
5. .
n log 2 (n)
2
If n contains factors of 3, performance is slightly worse; if n contains powers of 5, it is slightly worse still.
Worst performance is when n is a prime number; in which case, the number of operations is approximately 4
. n2.
240 004– 2081– 002

The kernel routines are optimized for values of n that are even numbers and are products of powers of 2, 3,
and 5. (Because the kernel routines have a special case for multiples of 4, even powers of 2 will be slightly
faster than odd powers of 2.)
The UNICOS and UNICOS/mk FFT routines were designed so that they could be implemented efficiently on
• The first area is the size of the table and work arrays. Different sizes may be needed on different
systems. No change is required to the subroutine call, but you may have to change the array sizes in the
DIMENSION or type statements that declare the arrays.
EXAMPLES
Example 1: Initialize the complex array TABLE in preparation for doing an FFT of size 1024. In this case
only the arguments isign, n, and table are used; you can use dummy arguments or zeros for the other
REA L(KIND =4) TAB LE( 100 + 4*1 024 )
CAL L HGF FT(0, 102 4, 0.0 , DUM MY, DUM MY, TAB LE, DUM MY, 0)
Example 2: X is a real array of dimension (0:1023), and Y is a complex array of dimension (0:512). Take
the FFT of X and store the results in Y. Before taking the FFT, initialize the TABLE array, as in example 1.
REA L(K IND =4) X(0 :10 23)
COM PLE X(KIND =4) Y(0:51 2)
REA L(KIND =4) TAB LE( 100 + 4*1 024 )
REA L(K IND =4) WOR K(4 *10 24 + 4)
...
CAL L HGF FT(0, 102 4, 1.0 , X, Y, TAB LE, WORK, 0)
CAL L HGF FT(1, 102 4, 1.0 , X, Y, TAB LE, WORK, 0)
factor 1/1024 is used. Assume that the TABLE array is initialized already.
CAL L GHF FT(-1, 102 4, 1.0/10 24. 0, Y, X, TAB LE, WOR K, 0)
004– 2081– 002 241

REA L(K IND =4) X(1 024 )
COM PLE X(K IND =4) Y(5 13)
...
CAL L HGF FT( 0, 102 4, 1.0 , X, Y, TABLE, WOR K, 0)
CAL L HGF FT( 1, 102 4, 1.0 , X, Y, TABLE, WOR K, 0)
Example 5: Do the same computation as in example 4, but equivalence the input and output arrays to save
storage space. Assume that the TABLE array is initialized already.
REA L(K IND =4) X(1 024 )
COM PLE X(K IND =4) Y(5 13)
EQU IVA LEN CE ( X(1 ), Y(1 ) )
...
CAL L HGF FT( 1, 102 4, 1.0 , X, Y, TAB LE, WOR K, 0)
SEE ALSO
GGFFT(3S), SCFFT(3S)
242 004– 2081– 002

HOPFILT ( 3S ) HOPFILT ( 3S )
NAME
HOPFILT – Solves Weiner-Levinson linear equations
SYNOPSIS
CALL HOPFILT (m, a, b, c, r)
IMPLEMENTATION
UNICOS/mk systems
DESCRIPTION
HOPFILT computes the solution to the Weiner-Levinson system of linear equations Ta = b; T is a
symmetric Toeplitz matrix in which elements are described as follows:
t ij = R(1+MOD(m+j– i,m))
for some vector R = (R(1), R(2), . . ., R(m))
m Integer. (input)
Order of the system of equations.
a REAL(KIND=4) array of dimension m. (output)
Resulting vector of filter coefficients.
b REAL(KIND=4) array of dimension m. (input)
Information auto-correlation vector (right-hand side vector in system of linear equations).
c REAL(KIND=4) array of dimension 2m. (scratch output)
Scratch vector.
r REAL(KIND=4) array of dimension m. (input)
Signal auto-correlation vector (band values of the symmetric Toeplitz matrix T).
NOTES
Although HOPFILT solves this matrix equation faster than Gaussian elimination, HOPFILT does no
pivoting; therefore, it is less numerically stable than Gaussian elimination, unless the matrix T is either
positive definite or diagonally dominant.
004– 2081– 002 243

HOPFILT ( 3S ) HOPFILT ( 3S )
EXAMPLES
You can solve the following system of linear equations with the call HOPFILT (3,A,B,C,R). Vector c
has a length of at least 6.
 R (1) R (2) R (3)   A (1)   B (1) 
     
 R (2) R (1) R (2)   A (2)  =  B (2) 
     
 R (3) R (2) R (1)   A (3)   B (3) 
SEE ALSO
OPFILT(3S)
244 004– 2081– 002

MCFFT ( 3S ) MCFFT ( 3S )
NAME
MCFFT – Applies multiple multitasked complex Fast Fourier Transforms (FFTs)
SYNOPSIS
CALL MCFFT (isign, n, m, scale, x, inc1x, inc2x, y, inc1y, inc2y, table, ntable, work,
nwork)
IMPLEMENTATION
UNICOS systems
DESCRIPTION
MCFFT computes the Fourier transform of each column of the complex matrix x, and it stores the results in
the columns of matrix y. For most purposes, MCFFT is superseded by the UNICOS standard FFT routine
CCFFTM(3S).
Suppose the arrays are dimensioned as follows:
COMPLE X X(0 :N- 1, M), Y(0 :N- 1, M)
MCFFT computes the formula:
n −1
Yk ,l = scale
ΣX
j =0
j ,l ω jk for k = 0, . . ., n −1, l = 1, . . ., m
where
isign . 2 . π . i
ω=e n
isign =±1
π=3.14159. . .
e =2.71828. . .
i =√−1
forward or the inverse transform, and what the scale factor should be in either case. In this documentation,
when isign = +1, it is called the forward transform, and when isign = – 1, it is called the inverse transform.
004– 2081– 002 245


Specifies whether to initialize the table array or do the forward or inverse Fourier transform:
n Integer. (input)
Order of the transforms (the number of elements in each column of the input and output matrix).
If n is not positive, MCFFT returns without computing any transforms.
m Integer. (input)
The number of transforms to be computed (the number of elements in each row of the input and
output matrix). If m is not positive, MCFFT returns without computing any transforms.
scale Real. (input)
Real scale factor. Each element of the output array is multiplied by the scale factor after taking
the Fourier transform, as defined in the preceding formula.
First element to be used in an input array of values to be transformed.
Input array increment in the first dimension (the distance between successive complex array row
elements within each column of the input array). inc1x must not be 0.
Input array increment in the second dimension (the distance between successive complex array
column elements within each row of the input array). inc2x must not be 0.
First element to be output in an array of transformed values.
The output array may be the same as the input array. In that case, the transform is done in
place, if inc1x = inc1y and inc2x = inc2y.
Output array increment in the first dimension (the distance between successive complex array
row elements within each column of the output array). inc1y must not be 0.
Output array increment in the second dimension (the distance between successive complex array
column elements within each row of the output array). inc2y should be a multiple of the
declared leading dimension of the output array. inc2y must not be 0.
Table of factors and trigonometric functions. This array may be initialized by a call to MCFFT
with isign = 0.
246 004– 2081– 002


Number of (real) words in the table array. The value of ntable should be at least 2n + 100; n is
the order of the transform. If the value of ntable does not provide enough space, MCFFT prints
an error message and stops.
Work array. This is a scratch array used for intermediate calculations. It must be a different
address space from the input and output arrays.
Number of words in the work array.
The value of nwork should be at least 4n(MIN(m, 16ncpus)):
n Order of each transform
m Number of transforms
ncpus Number of CPUs used in the calculation
If the value of nwork does not provide enough space, MCFFT prints an error message and stops.
NOTES
This section contains information about the algorithm for MCFFT, table initialization, increment arguments,
and performance tips.
Algorithm
MCFFT uses decimation-in-frequency type FFT that performs its operations on each row of the matrix. This
means that as the algorithm is transforming each column of the input matrix, it vectorizes along the rows.
Thus, the vector length in the calculations depends on the row size. The performance tips later in this
subsection give more information on the algorithm as it relates to performance.
The table array stores factors of n and trigonometric tables that are used in calculation of the FFT. You can
initialize table explicitly by calling MCFFT with isign = 0. If you do not initialize table, MCFFT does so
automatically on the first call. If the value of the problem size, n, does not change, table does not have to
be reinitialized. If you call MCFFT with a different value of n without first reinitializing table, MCFFT
reinitializes table automatically.
might consider using more than one table array, so that it will not have to be reinitialized on each call to
MCFFT.
If you initialize table explicitly by calling MCFFT with isign = 0, the only arguments that are significant are
isign, n, table, and ntable. In this case, the other arguments are ignored.
large enough. If it is not, MCFFT stops after printing an error message, indicating the amount of table space
required.
004– 2081– 002 247

Increment Arguments
The inc1x, inc2x, inc1y, and inc2y increment arguments describe how the matrices are stored in Fortran
arrays. These arguments are the link between the mathematical matrices and their representation in computer
memory.
Consider the following 4-by-5 matrix X.
X(1,1) X(1,2) X(1 ,3) X(1 ,4) X(1 ,5)
X(2,1) X(2 ,2) X(2,3) X(2 ,4) X(2,5)
X(3,1) X(3,2) X(3 ,3) X(3 ,4) X(3 ,5)
X(4,1) X(4 ,2) X(4,3) X(4,4) X(4 ,5)
Suppose that this matrix is declared by the Fortran statement:

COMPLE X X(4 ,5)
Fortran stores matrices "by column", in the following order:

X(1,1) , X(2,1) , X(3 ,1) , X(4 ,1) , X(1 ,2) , X(2 ,2) . . .
Thus, the increment in the first dimension, inc1x, is just 1. The increment in the second dimension, inc2x, is
the (address) distance between X(1,1) and X(1,2), which is 4, the leading dimension of X. Generally, the
increment in the second dimension is the leading dimension of the array as it is declared in the Fortran
program, or a multiple thereof.
The previous information described transforming each column of X into a column of Y. Actually, it could
just as well have described transforming rows of X into rows of Y. MCFFT can do either one, as follows:
Suppose that X and Y have been declared with the following statement, as in the previous example:
COMPLE X X(4, 5), Y(4 , 5)
To transform the columns of X into the columns of Y, using every element of each column, set the
following:
INC1X = 1
INC2X = 4
INC1Y = 1
INC2Y = 4
INC1X and INC1Y are 1, meaning to use every element of the column, and the values of INC2X and
INC2Y are the leading dimensions of the arrays, as they are declared.
To transform the rows of X into the rows of Y, interchange the values of INC1X and INC2X, and also of
INC1Y and INC2Y (the increment arguments) as follows:
INC1X = 4
INC2X = 1
INC1Y = 4
INC2Y = 1
248 004– 2081– 002

Because of the way that arrays are stored in Fortran, interchanging the increments this way is equivalent to
transposing the matrices.
The increment arguments are not directly related to the values of n and m, except insofar as the matrix must
fit in the allocated address space.
Negative increments are legal. If row or column increment is negative, the address given as the x or y
argument should be the address of the element at the end of the row or column of the array (not the
beginning).
Because each transform has n elements, this implies that the increment values must satisfy the following
logical expressions:
 inc2x  ≥n  inc1x  or  inc1x  ≥n  inc2x 
 inc2y  ≥n  inc1y  or  inc1y  ≥n  inc2y 
Performance Tips
MCFFT will work for any values of the arguments, subject only to the restrictions given previously. The
• n: Order of each transform
• m: Number of transforms
• inc1x, inc2x, inc1y, inc2y: Increment arguments
• nwork: Amount of workspace
Each of these factors is considered separately in the following subsections.
Performance relative to the order of transform
MCFFT computes an FFT for any value of n, but the performance for a given value of n depends on the
factorization of n. This is characteristic of all FFT algorithms.
Best performance is realized when n is a power of 2. In that case, the number of operations is proportional
to mnlog 2 (n).
Performance is slightly worse if n contains factors of 3. It is worse if n contains powers of 5. Worst
2
performance is when n is a prime number. In that case, the number of operations is proportional to mn .
The kernel routines are optimized for values of n that are products of powers of 2, 3, and 5. The value of n
has no effect on vectorization or multitasking, which depend only on m.
Performance relative to the number of transforms
MCFFT uses a vectorized FFT algorithm that vectorizes across the rows of x and y. Thus, the vector length
for the computations is m, the number of transforms. As with all vector calculation, performance is poor if
m is small (for example, less than 8). If m ≥ 32, performance will be good. Performance is best when m is
a multiple of 64 (128 on Cray C90 series computer systems), particularly if m ≥ 256.
004– 2081– 002 249

MCFFT runs in multitasked mode for large values of m. If

m
≥16
ncpus
where ncpus is the number of CPUs allocated to the job, then the calculation will be multitasked.
If m is small (for example, m < 8), the CFFT(3S) routine should be used to do the transforms one at a time.
Performance relative to the values of increment arguments
contention.
The strides for vector loads and stores are inc2x and inc2y, respectively. To avoid memory bank conflicts,
neither inc2x or inc2y should be a multiple of a large power of 2. Best performance is realized when inc2x
and inc2y are odd numbers. One way to do this is to declare both input and output arrays with an odd
leading dimension in the calling program.
The values of inc1x and inc1y should also be odd, if possible, but these values are much less significant to
performance than inc2x and inc2y.
The size of the workspace, nwork, is also relevant to performance. To do the FFTs in one lot, the
workspace required is (in (real) words of storage) nwork = 4nm
If m is large, this amounts to a lot of memory. You can provide less workspace and still obtain very good
performance. At a minimum, you need (in (real) words of storage) nwork = 4nMIN(m, 16ncpus)
If you give a value of nwork in the range 16 . n . ncpus ≤ nwork < 4nm, MCFFT will divide the work into
lots small enough to run in the workspace provided.
For best performance, nwork should be at least 128.n .ncpus .
EXAMPLES
The following program illustrates the use of MCFFT. The program computes 256 one-dimensional FFTs out
of a matrix of random numbers, first by using MCFFT, then by using CFFT(3S) for each column. Then it
compares the two results.
The program then computes each inverse transform, also using MCFFT, and compares the results with the
original sequence.
PAR AMETER (N = 2*3 *5*7, M = 256)
PAR AMETER (LD 1 = N+1 , LD2 = M+3)
COMPLE X X(LD1, LD2 ), Y(LD1, LD2 ), YY( LD1 , LD2 )
PAR AMETER ( NTA BLE = 100 + 8*N )
PAR AMETER ( NWORK = 4*N*M )
REA L TAB LE( NTABLE), WOR K(N WOR K)
LOGICA L LFW D, LINV
*----- ------ ------ --- ------ --- --- --- --- --- --- --- --- --- --- ---
* Ini tializ e inp ut array, X, to a
250 004– 2081– 002

* set of ran dom num ber s.
DO 15, J = 1, M
DO 10, I = 1, N
X(I, J) = CMP LX(RAN F() , RAN F() )
10 CON TINUE
15 CONTIN UE
*-- --- ------ --- --------- --- --- ------ --- --- ------ --- --- --- ---
* Compute Y(:,J) = the Fou rie r Tra nsf orm of X(: ,J)
* usi ng MCFFT.
CAL L MCF FT( +1, N, M, 1.0 , X, 1, LD1 ,

& Y, 1, LD1, TAB LE, NTABLE , WOR K, NWO RK)
*-- --- ------ --- --------- --- --- ------ --- --- --- ------ --- --- ---
* Com pute YY(:,J) = the Fou rie r Tra nsf orm of X(: ,J)
* usi ng multip le cal ls to CFF T.
DO 20, J = 1, M
CALL CFFT(+1, N, 1.0 , X(1 ,J) , 1, YY(1,J ), 1,
20 CONTIN UE
*-- --- ------ --- --------- --- --- ------ --- --- --- ------ --- --- ---
* Com par e Y and YY.
LFW D = .TRUE.
DO 40, J = 1, M
DO 30, I = 1, N
ERR OR = ABS ( Y(I ,J)-YY (I, J) )/A BS(Y(I ,J) )
LFW D = LFW D .AN D. (ER ROR .LE . 1.0 E-6 )
30 CON TIN UE
40 CON TINUE
IF (.N OT. LFWD) PRI NT *, ’Fa ile d for war d tes t’
IF (LFWD) PRINT *, ’Fo rwa rd transf orm OK’
*-- --- ------ --- --------- --- --- ------ --- --- --- ------ --- --- ---
* Com put e the invers e tra nsf orm of Y,
* and sto re it bac k in Y.
CAL L MCF FT(-1, N, M, 1.0/N, Y, 1, LD1 , Y, 1, LD1 ,

*-- --- ------ --- --------- --- --- ------ --- --- --- ------ --- --- ---
* Com par e the transf orm ed Y arr ay with the
* ori gin al X array.
LIN V = .TRUE.
004– 2081– 002 251

DO 60, I = 1, N
DO 50, J = 1, M
ERR OR = ABS ( X(I ,J)-Y( I,J ) )/A BS( X(I ,J) )
LIN V = LIN V .AN D. (ER ROR .LE. 1.0E-6 )
50 CONTIN UE
60 CON TINUE
IF (.N OT. LIN V) PRI NT *, ’Faile d inv ers e tes t’
IF (LI NV) PRINT *, ’In ver se tra nsf orm OK’
IF (LINV .AN D. LFWD) PRI NT *, ’Test suc cee ded ’
END
SEE ALSO
CCFFT(3S), CFFT(3S) to calculate a single one-dimensional FFT. CCFFT(3S) supersedes most uses of
CFFT(3S).
CFFT2D(3S).
CFFT3D(3S).
CCFFTM(3S), which supersedes most uses of MCFFT
252 004– 2081– 002

OPFILT ( 3S ) OPFILT ( 3S )
NAME
OPFILT – Solves Weiner-Levinson linear equations
SYNOPSIS
CALL OPFILT (m, a, b, c, r)
IMPLEMENTATION
DESCRIPTION
OPFILT computes the solution to the Weiner-Levinson system of linear equations Ta = b; T is a symmetric
Toeplitz matrix in which elements are described as follows:
ti j = R(1+mod (m +j −i , m ))
for some vector R = (R(1), R(2), . . ., R(m)).
m Integer. (input)
Order of the system of equations.
a Real array of dimension m. (output)
Resulting vector of filter coefficients.
b Real array of dimension m. (input)
Information auto-correlation vector (right-hand side vector in system of linear equations).
c Real array of dimension 2m. (scratch output)
Scratch vector.
r Real array of dimension m. (input)
Signal auto-correlation vector (band values of the symmetric Toeplitz matrix T).
NOTES
Although OPFILT solves this matrix equation faster than Gaussian elimination, OPFILT does no pivoting;
therefore, it is less numerically stable than Gaussian elimination, unless the matrix T is either positive
definite or diagonally dominant.
EXAMPLES
You can solve the following system of linear equations with the call OPFILT (3,A,B,C,R). Vector c
has a length of at least 6.
004– 2081– 002 253

OPFILT ( 3S ) OPFILT ( 3S )
 R (1) R (2) R (3)   A (1)   B (1) 

     
 R (2) R (1) R (2)   A (2)  =  B (2) 
     
 R (3) R (2) R (1)   A (3)   B (3) 
254 004– 2081– 002

PCCFFT2D ( 3S ) PCCFFT2D ( 3S )
NAME
PCCFFT2D – Applies a two-dimensional (2D) complex-to-complex Fast Fourier Transform (FFT) to a
matrix distributed across a set of processors
SYNOPSIS
CALL PCCFFT2D (isign, n1, n2, scale, A, iA, jA, descA, B, iB, jB, descB, table, work,
isys, info)
IMPLEMENTATION
UNICOS/mk systems
DESCRIPTION
PCCFFT2D computes the 2D complex Fast Fourier Transform (FFT) of the distributed complex matrix A,
and it stores the results in the distributed complex matrix B.
This routine considers the processors to be partitioned into a one-dimensional (1D) linear array of processors.
The 2D input matrix A is then distributed across this 1D grid of processors as discussed in the following
text.
Consider a 2D matrix A of size nr-by-nc, where nr is the number of rows and nc is the number of columns
of matrix A.
Let the processors (N$PES in number) be partitioned into a 1D grid of size 1-by-npc, where npc = N$PES is
the number of processors assigned to the column dimension of A. Let the number of processors assigned to
the row dimension be 1. To partition processors into this grid, call the BLACS_GRIDINIT routine as
shown:
CALL BLACS_ GRI DIN IT (ictxt, ’C’ , 1, npc)
The input matrix, A, and the output matrix, B, are distributed across this 1D linear array of processors by
using the block (as defined in FORTRAN D and HPF) distribution along the columns. The distribution
along the rows is degenerate. The descriptors descA and descB provide information on the distribution of
the matrices A and B across the processor grid. The descriptors descA and descB are initialized using the
DESCINIT(3S) routine. The DESCINIT(3S) routine would have to be called after the call to
BLACS_GRIDINIT and would look like this:
CALL DESCIN IT (descA, nr, nc, nr, ICE IL( nc, npc),
pesr, pesc, ictxt, lld, info)
Given that matrix A is distributed in a block manner across the processor grid along the columns, the block
size along the columns would be the following:
ncpp = ICE IL( nc, npc)
004– 2081– 002 255

Further assume that the user wants the 2D FFT to be performed on a submatrix starting at global address
(iA, jA). Let this submatrix be of size n1-by-n2. Then the arguments iA and jA represent the global address
of the first element of the submatrix and n1 and n2 represent the size of the submatrix over which the 2D
FFT is to be performed.
Similarly, the iB and jB arguments represent the first element of the submatrix to which the output is to be
written.
Restrictions
In the current release, the matrices A and B must be distributed identically. This means that all of the
arguments provided to DESCINIT(3S) to initalize descA and descB must be equal except for the local
leading dimension.
The flexibility of performing the FFT over any submatrix of the global input matrix is not available in the
current release. Therefore, users must initialize iA, jA, iB, and jB with 1 and n1 with nr and n2 with nc.
All processors must call this routine. In future releases, only those processors that own the matrix over
which the FFT is to be performed will participate in the computation. All other processors will exit the
routine immediately.
2D FFT Theory
COM PLE X A(0 :n1 -1, 0:n2-1 )
COM PLE X B(0 :n1 -1, 0:n2-1 )
PCCFFT2D computes the formula:

n1−1 n2−1 .k .k
Bk k
1, 2
= scale . Σ Σ
j =0 j =0
Aj j
1, 2
. ω1 j 1 1 . ω2 j 2 2
for k 1 = 0, . . ., n1−1, k 2 = 0, . . ., n2−1
1 2
where
isign . 2 . π . i
ω1 = e isign n1
. 2 . π . i i = +√−1
ω2 = e n2
π = 3.14159. . .
isign = ±1
forward or inverse transform, and what the scale factor should be in either case. To compute any of the
various possible definitions, however, choose the appropriate values for isign and scale.
If you take the FFT with any particular values of isign and scale, the mathematical inverse function is
computed by taking the FFT with -isign and 1 / (n1 . n2 . scale). In particular, if you use isign = +1 and
scale = 1.0 for the forward FFT, you can compute the inverse FFT by using isign = – 1 and scale = 1.0 / (n1
. n2).
256 004– 2081– 002

If the values of either n1 or n2 are prime or not factorizable into powers of 2, 3 and 5 then significant
vector of length 3.
If both n1 and n2 are factorizable into powers of 2, 3 and 5, for example, n1 = 30 and n2 = 120, then
isys(1) = 2
isys(2) = 0
isys(3) = 0
If any one dimension is not factorizable into powers of 2, 3 and 5, then the following intializations of isys
isys(1) = 2
isys(2) = 1
isys(3) = 0
isys(1) = 2
isys(2) = 0
isys(3) = 1
isys(1) = 2
isys(2) = 1
isys(3) = 1
If the numbers n1 and n2 are not known ahead of time, then isys(2) and isys(3) could be initialized to 0 or 1;
if an inappropriate choice is made, the routine would compute the correct result for n1 and n2, although
slowly (if either n1 or n2 were prime). If initialized to 1, more workspace is needed; see the description of
table which follows.
The storage requirements for the vector table depend on the values of the isys vector. The PCCFFT2D
routine accepts the following arguments (all scalar values are private data):
follows:
used or checked are isign, n1, n2, and table.
n1 Integer. (input)
Number of rows in the sumbatrix to be transformed.
004– 2081– 002 257

n2 Integer. (input)
Number of columns in the sumbatrix to be transformed.
scale Real. (input)
Fourier transform.
A Private complex array of dimension (0:lldA– 1, 0:ICEIL(nc,npc)– 1). (input)
Input array of values to be transformed. lldA is the local leading dimension and is initialized
using DESCINIT(3S). A must be declared in a COMMON block.
iA With jA, the global address of the first element of the global input matrix.
jA With iA, the global address of the first element of the global input matrix.
descA Integer vector of dimension 9. (input)
Contains description of the distribution of the matrix A across a 1D processor grid.
B Private complex array of dimension (0:lldB– 1, 0:ICEIL(nc,npc)– 1). (output)
Output array of transformed values. lldB is the local leading dimension and is initialized using
DESCINIT(3S).
Output array B may be the same as the input array A in which case the input array A is
overwritten with the transformed values. B must be declared in a COMMON block.
iB With jB, the global address of the first element of the global matrix where output will be written.
jB With iB, the global address of the first element of the global matrix where output will be written.
descB Integer vector of dimension 9. (input)
Contains description of the distribution of the matrix B across a 1D processor grid. If the input
array and the output array are the same, you must use the same descriptors.
table Private real vector of length 2(n1 + n2) if both isys(2) and isys(3) are equal to zero. Private real
vector of length 12(n1 + n2) if either isys(2) or isys(3) is equal to 1. (input or output)
Table of trigonometric function values.
work Private complex vector of length (n1r)(ICEIL(n2r/npc))
Where n1r and n2r are the values of n1 and n2 rounded up to the nearest powers of 2 greater
than or equal to them. work must be declared in a COMMON block.
isys Private integer vector of length 3. (input)
isys(1) indicates the dimension of the problem which is 2. isys(1) should be set to 2.
isys(2) indicates if n1 is prime or not factorizable into powers of 2, 3 and 5. Should be set to 1
if the number is not factorizable into powers of 2, 3 and 5. Should be set to 0 if it is
factorizable.
258 004– 2081– 002

isys(3) should be set to 0 or 1, depending on whether n2 is factorizable or not into powers of 2,

3 and 5.
info is set to 0 if all the arguments passed to the routine are legal. If any argument has an
illegal value, the routine exists after setting info to a negative number. – info indicates the
position of the illegal argument.
NOTES
The scale factor scale can take on values of 1.0 or 1.0 /(n1 . n2) depending on whether the forward or
inverse FFT is being computed.
Algorithm
The routine uses a very efficient single processor FFT routine, CCFFT, to do the FFT of each column on the
processors that own the submatrix. It then transposes the submatrix by using intermediate workspace that it
allocates for the purpose, and it again does the FFT along the columns (FFTs of the rows).
If either isys(2) or isys(3) or both are initialized to 1, then a fast (O(n log(n))) algorithm based on the chirp-z
transform is used for the one dimensional FFT in the corresponding direction. In this case, the vector table
must be real of length 12(n1+n2).
Workspace
The routine dynamically allocates two real work arrays:
Size of one work array:
8 . MAX(nr . nc)
Size of the other work array:
2 . MAX(nr . ICEIL(nc,npc), nc . ICEIL(nr,npc))
The workspaces are freed on exiting.
Example code for PCCFFT2D on a 16-processor partition:
com ple x A(2 56,16)
com ple x B(2 56,16)
comple x wor k(4 096)
com mon /abw/ A, B, work
real table(819 2)
intege r ict xt, des cA( 9), des cB(9), isi gn, isy s(3)
intege r nr, nc, iceil, inf o, np
intege r n1, n2
rea l sca le
004– 2081– 002 259

nr = 240
nc = 181
n1 = nr
n2 = nc
np = n$pes
cal l bla cs_ gridinit( ict xt,’C’ ,1,np)
cal l des cin it( des cA, nr, nc, nr, ice il( nc, np) ,
0, 0, ict xt, 256, info )
if ( inf o .ne . 0 ) the n

call exit(0)
end if
call descin it( descB, nr, nc, nr, ice il(nc, np),
0, 0, ict xt, 256 , inf o )

call exit(0)
end if
isi gn = -1
sca le = 1.0
isy s(1) = 2
isy s(2) = 0
isy s(3) = 1
*
* Ini tializ ing the tri g tab les
*
call pccfft 2d( 0, n1, n2, sca le, A, 1, 1, des cA,
B, 1, 1, des cB, tab le, wor k, isy s, inf o)

call exit(0)
end if
*
* FFT
*
call pccfft 2d( isign, n1, n2, sca le, A, 1, 1, descA,
B, 1, 1, des cB, tab le, wor k, isy s, inf o)
260 004– 2081– 002

call exit(0 )
end if
call exit(0 )
end
SEE ALSO
BLACS_GRIDINFO(3S), BLACS_GRIDINIT(3S), BLACS_PCOORD(3S), BLACS_PNUM(3S),
DESCINIT(3S)
004– 2081– 002 261

NAME
PCCFFT3D – Applies a three-dimensional (3D) complex-to-complex Fast Fourier Transform (FFT) to a
matrix distributed across a set of processors
SYNOPSIS
CALL PCCFFT3D (isign, n1, n2, n3, scale, A, iA, jA, kA, descA, B, iB, jB, kB, descB,
table, work, isys, info)
IMPLEMENTATION
UNICOS/mk systems
DESCRIPTION
PCCFFT3D computes the 3D complex Fast Fourier Transform (FFT) of the distributed complex matrix A,
This routine considers the processors to be partitioned into a two-dimensional (2D) grid. The 3D input
matrix A is then distributed across this 2D grid of processors as discussed in the following text.
Consider a 3D matrix A of size nx-by-ny-by-nz. nx, ny, and nz are the sizes of the matrix A along the X, Y,
and Z dimensions, respectively.
Let the processors (N$PES in number) be partitioned into a 2D grid of size npy-by-npz where npy is the
number of processors assigned to the Y dimension and npz is the number of processors assigned to the Z
dimension. Let the number of processors assigned to the X dimension be 1. To partition the processors into
this grid call the GRIDINIT3D(3S) routine as follows:
CAL L GRI DINIT3 D (IC TXT , 1, npy, npz)
The input matrix, A, and the output matrix, B, are distributed across this 2D processor grid by using the
block (as defined in FORTRAN D and HPF) distribution along the Y and Z dimensions. The distribution
along the X dimension is degenerate. The descriptors descA and descB provide information on the
distribution of the matrices A and B across the processor grid. The descriptors descA and descB are
initialized using the DESCINIT3D(3S) routine.
The DESCINIT3D(3S) routine would have to be called after the call to GRIDINIT3D(3S) and would look
like this:
CALL DESCINIT3D (descA, nx, ny, nz, nx, ICEIL(ny, npy), ICEIL(nz, npz), pesx, pesy, pesz,
ictxt, lldx, lldy, info)
Given that matrix A is distributed in a block manner across the processor grid along the Y and Z dimensions,
the block size along these two dimensions would be as follows:
nypp = ICEIL(ny, npy) and nzpp = ICEIL(nz, npz)
262 004– 2081– 002

(iA, jA, kA). Let this submatrix be of size n1-by-n2-by-n3. Then the iA, jA, and kA arguments represent the
global address of the first element of the submatrix and n1, n2, and n3 represent the size of the submatrix
over which the 3D FFT will be performed.
Similarly, the iB, jB, and kB arguments represent the first element of the submatrix to which the output will
be written.
Restrictions
arguments provided to DESCINIT3D(3S) to initalize descA and descB must be equal except the local
leading dimensions.
The flexibility of performing the FFT over any submatrix of the global input matrix A is not available in the
current release. Therefore, you must initialize iA, jA, kA, iB, jB, and kB with 1 and n1 with nx, n2 with ny,
and n3 with nz.
All processors must call this routine. In future releases only those processors that own the matrix over
which the FFT is to be performed, will participate in the computation. All other processors will exit the
3D FFT Theory
COM PLE X A(0 :n1 -1, 0:n 2-1 , 0:n 3-1 )
COM PLE X B(0 :n1 -1, 0:n 2-1 , 0:n 3-1 )
PCCFFT3D computes the formula:

n1−1 n2−1 n3−1 .k .k .k k 1 = 0, . . ., n1−1
Bk k k
1, 2, 3
= scale . Σ jΣ=0 jΣ=0 Aj j j
1, 2, 3
. ω1 j 1 1 . ω2 j 2 2 . ω3 j 3 3
for k 2 = 0, . . ., n2−1
j 1=0 2 3 k 3 = 0, . . ., n3−1
where
isign . 2 . π . i isign . 2 . π . i
ω1 = e n1
ω2 = e n2
isign . 2 . π . i
ω3 = e n3
i = +√−1
π = 3.14159. . . isign = ±1
forward or inverse transform, and what the scale factor should be in either case. To make this routine
scale.
004– 2081– 002 263

If you take the FFT with any particular values of isign and scale, the mathematical inverse function is
computed by taking the FFT with -isign and 1/(n1 . n2 . n3 . scale). In particular, if you use isign = +1 and
scale = 1.0 for the forward FFT, you can compute the inverse FFT by using isign = – 1 and scale = 1/(n1 .
n2 . n3).
vector of length 4.
The first element of isys indicates the dimension of the problem, i.e., isys(1) = 3. The next three elements of
isys indicate if the lengths n1, n2 and n3 are factorizable into powers of 2, 3 and 5. isys(2) is set to 0 if n1
is factorizable into powers of 2, 3 and 5 and is set to 1 otherwise. Similarly isys(3) and isys(4) are set to
For example if n1 = 256, n2 = 240 and n3 = 254, then the best computational time is obtained by setting
isys(2) = 0
isys(3) = 0
isys(4) = 1
If the numbers n1, n2 and n3 are not known ahead of time, then isys(2), isys(3) and isys(4) could be
initialized to 0 or 1; if an inappropriate choice is made, the routine would compute the correct result,
although slowly (if either n1, n2 or n3 were not factorizable into powers of 2, 3 and 5). If initialized to 1,
more workspace is needed; see the description of table which follows.
The PCCFFT3D routine accepts the following arguments:
follows:
n1 Integer. (input)
Transform size in the X dimension.
n2 Integer. (input)
Transform size in the Y dimension.
n3 Integer. (input)
Transform size in the Z dimension.
scale Real. (input)
Fourier transform.
264 004– 2081– 002

A Private complex array of the following dimension: (0:lldxA– 1, 0:lldyA– 1, 0:ICEIL(nz,npz)– 1).
(input)
lldxA and lldyA are the local leading dimensions along the X and Y dimensions, and are
initialized using DESCINIT3D(3S). A must be declared in a COMMON block.
iA With jA and kA, the global address of the first element of the global input matrix.
jA With iA and kA, the global address of the first element of the global input matrix.
kA With iA and jA, the global address of the first element of the global input matrix.
B Private complex array of the following dimension: (0:lldxB– 1, 0:lldyB– 1, 0:ICEIL(nz,npz)– 1).
(output)
lldxB and lldyB are the local leading dimensions along the X and Y dimensions and are
initialized using DESCINIT3D(3S).
The output array B may be the same as the input array A in which case the input array A is
overwritten with the transformed values. B must be declared in a COMMON block.
iB With jB and kB, the global address of the first element of the global matrix where output will be
written.
jB With iB and kB, the global address of the first element of the global matrix where output will be
written.
kB With iB and jB, the global address of the first element of the global matrix where output will be
written.
Contains description of the distribution of the matrix B across a 3D processor grid.
If the input array and the output array are the same, then the same descriptors must be used.
table Private real vector of length 2(n1 + n2 + n3) if isys(2), isys(3) and isys(4) = 0. Private real
vector of length 12(n1 + n2 + n3), if isys(2), isys(3) or isys(4) = 1. (input or output)
If isign = +1 or – 1, the values in the table are assumed to be initialized already by a prior call
with isign = 0 (table is input only).
work Private complex vector of length (n1r . ICEIL(n2r,npy) . ICEIL(n3r,npz). (workspace)
Where n1r, n2r and n3r are the values of n1, n2, and n3 rounded up to the nearest powers of 2
greater than or equal to them. work must be declared in a COMMON block.
004– 2081– 002 265


isys(2), isys(3) and isys(4) should be set to 0 or 1, depending on whether n1, n2, or n3 is
factorizable or not into powers of 2, 3 and 5 correspondingly.
illegal value, the routine exits after setting info to a negative number. – info indicates the
NOTES
The scale factor scale can take on values of 1.0 or 1.0/(n1 . n2 . n3) depending on whether the forward or
Algorithm
The routine uses a very efficient single FFT routine, CCFFT, to do the FFT of each column (X dimension)
on the processors that own the submatrix. It then transposes the submatrix along the X-Y plane, using
intermediate workspace that it allocates for the purpose, and again does the FFT along the columns (FFTs of
the Y dimension). The submatrix is again transposed along the X-Y plane to restore the original
distribution. Now the submatrix is transposed along the X-Z planes and the FFTs along the Z dimension are
computed. Finally another transpose along the X-Z plane restores the original distribution.
If either isys(2), isys(3) or isys(4) or all are initialized to 1, then a fast (O(n log(n))) algorithm based on the
chirp-z transform is used for the one dimensional FFT in the corresponding direction. In this case, the
vector table must be real of length 12(n1+n2+n3).
Workspace
8 . MAX(nx . ny . nz)
2 . MAX(nx . ICEIL(ny,npy), ny . ICEIL(nx,npy), nx . ICEIL(nz,npz), nz . ICEIL(nx,npz))
EXAMPLES
Example code for PCCFFT3D on a 16-processor partition:
266 004– 2081– 002

complex A(2 56,70, 50)

complex B(2 56,70, 50)
complex work(1 048 576 )
common /abw/ A, B, wor k
rea l tab le(8192)
integer ictxt, des cA( 12) , des cB( 12), isign, isy s(4 )
int ege r nx, ny, nz, npy , npz , ice il, inf o
int ege r n1, n2, n3
rea l sca le
nx = 240
ny = 181
nz = 145
n1 = nx
n2 = ny
n3 = nz
npy = 4
npz = n$p es / 4
call gridinit3 d(i ctx t,1,np y,n pz)
call descinit3 d( des cA, nx, ny, nz, nx, ice il( ny, npy ),
iceil( nz, npz ), 0, 0, 0, ictxt, 256 , 70, inf o )
if ( info .ne . 0 ) the n

call exit(0 )
end if
cal l des cin it3d( des cB, nx, ny, nz, nx, ice il(ny, npy),
iceil( nz, npz ), 0, 0, 0, ict xt, 256, 70, inf o )
if ( info .ne . 0 ) the n

call exit(0 )
end if
isign = -1
scale = 1.0
isys(1 ) = 3
isys(2 ) = 0
isys(3 ) = 1
004– 2081– 002 267

isys(4 ) = 1
*
* Ini tializ ing the tri g tab les
*
cal l pccfft 3d( 0, n1, n2, n3, sca le, A, 1, 1, 1,
des cA, B, 1, 1, 1, descB, tab le, wor k, isy s, inf o)

call exit(0 )
end if
*
* FFT
*
cal l pccfft 3d( isign, n1, n2, n3, sca le, A, 1, 1, 1,
des cA, B, 1, 1, 1, descB, tab le, wor k, isy s, inf o)

call exit(0 )
end if
cal l exi t(0 )

end
SEE ALSO
DESCINIT3D(3S), GRIDINFO3D(3S), GRIDINIT3D(3S), PCOORD3D(3S), PNUM3D(3S)
268 004– 2081– 002

PSCFFT2D ( 3S ) PSCFFT2D ( 3S )
NAME
PSCFFT2D, PCSFFT2D – Applies a two-dimensional (2D) real-to-complex or complex-to-real Fast Fourier
Transform (FFT) to a matrix distributed across a set of processors
SYNOPSIS
CALL PSCFFT2D (isign, n1, n2, scale, A, iA, jA, descA, B, iB, jB, descB, table, work,
isys, info)
CALL PCSFFT2D (isign, n1, n2, scale, A, iA, jA, descA, B, iB, jB, descB, table, work,
isys, info)
IMPLEMENTATION
UNICOS/mk systems
DESCRIPTION
PSCFFT2D computes the 2D real-to-complex Fast Fourier Transform (FFT) of the distributed real matrix A,
PCSFFT2D computes the two-dimensional complex-to-real Fast Fourier Transform (FFT) of the distributed
complex matrix A, and it stores the results in the distributed real matrix B.
PSCFFT2D considers the processors to be partitioned into a one-dimensional (1D) linear array of processors.
The 2D input matrix A is then distributed across this 1D grid of processors as discussed in the following
text.
Consider a 2D matrix A of size nr-by-nc, where nr is the number of rows and nc is the number of columns
of matrix A.
Let the processors (N$PES in number) be partitioned into a 1D grid of size 1-by-npc, where npc = N$PES is
the number of processors assigned to the column dimension of A. Let the number of processors assigned to
the row dimension be 1. To partition processors into this grid, call the BLACS_GRIDINIT routine as
shown:
CALL BLACS_ GRI DIN IT (ictxt, ’C’ , 1, npc)
The input matrix, A, and the output matrix, B, are distributed across this 1D linear array of processors by
using the block (as defined in FORTRAN D and HPF) distribution along the columns. The distribution
along the rows is degenerate. The descriptors descA and descB provide information on the distribution of
the matrices A and B across the processor grid. The descriptors descA and descB are initialized using the
DESCINIT(3S) routine. The DESCINIT(3S) routine would have to be called after the call to
BLACS_GRIDINIT and would look like this:
CALL DESCINIT (descA, nr, nc, nr, ICEIL(nc, npc), pesr, pesc, llda, info)
004– 2081– 002 269

Due to the symmetry in the FFT of A, the only computed values stored in the output matrix B are (0:(nr/2),
0:nc-1). Therefore, the call to DESCINIT(3S) for the output matrix B would look like the following:
nr
nrb = +1
2
CALL DESCINIT (descB, nrb, nc, nrb, ICEIL(nc, npc), pesr, pesc, lldb, info)
Here, llda and lldb are the local leading dimensions of the private data matrices A and B that store the local
portions of the global input and output 2D matrices participating in the FFT computation.
Given that matrix A is distributed in a block manner across the processor grid along the columns, the block
size along the columns would be the following:
ncpp = ICEIL(nc, npc)
(iA, jA). Let this submatrix be of size n1-by-n2. Then the arguments iA and jA represent the global address
of the first element of the submatrix and n1 and n2 represent the size of the submatrix over which the 2D
FFT is to be performed.
Similarly, the iB and jB arguments represent the first element of the submatrix to which the output is to be
written.
Restrictions
In the current release, it is required that the matrices A and B be distributed conformably. This means that
apart from the difference in the dimensions of A and B in the number of rows, the distribution along the
columns must be identical.
The flexibility of performing the FFT over any submatrix of the global matrix is not available in the current
release. Therefore, users must initialize iA, jA, iB, and jB with 1 and n1 with nr and n2 with nc.
All processors must call this routine. In future releases, only those processors that own the matrix over
which the FFT is to be performed will participate in the computation. All other processors will exit the
2D FFT Theory
REAL A(0 :n1-1, 0:n 2-1)
COMPLE X B(0 :n1/2, 0:n 2-1)
PSCFFT2D computes the formula:

n1−1 n2−1 .k .k
Bk k
1, 2
= scale . Σ Σ
j =0 j =0
Aj j
1, 2
. ω1 j 1 1 . ω2 j 2 2
for k 1 = 0, . . ., n1−1, k 2 = 0, . . ., n2−1
1 2
270 004– 2081– 002

where
isign . 2 . π . i isign . 2 . π . i
ω1 = e n1
ω2 = e n2
i = +√−1 π = 3.14159. . .
isign = ±1
If in a certain application it is known that the FFT of the complex input matrix is real, then instead of using
PCCFFT2D, you can save computation time by using PCSFFT2D. This is often the case because the
complex input matrix was the transform of a real matrix. In this case, you can save about half the
computational work and PCSFFT2D computes an identical formula with the input and output matrices
reversed.
forward or inverse transform, and what the scale factor should be in either case. To compute any of the
various possible definitions, however, choose the appropriate values for isign and scale.
If you call PSCFFT2D with any particular values of isign and scale the mathematical inverse function is
computed by calling PCSFFT2D with – isign and 1/(n1 . n2 . scale). In particular, if you use isign = +1 and
scale = 1.0 in PSCFFT2D for the forward FFT, you can compute the inverse FFT by using PCSFFT2D with
isign = – 1 and scale = 1.0/(n1 . n2).
PSCFFT2D is very similar in function to PCCFFT2D, but it takes the real-to-complex transform in the first
dimension, followed by the complex-to-complex transform in the second dimension.
PCSFFT2D does the reverse. It takes the complex-to-real FFT in the second dimension, followed by the
complex-to-real FFT in the first dimension.
See the SCFFT(3S) man page for more information about real-to-complex and complex-to-real FFTs. The
2D analog of the conjugate formula is as follows:
B(k1, k2) = conjg(B(n1 – k1, n2 – k2))
for
n1/2 < k1 ≤ n1– 1
Therefore, you have to compute only slightly more than half of the output values, namely:
B(k1, k2)
for
0 ≤ k1 ≤ n1 / 2
0 ≤ k2 ≤ n2– 1
Therefore, the only value of B that is computed is B(0:n1/2, 0:n2-1).
004– 2081– 002 271

vector of length 3.
If both n1 and n2 are factorizable into powers of 2, 3 and 5, for example, n1 = 30 and n2 = 120 then
isys(1) = 2
isys(2) = 0
isys(3) = 0
isys(1) = 2
isys(2) = 1
isys(3) = 0
isys(1) = 2
isys(2) = 0
isys(3) = 1
isys(1) = 2
isys(2) = 1
isys(3) = 1
If the numbers n1 and n2 are not known ahead of time, then isys(2) and isys(3) could be initialized to 0 or 1;
if an inapproriate choice is made, the routine would compute the correct result for n1 and n2, although
slowly. If initialized to 1, more workspace is needed; see the description of table which follows.
These routines accept the following arguments (all scalar values are private data):
follows:
n1 Integer. (input)
Number of rows in the sumbatrix to be transformed.
n2 Integer. (input)
Number of columns in the sumbatrix to be transformed.
272 004– 2081– 002

scale Real. (input)

Fourier transform.
A Private real array of dimension (0:lldA– 1, 0:ICEIL(nc,npc)– 1). (input)
Input array of values to be transformed. lldA is the local leading dimension and is initialized
using DESCINIT(3S). A must be declared in a COMMON block.
iA With jA, the global address of the first element of the global input matrix.
jA With iA, the global address of the first element of the global input matrix.
B Private complex array of dimension (0:lldB– 1, 0:ICEIL(nc,npc)– 1). (output)
Output array of transformed values. lldB is the local leading dimension and is initialized using
DESCINIT(3S). B must be declared in a COMMON block.
iB With jB, the global address of the first element of the global matrix where output will be written.
jB With iB, the global address of the first element of the global matrix where output will be written.
table Private real vector of length 2(n1 + n2) if both isys(2) and isys(3) are equal to zero. Private real
vector of length 12(n1 + n2) if either isys(2) or isys(3) is equal to 1. (input or output)
Table of trigonometric function values. If isign = 0, the routine initializes table (table is output
only).
work Private complex vector of length 2(n1r . ICEIL(n2r,npc). (workspace)
where n1r and n2r are the values of n1 and n2 rounded up to the nearest powers of 2 greater
than or equal to them. work must be declared in a COMMON block.
isys(2) indicates if n1 is prime or not factorizable into powers of 2, 3 and 5. Should be set to 1
if the number is not factorizable into powers of 2, 3 and 5. Should be set to 0 if it is
factorizable.
isys(3) should be set to 0 or 1, depending on whether n2 is factorizable or not into powers of 2,
3 and 5.
004– 2081– 002 273

The argument list for PCSFFT2D is identical to that of PSCFFT2D except that the input array for
PCSFFT2D is complex and the output array is real. If the routine PCSFFT2D was being used to compute
the inverse FFT of the matrix B (the FFT of the matrix A), then the arguments pertaining to A and B in
PSCFFT2D are reversed for PCSFFT2D.
NOTES
The scale factor scale can take on values of 1.0 or 1.0/(n1 . n2), depending on whether the forward or
The format of the vector that stores the trig tables (table) is the same for both routines. It can be initialized
by either routine.
Algorithm
The routine uses a very efficient single FFT routine, SCFFT, to do the FFT of each column on the
processors that own the submatrix. It then transposes the submatrix by using intermediate workspace that it
allocates for the purpose, and it again does the FFT along the columns (FFTs of the rows).
PCSFFT2D first transposes the matrix and performs a very efficient single processor FFT routine, CCFFT,
on the columns of the transposed matrix (that is, the rows of the original input matrix). This intermediate
matrix is then transposed again after which a complex-to-real FFT, CSFFT, is applied to the columns.
If either isys(2) or isys(3) or both are initialized to 1, then a fast (0(n log(n))) algorithm based on the chirp-z
transform is used for the 1D FFT in the corresponding direction. In this case, the vector table must be real
of length 12(n1+n2).
Workspace
8 . MAX(nr, nc)
2 . MAX(nr . ICEIL(nc,npc), nc . ICEIL(nr,npc))
EXAMPLES
Example code for PSCFFT2D and PCSFFT2D on a 16-processor partition:
274 004– 2081– 002

real A(256, 16)

com plex B(129, 16)
real C(256, 16)
comple x work(8 192 )
com mon /abcw/ A, B, C, wor k
comple x table( 600 0)
int eger ictxt, des cA( 9), des cB( 9), des cC( 9), isi gn, isy s(3)
int ege r nr, nc, ice il, inf o, np, nrB
int ege r n1, n2
rea l sca le
nr = 240
nc = 181
nrB= (nr/2) + 1
n1 = nr
n2 = nc
np = n$pes
call bla cs_gri din it(ict xt, ’C’ ,1, np)
call descin it( des cA, nr, nc, nr, ice il(nc, np),
0, 0, ict xt, 256 , inf o )

call exit(0 )
end if
cal l des cin it( descC, nr, nc, nr, ice il( nc, np) ,
0, 0, ict xt, 256 , inf o )

call exit(0 )
end if
cal l des cin it( descB, nrB , nc, nrB , ice il(nc, np),
0, 0, ict xt, 129 , inf o )

call exit(0 )
end if
004– 2081– 002 275

isign = -1
scale = 1.0
isys(1 ) = 2
isys(2 ) = 0
isys(3 ) = 1
*
* Ini tia liz ing the tri g tab les
*
cal l pscfft 2d( 0, n1, n2, sca le, A, 1, 1, des cA,
B, 1, 1, des cB, table, wor k, isy s, inf o)

cal l exi t(0)
end if
*
* FFT
*
call pscfft 2d(isi gn, n1, n2, scale, A, 1, 1, des cA,
B, 1, 1, des cB, table, wor k, isy s, inf o)

cal l exi t(0)
end if
*
* Invers e FFT
*
isi gn = 1
scale = 1.0 / float(n1* n2)
cal l pcsfft 2d( isign, n1, n2, sca le, B, 1, 1, des cB,
C, 1, 1, des cC, tab le, work, isys, info)
if ( inf o .ne . 0 ) then

cal l exi t(0)
end if
call exit(0 )
end
SEE ALSO
BLACS_GRIDINFO(3S), BLACS_GRIDINIT(3S), BLACS_PCOORD(3S), BLACS_PNUM(3S),
DESCINIT(3S)
276 004– 2081– 002

NAME
PSCFFT3D, PCSFFT3D – Applies a three-dimensional (3D) real-to-complex or complex-to-real Fast Fourier
Transform (FFT) to a matrix distributed across a set of processors
SYNOPSIS
CALL PSCFFT3D (isign, n1, n2, n3, scale, A, iA, jA, kA, descA, B, iB, jB, kB, descB,
CALL PCSFFT3D (isign, n1, n2, n3, scale, A, iA, jA, kA, descA, B, iB, jB, kB, descB,
IMPLEMENTATION
UNICOS/mk systems
DESCRIPTION
PSCFFT3D computes the 3D real-to-complex Fast Fourier Transform (FFT) of the distributed real matrix A,
PCSFFT3D computes the 3D complex-to-real Fast Fourier Transform (FFT) of the distributed complex
matrix B, and it stores the results in the distributed real matrix A.
This routine considers the processors to be partitioned into a two-dimensional (2D) grid. The 3D input
matrix A is then distributed across this 2D grid of processors as discussed in the following text.
Consider a 3D matrix A of size nx-by-ny-by-nz. nx, ny, and nz are the sizes of the matrix A along the X, Y,
and Z dimensions, respectively.
Let the processors (N$PES in number) be partitioned into a 2D grid of size npy-by-npz where npy is the
number of processors assigned to the Y dimension and npz is the number of processors assigned to the Z
dimension. Let the number of processors assigned to the X dimension be 1. To partition the processors into
this grid call the GRIDINIT3D(3S) routine as follows:
CALL GRIDIN IT3 D (IC TXT, 1, npy, npz)
The input matrix, A, and the output matrix, B, are distributed across this 2D processor grid by using the
block (as defined in FORTRAN D and HPF) distribution along the Y and Z dimensions. The distribution
along the X dimension is degenerate. The descriptors descA and descB provide information on the
distribution of the matrices A and B across the processor grid. The descriptors descA and descB are
initialized using the DESCINIT3D(3S) routine. The DESCINIT3D(3S) routine would have to be called
after the call to GRIDINIT3D(3S) and would look like this:
CALL DESCINIT3D (descA, nx, ny, nz, nx, ICEIL(ny, npy), ICEIL(nz, npz), pesz, pesy, pesz,
ictxt, lldxA,
004– 2081– 002 277

Due to the symmetry in the FFT of A, the only computed values stored in the output matrix B are (0:(nx/2),
0:ny-1, 0:nz-1). Therefore, the call to DESCINIT3D(3S) for the output matrix B would look like the
following:
nxB = (nx/2) + 1
CALL DESCINIT3D (descB, nxB, ny, nz, nxB, ICEIL(ny, npy), ICEIL(nz, npz), pesx, pesy,
pesz, ictxt, lldxB, lldyB, info)
Here, llda and lldb are the local leading dimensions of the private data matrices A and B that store the local
portions of the global input and output 3D matrices participating in the FFT computation.
Given that matrix A is distributed in a block manner across the processor grid along the Y and Z dimensions,
the block size along these two dimensions would be as follows:
nypp = ICEIL(ny, npy) and nzpp = ICEIL (nz, npz)
(iA, jA, kA). Let this submatrix be of size n1-by-n2-by-n3. Then the iA, jA, and kA arguments represent the
global address of the first element of the submatrix and n1, n2, and n3 represent the size of the submatrix
over which the 3D FFT will be performed.
Similarly, the iB, jB, and kB arguments represent the first element of the submatrix to which the output will
be written.
Restrictions
arguments provided to DESCINIT3D(3S) to initalize descA and descB must be equal, except the local
leading dimensions, and the size of the matrix in the X dimension.
The flexibility of performing the FFT over any submatrix of the global matrix is not available in the current
release. Therefore, you must initialize iA, jA, kA, iB, jB, and kB with 1 and n1 with nx, n2 with ny, and n3
with nz.
All processors must call this routine. In future releases only those processors that own the matrix over
which the FFT is to be performed, will participate in the computation. All other processors will exit the
3D FFT Theory
REAL A(0 :n1 -1, 0:n 2-1 , 0:n 3-1)
COMPLE X B(0 :n1/2, 0:n2-1 , 0:n3-1 )
n1−1 n2−1 n3−1 .k .k .k
Σ Σ Σ
j . ω2 j . ω3 j
PSCFFT3D computes the formula: Bk k k
1, 2, 3
= scale . A j ,j ,j . ω1
1 2 3
1 1 2 2 3 3
j =0 j =0 j =0
1 2 3
k 1 = 0, . . ., n 1 / 2
for k 2 = 0, . . ., n2−1
k 3 = 0, . . ., n3−1
278 004– 2081– 002

where
isign . 2 . π . i
ω1 = e n1
π = 3.14159. . .
isign . 2 . π . i
ω2 = e n2
i = +√−1
isign . 2 . π . i
ω3 = e n3
isign = ±1
If in a certain application it is known that the FFT of the complex input matrix is real, then instead of using
PCCFFT3D, you can save computation time by using PCSFFT3D. Often, this is the case because the
complex input matrix was the transform of a real matrix. In this case, you can save about half of the
computational work and PCSFFT3D computes an identical formula with the input and output matrices
reversed.
forward or inverse transform, and what the scale factor should be in either case. To make this routine
scale.
If you call PSCFFT3D with any particular values of isign and scale, the mathematical inverse function is
computed by taking the FFT with – isign and 1 /(n1 . n2 . n3 . scale). In particular, if you use isign = +1
and scale = 1.0 in PSCFFT3D for the forward FFT, you can compute the inverse FFT by using PCSFFT3D
with isign = – 1 and scale = 1/(n1 . n2 . n3).
PSCFFT3D is very similar in function to PCCFFT3D, but it takes the real-to-complex transform in the first
dimension, followed by the complex-to-complex transform in the second and third dimension. PCSFFT3D
does the reverse. It takes the complex-to-complex FFT in the third and second dimension, followed by the
complex-to-real FFT in the first dimension. See the SCFFT(3S) man page for more information about
real-to-complex and complex-to-real FFTs. The three dimensional analog of the conjugate formulate is as
follows:
B(k1, k2, k3) = conjg(B(n1 – k1, n2 – k2, n3 – k3))
for
n1 / 2 < k1 ≤ n1 – 1
0 ≤ k2 ≤ n2 – 1
0 ≤ k3 ≤ n3 – 1
where the notation conjg(z) represents the complex conjugate of z.
Therefore, you have to compute only slightly more than half of the output values, namely:
B(k1, k2, k3)
for
0 ≤ k1 ≤ n1/2
0 ≤ k2 n2– 1
0 ≤ k3 ≤ n3– 1
004– 2081– 002 279

Therefore, the only values of B that are computed are B(0: n1 / 2, 0:n2– 1,0:n3– 1).
If the values of either n1, n2, or n3 are prime or not factorizable into powers of 2, 3 and 5 then significant
vector of length 4.
The first element of isys indicates the dimension of the problem, i.e., isys(1) = 3. The next three elements of
isys indicate if the lengths n1, n2 and n3 are factorizable into powers of 2, 3 and 5. isys(2) is set to 0 if n1
is factorizable into powers of 2, 3 and 5 and is set to 1 otherwise. Similarly isys(3) and isys(4) are set to
For example if n1 = 256, n2 = 240 and n3 = 254, then the best computational time is obtained by setting
isys(2) = 0
isys(3) = 0
isys(4) = 1
If the numbers n1, n2 and n3 are not known ahead of time, then isys(2), isys(3) and isys(4) could be
initialized to 0 or 1; if an inappropriate choice is made, the routine would compute the correct result,
although slowly. If initialized to 1, more workspace is needed; see the description of table which follows.
The PSCFFT3D routine accepts the following arguments:
follows:
n1 Integer. (input)
Transform size in the X dimension.
n2 Integer. (input)
Transform size in the Y dimension.
n3 Integer. (input)
Transform size in the Z dimension.
scale Real. (input)
Fourier transform.
A Private complex array of dimension (0:lldxA– 1,0:lldyA– 1,0:ICEIL(nz,npz)– 1). (input)
Input array of values to be transformed. lldxA and lldyA are the local leading dimensions along
the X and Y dimensions, and are initialized using DESCINIT3D(3S). A must be declared in a
COMMON block.
280 004– 2081– 002

iA With jA and kA, the global address of the first element of the global input matrix.
jA With iA and kA, the global address of the first element of the global input matrix.
kA With iA and jA, the global address of the first element of the global input matrix.
B Private complex array of dimension (0:lldxB– 1,0:lldyB– 1,0:ICEIL(nz,npz)– 1). (output)
Output array of transformed values. lldxB and lldyB are the local leading dimensions along the
X and Y dimensions and are initialized using DESCINIT3D(3S). B must be declared in a
COMMON block.
The output array B may be the same as the input array A in which case the input array A is
overwritten with the transformed values.
iB With jB and kB, the global address of the first element of the global matrix where output will be
written.
jB With iB and kB, the global address of the first element of the global matrix where output will be
written.
kB With iB and jB, the global address of the first element of the global matrix where output will be
written.
If the input array and the output array are the same, then the same descriptors must be used.
table Private real vector of length 2(n1 + n2 + n3) if isys(2), isys(3) and isys(4) = 0. Private real
vector of length 12(n1 + n2 + n3), if isys(2), isys(3) or isys(4) = 1. (input or output)
If isign = 0, the routine initializes table (table is output only). If isign = +1 or – 1, the values in
the table are assumed to be initialized already by a prior call with isign = 0 (table is input only).
work Private complex vector length 2(n1r . ICEIL(n2r,npy) . ICEIL(n3r,npz)
where n1r, n2r, and n3r are the values of n1, n2 and n3 rounded up to the nearest powers of 2
greater than or equal to them. work must be declared in a COMMON block.
isys(2), isys(3) and isys(4) should be set to 0 or 1, depending on whether n1, n2, or n3 is
factorizable or not into powers of 2, 3 and 5 correspondingly.
004– 2081– 002 281

NOTES
The scale factor scale can take on values of 1.0 or 1.0/(n1 . n2 . n3) depending on whether the forward or
The format of the vector that stores the trig tables (table) is the same for both routines. It can be initizalized
by either routine.
Algorithm
The routine uses a very efficient single FFT routine, CCFFT, to do the FFT of each column (X dimension)
on the processors that own the submatrix. It then transposes the submatrix along the X-Y plane, using
intermediate ,orkspace that it allocates for the purpose, and again does the FFT along the columns (FFTs of
the Y dimension). The submatrix is again transposed along the X-Y plane to restore the original
distribution. Now the submatrix is transposed along the X-Z planes and the FFTs along the Z dimension are
computed. Finally another transpose along the X-Z plane restores the original distribution.
If either isys(2), isys(3) or isys(4) or all are initialized to 1, then a fast (O(n log(n))) algorithm based on the
chirp-z transform is used for the one dimensional FFT in the corresponding direction. In this case, the
vector table must be real of length 12(n1+n2+n3).
Workspace
8 . (MAX(nx,ny,nz).
2 . MAX(nx . ICEIL(ny,npy), ny . ICEIL(nx,npy), nx . ICEIL(nz,npz), nz . ICEIL (nx,npz))
EXAMPLES
Example code for PSCFFT3D on a 16-processor system:
real A(256, 50, 40)
real C(256, 50, 40)
com plex B(1 29, 50, 40)
com plex wor k(2 097 152 )
common /ab cw/ A, B, C, wor k
real table( 819 2)
int eger ict xt, des cA( 12) , des cB( 12) , isi gn, isy s(4 )
int eger nx, ny, nz, npy , npz , ice il, inf o
int eger n1, n2, n3
282 004– 2081– 002

rea l sca le
nx = 240
ny = 181
nz = 145
n1 = nx
n2 = ny
n3 = nz
npy = 4
npz = n$p es / 4
call gridin it3d(i ctx t,1 ,npy,n pz)
cal l des cinit3 d( des cA, nx, ny, nz, nx, ice il( ny, npy ),
iceil( nz,npz ), 0, 0, 0, ict xt, 256 , 50, inf o )
if ( info .ne. 0 ) the n

cal l exi t(0)
end if
cal l des cinit3 d( des cC, nx, ny, nz, nx, ice il( ny, npy ),
iceil( nz,npz ), 0, 0, 0, ict xt, 256 , 50, inf o )
if ( info .ne. 0 ) the n
cal l exi t(0)
end if
cal l des cinit3 d( des cB, nx, ny, nz, nx, ice il( ny, npy ),
ice il(nz, npz), 0, 0 ,0, ictxt, 129 , 50, info)
if ( inf o .ne . 0) then

cal l exi t(0)
end if
isi gn = -1
sca le = 1.0
isy s(1) = 3
isy s(2) = 0
isy s(3) = 1
isy s(4) = 1
*
* Ini tializ ing the trig tables
*
call pscfft 3d(0, n1, n2, n3, sca le, A, 1, 1, 1,
004– 2081– 002 283

des cA, B, 1, 1, 1, des cB, tab le, wor k, isys, inf o)
if ( inf o .ne. 0) the n

cal l exit(0 )
end if
*
* FFT
*
cal l psc fft 3d( isi gn, n1, n2, n3, sca le, A, 1, 1, 1,
des cA, B, 1, 1, 1, des cB, tab le, wor k, isys, inf o)
if ( inf o .ne. 0) the n

cal l exit(0 )
end if
isi gn = +1
sca le = 1.0 /float (n1 *n2*n3 )
*
* Inv ers e FFT
*
cal l pcs fft 3d( isi gn, n1, n2, n3, scale, B, 1, 1, 1
des cB, C, 1, 1, 1, des cC, table, wor k, isy s, inf o)
if ( inf o .ne. 0) then

cal l exit(0 )
end if
cal l exi t(0 )

end
SEE ALSO
DESCINIT3D(3S), GRIDINFO3D(3S), GRIDINIT3D(3S), PCOORD3D(3S), PNUM3D(3S)
284 004– 2081– 002

RCFFT2 ( 3S ) RCFFT2 ( 3S )
NAME
RCFFT2 – Applies a real-to-complex Fast Fourier Transform (FFT)
SYNOPSIS
CALL RCFFT2 (init, ix, n, x, work, y)
IMPLEMENTATION
UNICOS systems
DESCRIPTION
RCFFT2 calculates the following:
n−1
2πi
yk = 2 Σ xj
j =0
exp (±
n
jk ) for k = 0,1,. . ., n / 2
The sign of the exponent is the same as the sign of ix.

If nonzero, generates sine and cosine tables in work. If 0, calculates FFTs by using sine and
ix Integer. (input)
> 0 Calculates a forward transform
< 0 Calculates an inverse transform
n Integer. (input)
m
Size of the Fourier transform (2 , where m ≥ 3).
Input vector. Range of x:
2n 102466
≤ xi ≤ for i = 1,2,. . .,n.
102466 2n
work Complex array of dimension (3 . n / 2) + 2. (scratch output)
y Complex array of dimension (n / 2) + 1. (output)
Result vector.
SEE ALSO
CFFT2(3S), CRFFT2(3S)
SCFFT(3S), which supersedes this routine only on Cray Y-MP systems
004– 2081– 002 285

RFFTMLT ( 3S ) RFFTMLT ( 3S )
NAME
RFFTMLT – Applies complex-to-real or real-to-complex Fast Fourier Transforms (FFTs) on multiple input
vectors
SYNOPSIS
CALL RFFTMLT (x, work, trigs, ifax, inc1x, inc2x, n, lot, isign)
IMPLEMENTATION
UNICOS systems
DESCRIPTION
When isign = – 1, RFFTMLT applies real-to-complex FFTs (forward transforms) on more than one input
vector. When isign = +1, RFFTMLT applies complex-to-real inverse FFTs (inverse transforms) on more than
one input vector.
x Real array of dimension (0:n+1, lot). (input and output)
Contains the input values before the call to RFFTMLT, and output values after the call. On exit,
the computed output values are stored in the space originally occupied by input values. Because
the output is written back into the input array and contains n/2+1 complex values per transform,
you must size the input array to contain at least n+2 real elements per transform. (See the Data
Format subsection.)
work Real array of dimension 2 . n . lot . (scratch output)
trigs Real array of dimension 2n. (input)
Sine and cosine tables for FFT calculation. The following call initializes the vectors trigs and
ifax:
CALL FFT FAX (n, ifax, trigs)
ifax Integer array of dimension 19. (input)

List of prime factors of n. Generally, ifax is initialized by FFTFAX, as stated previously.
The increment within each data vector; that is, the address distance between consecutive
elements of each vector to be transformed. The increment is always given in real (not complex)
words.
The increment between data vectors; that is, the address distance between corresponding
elements in adjacent data vectors. inc2x is typically the length of the leading dimension of x, as
noted previously. The increment is always given in real (not complex) words.
286 004– 2081– 002

n Integer. (input)
Length of each data vector. n ≥ 2. n must be even. Any value of n that is not valid causes
FFTFAX to return the error code ifax(1) = – 99.
The number of data vectors.
Sign of the transform:
isign = – 1 Calculates real-to-complex (forward) FFT
isign = +1 Calculates complex-to-real (inverse) FFT
NOTES
Superseded and Preferred Routines

On UNICOS systems, RFFTMLT is superseded by the routines SCFFTM(3S) (real-to-complex, multiple
FFTs) and CSFFTM(3S) (complex-to-real, multiple FFTs).
Choice of Transform
The final argument, isign, determines whether a real-to-complex, or a complex-to-real transform is done, as
follows.
Real-to-complex transform (isign = – 1)
When isign = – 1, RFFTMLT performs a real-to-complex FFT on a set of vectors.
For each of the m real input vectors,
x j,m j = 0,1,. . .,n-1
RFFTMLT computes the complex output vector
y k,m k = 0,1,. . .,n / 2
defined by
n −1 2.π.i
−jk
yk ,m = Σ
j =0
x j ,m ωn for k = 0,1,. . .,n / 2, where ωn =e n
Only the first n / 2+1 complex output vectors are computed for each vector. The theory of Fourier transforms
implies that because the input is real, the values obey the symmetry:
y n– k,m = y k,m
(where the notation z denotes the complex conjugate of z).
Thus, the last n / 2 output values are complex conjugates of the first n / 2 output values.
004– 2081– 002 287

Complex-to-real transform (isign = +1)

When isign = +1, RFFTMLT performs a complex-to-real FFT on a set of vectors. For each of the m
complex input vectors,
y k,m k = 0,1,. . .,n / 2
RFFTMLT computes the real output vector
x j,m j = 0,1,. . .,n-1
defined by
n −1 2.π.i
1
Σ
jk
x j ,m = yk ,m ωn for j = 0,1,. . .,n– 1 where ωn =e n
n k =0
Although the summation in the definition runs from 0 to n– 1, actually only the first n/2+1 values for each
input vector are used. The other input values are deduced from the following symmetry:
y n– k,m = y k,m
which, according to the theory, must be true because the transform of the input data is real-valued. The
isign=– 1 and isign=+1 transforms are inverses of each other.
Data Format
The x array contains both input and output values of either the real-to-complex or complex-to-real transform.
The array is declared real, but, on output from the real-to-complex transform and on input into the
complex-to-real transform, x contains complex values. The following describes how complex values are
arranged in the real array x.
Real-to-complex (isign = – 1)
The output values are stored in the same array as the input values. On input, lot real input vectors of length
n are stored as follows:
x is stored in X(j . inc1x, m) for j = 0,1,. . .,n-1 m = 1,2,. . .,lot
j,m
Space for the values X(n . inc1x,m) and X (n+1)inc1x,m must also be reserved, although these values are
not used on input, and they may be undefined.
On output, lot complex output vectors of length n / 2 +1 (same as n+2 "real" elements per vector) are stored
in the same array elements as the real input vectors, so that
Real(y ) is stored in X(2k . inc1x,m)
(k,m)
Imaginary(y (k,m) ) is stored in X((2k+1)inc1x,m)
for k = 0,1,. . .,n / 2
m = 1,2,. . .,lot
For all lot output vectors, y 0,m and y n / 2,m have real number values. Thus, their imaginary parts are set to 0.
288 004– 2081– 002

Complex-to-real (isign = +1)

The input and output data format is exactly the opposite of that given previously for isign = – 1.
Normalization
RFFTMLT uses a normalization (scale factor) that differs from the one used by CFFT2(3S), CRFFT2(3S),
and RCFFT2(3S).
Performance
For fastest performance, n should be a product only of powers of 2, 3, and 5. Vectorization is achieved by
doing parallel transforms, with vector length = lot.
The memory stride for vector loads and stores is inc2x; therefore, to avoid slowdowns due to memory
contention, inc2x should be an odd number.
EXAMPLES
The following program shows how to invoke RFFTMLT.
parame ter (n = 16, lot = 2, inc = 1, jump = inc *(n+2) )
real a(jump, lot ), trigs( 2*n), work(2 *n*lot )
int ege r ifa x(19)
. . .
*-- --------- --- ------ --- ------ ------ ------ ------ ------ ------ ------ ----
* Com put e the FFT of A, usi ng RFF TML T
cal l fft fax(n, ifa x, tri gs)

call rfftmlt(a , wor k, tri gs, ifax, inc, jump, n, lot , -1)
. . .
end
SEE ALSO
CFFTMLT(3S), CRFFT2(3S), RCFFT2(3S)
SCFFTM(3S), which supersedes this routine only on Cray PVP systems
004– 2081– 002 289

SCFFT ( 3S ) SCFFT ( 3S )
NAME
SCFFT, CSFFT – Computes a real-to-complex or complex-to-real Fast Fourier Transform (FFT)
SYNOPSIS
CALL SCFFT (isign, n, scale, x, y, table, work, isys)
CALL CSFFT (isign, n, scale, x, y, table, work, isys)
IMPLEMENTATION
DESCRIPTION
SCFFT computes the FFT of the real array X, and it stores the results in the complex array Y. CSFFT
computes the corresponding inverse complex-to-real transform.
It is customary in FFT applications to use zero-based subscripts; the formulas are simpler that way. For
SCFFT, suppose that the arrays are dimensioned as follows:
REA L X(0:n- 1)
COM PLEX Y(0:n/ 2)
Then the output array is the FFT of the input array, using the following formula for the FFT:
n −1
Σ
. j .k
Yk = scale X j . ωisign for k = 0, . . ., n ⁄ 2
j =0
where 2 . π . i
ω=e n
i = + √−1
π = 3.14159. . . isign = ±1
isign and scale.
The relevant fact from FFT theory is this: If you call SCFFT with any particular values of isign and scale,
the mathematical inverse function is computed by calling CSFFT with – isign and 1 /(n .scale ). In particular,
if you use isign = +1 and scale = 1.0 in SCFFT for the forward FFT, you can compute the inverse FFT by
using CSFFT with isign = – 1 and scale = 1.0 / n.
as follows:
290 004– 2081– 002

n Integer. (input)
Size of transform. If n ≤ 2, SCFFT returns without calculating the transform.
scale Real. (input)
transform, as defined in the preceding formula.
x SCFFT: Real array of dimension (0:n– 1). (input)
CSFFT: Complex array of dimension (0:n / 2). (input)
y SCFFT: Complex array of dimension (0:n / 2). (output)
CSFFT: Real array of dimension (0:n– 1). (output)
The output array, y, is the FFT of the the input array, x, computed according to the preceding
formula. The output array may be equivalenced to the input array in the calling program. Be
careful when dimensioning the arrays, in this case, to allow for the fact that the complex array
contains two (real) words more than the real array.
table UNICOS systems: Real array of dimension (100 + 4n). (input or output)
UNICOS/mk systems: Real array of dimension (2n). (input or output)
If isign = 0, the table array is initialized to contain trigonometric tables needed to compute an
FFT of size n.
isign = 0.
work UNICOS systems: Real array of dimension (4 + 4n). (scratch output)
UNICOS/mk systems: Real array of dimension (2n).
Use isys to specify certain processor-specific parameters or options. The first element of the
array specifies how many more elements are in the array.
argument value as the scalar integer constant 0. If isys(0) > 0, isys(0) gives the upper bound of
the isys array; that is, if il = isys(0), user-specified parameters are expected in isys(1) through
isys(il).
004– 2081– 002 291

NOTES
This subsection contains implementation information, initialization information, and performance tips.
Notice in the preceding formula that there are n real input values, and n / 2 + 1 complex output values. This
property is characteristic of real-to-complex FFTs.
to another sequence of n complex values. A complex-to-complex FFT routine, such as CCFFT(3S), will take
n complex input values, and produce n complex output values. In fact, one easy way to compute a real-to-
complex FFT is to store the input data in a complex array, then call routine CCFFT to compute the FFT.
You get the same answer when using the SCFFT routine.
The reason for having a separate real-to-complex FFT routine is efficiency. Because the input data is real,
you can make use of this fact to save almost half of the computational work. The theory of Fourier
transforms tells us that for real input data, you have to compute only the first n / 2 + 1 complex output
values, because the remaining values can be computed from the first half of the values by the simple
formula:
Y(k) = conjg(Y(n-k)) for n / 2 ≤ k ≤ n-1
where the notation conjgY represents the complex conjugate of y.
stored. Likewise, as explained later, only the first half of the complex data has to be supplied for the
complex-to-real FFT.
Another implication of FFT theory is that, for real input data, the first output value, Y(0), will always be a
real number; therefore, the imaginary part will always be 0. If n is an even number, Y(n/2) will also be real
and thus, have zero imaginary parts.
Generally, the FFT transforms a complex sequence into a complex sequence. However, in a certain
application we may know the output sequence is real. Often, this is the case because the complex input
sequence was the transform of a real sequence. In this case, you can save about half of the computational
work.
n
X(k) = conjg(X(n-k)) for ≤ k ≤ n-1
2
And, in fact, the input values X(k) for k > n / 2 need not be supplied; they can be inferred from the first half
of the input.
292 004– 2081– 002

Thus, in the complex-to-real routine, CSFFT, the arrays can be dimensioned as follows:
COMPLE X X(0 :n/ 2)
REAL Y(0:n- 1)
There are n / 2 + 1 complex input values and n real output values. Even though only n / 2 + 1 input values
are supplied, the size of the transform is still n in this case, because implicitly you are using the FFT
formula for a sequence of length n.
Another implication of the theory is that X(0) must be a real number (that is, it must have zero imaginary
part). Also, if n is even, X(n/2) must also be real. Routine CSFFT assumes that these values are real; if you
specify a nonzero imaginary part, it is ignored.
The table array stores the trigonometric tables used in calculation of the FFT. This table must be initialized
by calling the routine with isign = 0 prior to doing the transforms. The table does not have to be
reinitialized if the value of the problem size, n, does not change. Because SCFFT and CSFFT use the same
format for table, either can be used to initialize it (note that CCFFT uses a different table format).
Dimensions
applications. Thus, the input and output arrays are declared (assuming n > 0):
REAL X(0:n- 1)
COM PLEX Y(0 :n/2)
No change is needed in the calling sequence; however, if you prefer you can use the more customary Fortran
style with subscripts starting at 1, as in the following:
REA L X(n )
COM PLE X Y(n /2 + 1)
Performance Tips
These routines will compute an FFT for any value of n.
Performance for a given value of n depends on the prime factorization of n. This fact is characteristic of all
FFT algorithms.
Fastest performance is realized when n is a power of 2, in which case the number of floating-point
operations is approximately (5 / 2) . n . log 2 (n).
If n contains factors of 3, performance is slightly worse. If n contains powers of 5, it is slightly more worse.
Worst performance is when n is a prime number. In that case, the number of operations is approximately
2
4n .
The kernel routines are optimized for values of n that are even numbers and are products of powers of 2, 3,
and 5. (Because the kernel routines have a special case for multiples of 4, even powers of 2 will be slightly
faster than odd powers of 2.)
004– 2081– 002 293

The Standard FFT routines were designed so that they could be implemented efficiently on many different
architectures. The calling sequence is the same in any implementation. Certain details, however, depend on
the particular implementation. These details are confined to two areas:
• The first area is the size of the table and work arrays. Different sizes may be needed on different
systems. No change is required to the subroutine call, but you may have to change the array sizes in the
specify an isys argument as constant 0. Other options may be provided in subsequent software releases.
EXAMPLES
These examples use the table and workspace sizes appropriate to UNICOS systems.
only the arguments isign, n, and table are used. You can use dummy arguments or zeros for the other
REAL TAB LE( 100 + 4*1024 )
CALL SCF FT( 0, 102 4, 0.0 , DUM MY, DUM MY, TAB LE, DUM MY, 0)
Example 2: X is a real array of dimension (0:1023), and Y is a complex array of dimension (0:512). Take
the FFT of X and store the results in Y. Before taking the FFT, initialize the TABLE array, as in example 1.
REAL X(0 :1023)
COMPLE X Y(0:51 2)
REAL TABLE( 100 + 4*1 024)
REAL WOR K(4*10 24 + 4)
...
CALL SCFFT( 0, 102 4, 1.0, X, Y, TAB LE, WORK, 0)
CALL SCFFT( 1, 102 4, 1.0, X, Y, TAB LE, WOR K, 0)
CALL CSF FT( -1, 102 4, 1.0/1024. 0, Y, X, TABLE, WOR K, 0)
294 004– 2081– 002

REA L X(1 024 )
COM PLE X Y(5 13)
...
CAL L SCF FT( 0, 102 4, 1.0 , X, Y, TAB LE, WOR K, 0)
CAL L SCF FT( 1, 102 4, 1.0 , X, Y, TAB LE, WOR K, 0)
REA L X(1 024 )
COM PLE X Y(5 13)
EQU IVA LEN CE ( X(1 ), Y(1 ) )
...
CAL L SCF FT( 1, 102 4, 1.0 , X, Y, TABLE, WOR K, 0)
SEE ALSO
CCFFT(3S), CCFFTM(3S), SCFFTM(3S)
004– 2081– 002 295

SCFFT2D ( 3S ) SCFFT2D ( 3S )
NAME
SCFFT2D, CSFFT2D – Applies a two-dimensional real-to-complex or complex-to-real Fast Fourier
Transform (FFT)
SYNOPSIS
CALL SCFFT2D (isign, n1, n2, scale, x, ldx, y, ldy, table, work, isys)
CALL CSFFT2D (isign, n1, n2, scale, x, ldx, y, ldy, table, work, isys)
IMPLEMENTATION
DESCRIPTION
SCFFT2D computes the two-dimensional Fast Fourier Transform (FFT) of the real matrix X, and it stores
the results in the complex matrix Y. CSFFT2D computes the corresponding inverse transform.
In FFT applications, it is customary to use zero-based subscripts; the formulas are simpler that way. First
the function of SCFFT2D is described. Suppose the arrays are dimensioned as follows:
REA L X(0:ld x-1 , 0:n 2-1 )
COM PLEX Y(0:ld y-1 , 0:n 2-1 )
where ldx ≥ n1 ldy ≥ (n1/2) + 1.

SCFFT2D computes the formula:
n1−1 n2−1 .k .k n1
Σ Σ
j . ω2 j
Yk , k = scale X j ,j . ω1 1 1 2 2
for k 1 = 0, . . ., +1, k 2 = 0, . . ., n2−1
1 2
j =0 j =0
1 2
2
1 2
where isign . 2 . π . i
ω1 = e n1
i = +√−1
isign . 2 . π . i
ω2 = e n2
π = 3.14159. . .
isign = ±1
isign and scale.
the mathematical inverse function is computed by taking the FFT with – isign and 1 / (n1 . n2 . scale). In
using isign = – 1 and scale = 1.0/(n1 . n2).
296 004– 2081– 002

SCFFT2D is very similar in function to CCFFT2D, but it takes the real-to-complex transform in the first
dimension, followed by the complex-to-complex transform in the second dimension.
CSFFT2D does the reverse. It takes the complex-to-complex FFT in the second dimension, followed by the
complex-to-real FFT in the first dimension.
See the SCFFT(3S) man page for more information about real-to-complex and complex-to-real FFTs. The
two-dimensional analog of the conjugate formula is as follows:
Yk , k
=Y n1 – k , n2 – k
for n1 / 2 < k 1 ≤ n1 – 1 0 ≤ k 2 ≤ n2 – 1
1 2 1 2
where the notation z represents the complex conjugate of z.

Thus, you have to compute only (slightly more than) half of the output values, namely:
Yk , k
for 0 ≤ k 1 ≤ n1 / 2 0 ≤ k 2 ≤ n2 – 1
1 2

If the values of either n1 or n2 are prime or not factorizable into powers of 2, 3 and 5 significant
vector of length 3.
If both n1 and n2 are factorizable into powers of 2, 3 and 5, and for example, n1 = 30 and n2 = 120 then
isys(1) = 2
isys(2) = 0
isys(3) = 0
isys(1) = 2
isys(2) = 1
isys(3) = 0
isys(1) = 2
isys(2) = 0
isys(3) = 1
isys(1) = 2
isys(2) = 1
isys(3) = 1
If the numbers n1 and n2 are not known ahead of time, then isys(2) and isys(3) could be initialized to 0 and
the routine would compute correct results for n1 and n2, albeit slowly, if either n1 or n2 were prime.
004– 2081– 002 297

This feature does not exist for UNICOS systems and isys is ignored on those machines.
as follows:
n1 Integer. (input)
Transform size in the first dimension. If n1 is not positive, SCFFT2D returns without
calculating a transform.
n2 Integer. (input)
Transform size in the second dimension. If n2 is not positive, SCFFT2D returns without
calculating a transform.
scale Real. (input)
x SCFFT2D: Real array of dimension (0:ldx– 1, 0:n2– 1). (input)
CSFFT2D: Complex array of dimension (0:ldx– 1, 0:n2– 1). (input)
Array of values to be transformed.
The number of rows in the x array, as it was declared in the calling program. That is, the
leading dimension of x.
SCFFT2D: ldx ≥ MAX(n1, 1).
CSFFT2D: ldx ≥ MAX(n1/2 + 1, 1).
y SCFFT2D: Complex array of dimension (0:ldy– 1, 0:n2– 1). (output)
CSFFT2D: Real array of dimension (0:ldy– 1, 0:n2– 1). (output)
Output array of transformed values. The output array can be the same as the input array, in
which case, the transform is done in place and the input array is overwritten with the
transformed values. In this case, it is necessary that the following equalities hold:
SCFFT2D: ldx = 2ldy.
CSFFT2D: ldy = 2ldx.
The number of rows in the y array, as it was declared in the calling program (the leading
dimension of y).
298 004– 2081– 002

SCFFT2D: ldy ≥ MAX(n1/2 + 1, 1).

CSFFT2D: ldy ≥ MAX(n1 + 2, 1).
In the complex-to-real routine, two extra elements are in the first dimension (ldy ≥ n1 + 2, rather
than just ldy ≥ n1). These elements are needed for intermediate storage during the computation.
On exit, their value is undefined.
table UNICOS systems: real array of dimension 100 + 2 . (n1 + n2). (input or output)
UNICOS/mk systems: Real array of dimension 2 . (n1 + n2) if both isys(2) and isys(3) are equal
to zero. Private real vector of length 12 . (n1 + n2) if either isys(2) or isys(3) is equal to 1.
(input or output)
work UNICOS systems: real array of dimension 512 . MAX(n1, n2). (scratch output)
UNICOS/mk systems: Real array of dimension (n1+n2) . n2 (scratch output)
isys UNICOS systems: ignored.
UNICOS/mk systems: integer array of length 3. (input)
isys(1) = 2
See PCCFFT2D(3S) for a more detailed explanation of the isys parameter.
NOTES
The following notes are for UNICOS systems only. SCFFT2D(3S) and CSFFT2D(3S) on UNICOS/mk
systems provide the functionality of PCSFFT2D(3S) and PSCFFT2D on a single PE. For notes about
CSFFT2D(3S) on UNICOS/mk systems, see PSCFFT2D(3S).
Algorithm
SCFFT2D uses a routine similar to SCFFTM to do a real-to-complex FFT on the columns, then uses a
routine similar to CCFFTM to do a complex-to-complex FFT on the rows.
004– 2081– 002 299

CSFFT2D uses a routine similar to CCFFTM to do a complex-to-complex FFT on the rows, then uses a
routine similar to CSFFTM to do a complex-to-real FFT on the columns.
The table array stores factors of n1 and n2, and trigonometric tables that are used in calculation of the FFT.
table must be initialized by calling the routine with isign = 0. table does not have to be reinitialized if the
values of the problem sizes, n1 and n2, do not change.
Dimensions
applications. Thus, the input and output arrays are declared:
REAL X(0 :ld x-1, 0:n 2-1)
COMPLE X Y(0 :ld y-1, 0:n 2-1)
No change is made in the calling sequence, however, if you prefer to use the more customary Fortran style
with subscripts starting at 1. The same values of ldx and ldy would be passed to the subroutine even if the
input and output arrays were dimensioned as follows:
REAL X(l dx, n2)
COMPLE X Y(l dy, n2)
Performance Tips
This routine computes an FFT for any values of n1 and n2, but the performance depends on the prime
factorizations of n1 and n2. This fact is characteristic of all FFT algorithms.
Fastest performance is realized when both n1 and n2 are powers of 2; in which case, the number of floating-
point operations is approximately 5 . n1 . n2 . log 2 (n1 . n2)
If either n1 or n2 contains factors of 3, computation time is slightly longer, because more floating-point
operations are required. If they contain powers of 5, it is longer still.
The kernel routines are optimized for values of n1 and n2 that are products of powers of 2, 3, and 5.
In UNICOS implementation, to avoid memory bank conflicts, it is very important to make the leading
dimensions of the arrays odd numbers (or, if that is not possible, make them an odd multiple of 2).
The Cray Standard FFT routines were designed so that they could be implemented efficiently on many
different architectures. The calling sequence is the same in any implementation. Certain details, however,
depend on the particular implementation. These details are confined to three areas:
• The first area is the size of the table and work arrays. Different systems may need different sizes. You
do not have to change the subroutine call, but you might have to change the array sizes in the
300 004– 2081– 002

In the UNICOS implementation, no special options are supported; therefore, you can always specify an
isys argument as constant 0. Other options may be provided in subsequent software releases.
EXAMPLES
The following examples are for UNICOS systems only.
Example 1: Initialize the TABLE array in preparation for doing a two-dimensional FFT of size 128 by 256.
In this case, only the isign, n1, n2, and table arguments are used; you can use dummy arguments or zeros for
other arguments.
REA L TAB LE( 100 + 2*( 128 + 256 ))
CAL L SCF FT2 D (0, 128 , 256 , 0.0 , DUM MY, 1, DUMMY, 1,
Example 2: X is a real array of size (0:128, 0: 255), and Y is a complex array of dimension (0:64, 0:255).
The first 128 elements of each column of X contain data; for performance reasons, the extra element forces
the leading dimension to be an odd number. Take the two-dimensional FFT of X and store it in Y. Initialize
the TABLE array, as in example 1.
REA L X(0 :12 8, 0:2 55)
COM PLE X Y(0 :64 , 0:2 55)
REA L TAB LE( 100 + 2*( 128 + 256 ))
REA L WOR K(5 12* 256 )
...
CAL L SCF FT2 D(0 , 128 , 256 , 1.0 , X, 129 , Y, 65, TAB LE, WOR K, 0)
CAL L SCF FT2 D(1 , 128 , 256 , 1.0 , X, 129 , Y, 65, TAB LE, WORK, 0)
factor 1/(128*256) is used. Assume that the TABLE array is initialized already.
CAL L CSF FT2 D(- 1, 128 , 256, 1.0/(1 28.0*2 56.0), Y, 65,
& X, 130 , TAB LE, WOR K, 0)
rather than 0. No change is needed in the subroutine calls.
REA L X(1 29, 256 )
COM PLE X Y(6 5, 256 )
...
CAL L SCF FT2 D(0 , 128 , 256 , 1.0 , X, 129 , Y, 65, TAB LE, WOR K, 0)
004– 2081– 002 301

storage space. In this case, a row must be added to X, because it is equivalenced to a complex array.
Assume that TABLE is already initialized.
REA L X(1 30, 256 )
COM PLE X Y(6 5, 256 )
EQU IVA LEN CE ( X(1 , 1), Y(1 , 1) )
...
SEE ALSO
CCFFT(3S), CCFFT2D(3S), CCFFT3D(3S), CCFFTM(3S), SCFFT(3S), SCFFT3D(3S), SCFFTM(3S)
302 004– 2081– 002

NAME
SCFFT3D, CSFFT3D – Applies a multitasked three-dimensional real-to-complex Fast Fourier Transform
(FFT)
SYNOPSIS
CALL SCFFT3D (isign, n1, n2, n3, scale, x, ldx, ldx2, y, ldy, ldy2, table, work, isys)
CALL CSFFT3D (isign, n1, n2, n3, scale, x, ldx, ldx2, y, ldy, ldy2, table, work, isys)
IMPLEMENTATION
DESCRIPTION
SCFFT3D computes the three-dimensional Fast Fourier Transform (FFT) of the real matrix X, and it stores
the results in the complex matrix Y. CSFFT3D computes the corresponding inverse transform.
In FFT applications, it is customary to use zero-based subscripts; the formulas are simpler that way. First,
the function of SCFFT3D is described. Suppose the arrays are dimensioned as follows:
REAL X(0 :ld x-1 , 0:l dx2 -1, 0:n 3-1 )
COMPLE X Y(0 :ld y-1 , 0:l dy2 -1, 0:n 3-1 )
SCFFT3D computes the formula:

n1−1 n2−1 n3−1 .k .k .k
Σ Σ Σ
j . ω2 j . ω3 j
Yk , k , k = scale
1 2 3
X j , j , j . ω1
1 2 3
1 1 2 2 3 3
j =0 j =0 j =0
1 2 3
k 1 = 0, . . ., n1 ⁄ 2
for k 2 = 0, . . ., n2−1
k 3 = 0, . . ., n3−1
where:
isign . 2 . π . i
ω1 = e n1
i = +√−1
isign . 2 . π . i
ω2 = e n2
π = 3.14159. . .
isign . 2 . π . i
ω3 = e n3
isign = ±1
isign and scale.
004– 2081– 002 303

the mathematical inverse function is computed by taking the FFT with – isign and 1 / (n1 . n2 . n3 . scale).
In particular, if you use isign = +1 and scale = 1.0 for the forward FFT, you can compute the inverse FFT
by isign = – 1 and
1
scale =
n1 . n2 . n3
SCFFT3D is very similar in function to CCFFT3D(3S), but it takes the real-to-complex transform in the first
dimension, followed by the complex-to-complex transform in the second and third dimensions.
CSFFT3D does the reverse. It takes the complex-to-complex FFT in the third and second dimensions,
followed by the complex-to-real FFT in the first dimension.
See the SCFFTM(3S) man page for more information about real-to-complex and complex-to-real FFTs. The
three dimensional analog of the conjugate formula is as follows:
Yk , k , k = Y n1 – k , n2 – k , n3 – k
1 2 3 1 2 3
for n1 / 2 < k 1 ≤ n1 - 1
0 ≤ k 2 ≤ n2 - 1
0 ≤ k 3 ≤ n3 - 1
Thus, you have to compute only (slightly more than) half out the output values, namely:
Yk , k , k
1 2 3
for 0 ≤ k 1 ≤ n1 / 2
0 ≤ k 2 ≤ n2 - 1
0 ≤ k 3 ≤ n3 - 1
If the values of either n1, n2, or n3 are prime or not factorizable into powers of 2, 3 and 5 significant
vector of length 4.
The first element of isys indicates the dimension of the problem, that is, isys(1) = 3. The next three elements
of isys indicate if the lengths n1, n2 and n3 are factorizable into powers of 2, 3 and 5. isys(2) is set to 0 if
n1 is factorizable into powers of 2, 3 and 5 and is set to 1 otherwise. Similarly, isys(3) and isys(4) are set to
For example, if n1 = 256, n2 = 240, and n3 = 254, then the best computational time is obtained by setting
the following:
isys(2) = 0
isys(3) = 0
isys(4) = 1
304 004– 2081– 002

If the numbers n1, n2, and n3 are not known ahead of time, then isys(2), isys(3), and isys(4) could be
initialized to 0 and the routine would compute correct result, albeit slowly, if either n1, n2, or n3 were not
factorizable into powers of 2, 3, and 5.
UNICOS systems
The isys parameter is used to choose between two multitasking strategies and correspondingly different
amounts of workspace to be provided. A brief discussion about the significance of the isys parameter is
provided in the following argument list.
as follows:
n1 Integer. (input)
Transform size in the first dimension. If n1 is not positive, SCFFT3D returns without
n2 Integer. (input)
Transform size in the second dimension. If n2 is not positive, SCFFT3D returns without
n3 Integer. (input)
Transform size in the third dimension. If n3 is not positive, SCFFT3D returns without
scale Real. (input)
x SCFFT3D: Real array of dimension (0:ldx– 1, 0:ldx2– 1, 0:n3– 1). (input)
CSFFT3D: Complex array of dimension (0:ldx– 1, 0:ldx2– 1, 0:n3– 1). (input)
Array of values to be transformed.
The first dimension of x, as it was declared in the calling program (the leading dimension of x).
SCFFT3D: ldx ≥ MAX(n1, 1).
CSFFT3D: ldx ≥ MAX(n1/2 + 1, 1).
ldx2 Integer. (input)
The second dimension of x, as it was declared in the calling program. ldx2 ≥ MAX(n2, 1).
004– 2081– 002 305

y SCFFT3D: Complex array of dimension (0:ldy– 1, 0:ldy2– 1, 0:n3– 1). (output)

CSFFT3D: Real array of dimension (0:ldy– 1, 0:ldy2– 1, 0:n3– 1). (output)
Output array of transformed values. The output array can be the same as the input array, in
transformed values. In this case, it is necessary that the following equalities hold:
SCFFT3D: ldx = 2 . ldy, and ldx2 = ldy2.
CSFFT3D: ldy = 2 . ldx, and ldx2 = ldy2.
The first dimension of y, as it was declared in the calling program; that is, the leading dimension
of y.
SCFFT3D: ldy ≥ MAX(n1/2 + 1, 1).
CSFFT3D: ldy ≥ MAX(n1 + 2, 1).
In the complex-to-real routine, two extra elements are in the first dimension (that is, ldy ≥ n1 +
2, rather than just ldy ≥ n1). These elements are needed for intermediate storage during the
computation. On exit, their value is undefined.
ldy2 Integer. (input)
The second dimension of y, as it was declared in the calling program. ldy2 ≥ MAX(n2, 1).
table UNICOS systems: real array of dimension 100 + 2(n1 + n2 + n3). (input or output)
UNICOS/mk systems: Real array of dimension 2(n1 + n2 + n3) if isys(2), isys(3), and isys(4) are
all equal to zero. Private real vector of length 12(n1 + n2 + n3) if either isys(2), isys(3), or
isys(4) is equal to 1. (input or output)
This array must be initialized by a call to SCFFT3D or CSFFT3D with isign = 0.
If isign = 0, table is initialized to contain trigonometric tables needed to compute a three-
dimensional FFT of size n1 by n2 by n3. If isign = +1 or – 1, the values in table are assumed to
be initialized already by a prior call with isign = 0.
work UNICOS systems: real array of dimension 512 (MAX(n1, n2, n3)) when isys = 0 and of
dimension 4 . NCPUS . MAX(n1 . n2, n2 . n3, n3 . n1) when isys = 1. (scratch output)
When isys = 0, the parallel performance of this routine may be bad for small problem sizes.
Setting isys to 1 and providing the additional memory will significantly enhance parallel
performance. The NCPUS parameter is the environment variable that is set to indicate the
maximum number of CPUs that can be used in the application. The default value is 4.
UNICOS/mk systems: Real array of dimension (n1 + 2) . n2 . n3 (scratch output)
isys UNICOS systems: Integer array of dimension (1). (input)
306 004– 2081– 002

isys = 0 or 1 depending on the amount of workspace the user can provide to the routine.
UNICOS/mk systems: Integer array of dimension 4. (input)
isys(1) = 3
NOTES
The following notes are for UNICOS systems only. SCFFT3D and CSFFT3D on UNICOS/mk systems
provide the functionality of PSCFFT3D and PCSFFT3D on a single PE. For notes on SC and CSFFT3D on
UNICOS/mk systems, see PSCFFT3D(3S).
SCFFT3D is the generalization of SCFFT2D(3S) to three dimensions. All the notes for SCFFT2D(3S)
apply, with the obvious modifications for three dimensions.
Algorithm
SCFFT3D uses a routine similar to SCFFTM(3S) to do multiple FFTs first on all columns of the input
matrix, then uses a routine similar to CCFFTM(3S) on all rows of the result, and then on all planes of that
result. See SCFFTM(3S) and CCFFTM(3S) for more information about the algorithms used.
EXAMPLES
The following examples are for UNICOS systems only. In all the examples shown below isys is set to 0.
For better performance on small size 3D FFTs, setting isys = 1 and providing adequate workspace would
yield better performance.
Example 1: Initialize the TABLE array in preparation for doing a three-dimensional FFT of size 128 by 128
by 128. In this case only the isign, n1, n2, n3, and table arguments are used; you can use dummy arguments
or zeros for other arguments.
REA L TAB LE(100 + 2*(128 + 128 + 128 ))
CAL L SCF FT3 D (0, 128 , 128 , 128 , 0.0 , DUM MY, 1, 1, DUMMY, 1, 1,
Example 2: X is a real array of size (0:128, 0:128, 0:128). The first 128 elements of each dimension
contain data; for performance reasons, the extra element forces the leading dimensions to be odd numbers. Y
is a complex array of dimension (0:64, 0:128, 0:128). Take the three-dimensional FFT of X and store it in
Y. Initialize the TABLE array, as in example 1.
004– 2081– 002 307

REA L X(0:128, 0:1 28, 0:1 28)

COM PLE X Y(0:64, 0:1 28, 0:1 28)
REA L TABLE( 100 + 2*(128 + 128 + 128 ))
REA L WORK(5 12* 128)
...
CAL L SCFFT3 D(0 , 128 , 128 , 128 , 1.0 , X, 129 , 129 ,
& Y, 65, 129 , TAB LE, WORK, 0)
CAL L SCF FT3D(1, 128, 128 , 128 , 1.0 , X, 129 , 129 ,
& Y, 65, 129, TABLE, WOR K, 0)
factor 1/(128**3) is used. Assume that the TABLE array is initialized already.
CAL L CSF FT3D(-1, 128 , 128 , 128 , 1.0 /12 8.0**3 , Y, 65, 129,
& X, 130 , 129 , TAB LE, WOR K, 0)
rather than 0. No change is made in the subroutine calls.
REA L X(129, 129, 129)
COM PLE X Y(65, 129 , 129 )
REA L TABLE( 100 + 2*(128 + 128 + 128))
REA L WORK(5 12* 128)
...
CAL L SCFFT3 D(0 , 128 , 128 , 128 , 1.0 , X, 129, 129,
& Y, 65, 129 , TAB LE, WOR K, 0)
CAL L SCF FT3D(1, 128, 128, 128 , 1.0 , X, 129 , 129 ,
& X, 129 , 129 , TAB LE, WOR K, 0)
REA L X(130, 129 , 129 )
COM PLE X Y(65, 129 , 129 )
EQU IVA LENCE (X( 1, 1, 1), Y(1 , 1, 1))
...
CAL L SCFFT3 D(1 , 128 , 128 , 128 , 1.0 , X, 130 , 129 ,
& Y, 65, 129 , TAB LE, WORK, 0)
SEE ALSO
CCFFT(3S), CCFFT2D(3S), CCFFT3D(3S), CCFFTM(3S), SCFFT(3S), SCFFT2D(3S), SCFFTM(3S)
308 004– 2081– 002

SCFFTM ( 3S ) SCFFTM ( 3S )
NAME
SCFFTM, CSFFTM – Applies multiple real-to-complex or complex-to-real Fast Fourier Transforms (FFTs)
SYNOPSIS
CALL SCFFTM (isign, n, lot, scale, x, ldx, y, ldy, table, work, isys)
CALL CSFFTM (isign, n, lot, scale, x, ldx, y, ldy, table, work, isys)
IMPLEMENTATION
On UNICOS/mk systems, this subroutine executes on a single processor and uses only private data
DESCRIPTION
SCFFTM computes the FFT of each column of the real matrix X, and it stores the results in the
corresponding column of the complex matrix Y. CSFFTM computes the corresponding inverse transforms.
In FFT applications, it is customary to use zero-based subscripts; the formulas are simpler that way. First,
the function of SCFFTM is described. Suppose that the arrays are dimensioned as follows:
REAL X(0 :ld x-1 , 0:lot- 1)
COMPLE X Y(0 :ld y-1 , 0:l ot- 1)
where ldx ≥ n, ldy ≥ n / 2 + 1.

Then column L of the output array is the FFT of column L of the input array, using the following formula
for the FFT:
n −1
n
Σ
. j .k
Yk ,L = scale X j . ωisign for k = 0, . . ., L = 0, . . ., lot −1
j =0 2
where 2 . π . i
ω=e n
i = +√−1
π = 3.14159. . . isign = ±1
lot = the number of rows to transform
Different authors use different conventions for which transform (isign = +1 or isign = – 1) is used in the
real-to-complex case, and what the scale factor should be. Some adopt the convention that isign = 1 for the
real-to-complex transform, and isign = – 1 for the complex-to-real inverse. Others use the opposite
convention. You can make these routines compute any of the various possible definitions, however, by
choosing the appropriate values for isign and scale.
The relevant fact from FFT theory is this: If you use SCFFTM to take the real-to-complex FFT, using any
particular values of isign and scale, the mathematical inverse function is computed by using CSFFTM with
– isign and 1 / (n . scale). In particular, if you call SCFFTM with isign = +1 and scale = 1.0, you can use
CSFFTM to compute the inverse complex-to-real FFT by using isign = – 1 and scale = 1.0 /n.
004– 2081– 002 309


Specifies whether to initialize the table array or do the forward or inverse Fourier transform, as
follows:
If isign = 0, the routine initializes table and returns. In this case, the only arguments used or
checked are isign, n, and table.
n Integer. (input)
Size of the transforms (the number of elements in each column of the input and output matrix to
be transformed). If n is not positive, SCFFTM or CSFFTM returns without computing a
transforms.
The number of transforms to be computed (or "lot size"). This is the number of elements in
each row of the input and output matrix. If lot is not positive, CSFFTM or SCFFTM returns
without computing a transforms.
scale Real. (input)
Scale factor. Each element of the output array is multiplied by scale after taking the transform,
as defined in the preceding formula.
x SCFFTM: Real array of dimension (0:ldx– 1, 0:lot– 1). (input)
CSFFTM: Complex array of dimension (0:ldx– 1, 0:lot– 1). (input)
The number of rows in the x array, as it was declared in the calling program (the leading
dimension of x).
SCFFTM: ldx ≥ MAX(n, 1).
CSFFTM: ldx ≥ MAX(n/2 + 1, 1).
y SCFFTM: Complex array of dimension (0:ldy– 1, 0:lot– 1). (output)
CSFFTM: Real array of dimension (0:ldy– 1, 0:lot– 1). (output)
Each column of the output array, y, is the FFT of the corresponding column of the input array, x,
computed according to the preceding formula. The output array may be equivalenced to the
input array. In that case, the transform is done in place and the input array is overwritten with
the transformed values. In this case, the following conditions on the leading dimensions must
hold:
SCFFTM: ldx = 2ldy.
CSFFTM: ldy = 2ldx.
310 004– 2081– 002


Number of rows in the y array, as declared in the calling program (the leading dimension of y).
SCFFTM: ldy ≥ MAX(n / 2 + 1, 1).
CSFFTM: ldy ≥ MAX(n, 1).
table UNICOS systems: Real array of dimension 100 + 2n. (input or output)
UNICOS/mk systems: Real array of length 2n.
This array must be initialized by a call to SCFFTM (or CSFFTM) with isign = 0.
If isign = 0, table is initialized to contain trigonometric tables needed to compute an FFT of
length n.
isign = 0.
work UNICOS systems: Real array of dimension (2n + 4)lot. (scratch output)
UNICOS/mk systems: Real array of length 2n.
That is, the first element of the array specifies how many more elements are in the array. Use
isys to specify certain processor-specific parameters or options.
argument value as the scalar integer constant 0. If isys(0) > 0, isys(0) gives the upper bound of
the isys array; that is, if il = isys(0), user-specified parameters are expected in isys(1) through
isys(il).
Notice in the preceding formula that there are n real input values and (n/2) + 1 complex output values for
each column. This property is characteristic of real-to-complex FFTs.
to another sequence of n complex values. A complex-to-complex FFT routine, such as CCFFTM, will take n
complex input values and produce n complex output values. In fact, one easy way to compute a real-to-
complex FFT is to store the input data x in a complex array, then call routine CCFFTM to compute the FFT.
You get the same answer when using the SCFFTM routine.
A separate real-to-complex FFT routine is more efficient than the equivalent complex-to-complex routine.
Because the input data is real, you can make use of this fact to save almost half of the computational work.
According to the theory of Fourier transforms, for real input data, you have to compute only the first n/2 + 1
complex output values in each column, because the second half of the FFT values in each column can be
computed from the first half of the values by the simple formula:
n
Y k,L = Y n– k, L for ≤ k ≤ n– 1
2
004– 2081– 002 311

stored. Likewise, you must supply only the first half of the complex data in each column has to be supplied
for the complex-to-real FFT.
Another implication of FFT theory is that for real input data, the first output value in each column, Y(0, L),
will always be a real number; therefore, the imaginary part will always be 0. If n is an even number, Y(n / 2,
L) will also be real and have 0 imaginary parts.
In general, the FFT transforms a complex sequence into a complex sequence; however, in a certain
application you may know the output sequence is real, perhaps because the complex input sequence was the
transform of a real sequence. In this case, you can save about half of the computational work.
n
X k,L = X n– k,L for ≤ k ≤ n– 1
2
n
And, in fact, the input values X k,L for k > do not have to be supplied, because they can be inferred from
2
the first half of the input.
Thus, in the complex-to-real routine, CSFFTM, the arrays can be dimensioned as follows:
COM PLE X X(0 :ld x-1 , 0:l ot- 1)
REA L Y(0 :ld y-1 , 0:l ot- 1)
where ldx ≥ n/2 + 1, ldy ≥ n.

In each column, there are (n / 2) + 1 complex input values and n real output values. Even though only
(n/2) + 1 input values are supplied, the size of the transform is still n in this case, because implicitly the FFT
formula for a sequence of length n is used.
Another implication of the theory is that X(0, L) must be a real number (that is, must have zero imaginary
part). If n is an even number, X(n / 2, L) must also be real. Routine CSFFTM assumes that each of these
values is real; if a nonzero imaginary part is given, it is ignored.
NOTES
The table array contains the trigonometric tables used in calculation of the FFT. You must initialize this
table by calling the routine with isign = 0 prior to doing the transforms. table does not have to be
reinitialized if the value of the problem size, n, does not change.
312 004– 2081– 002

Dimensions
applications. Thus, the input and output arrays are declared (for SCFFTM):
REAL X(0:ld x-1 , 0:l ot- 1)
COM PLE X Y(0 :ldy-1 , 0:l ot-1)
No change is made in the calling sequence, however, if you prefer to use the more customary Fortran style
with subscripts starting at 1. The same values of ldx and ldy would be passed to the subroutine even if the
input and output arrays were dimensioned as follows:
REAL X(l dx, lot )
COMPLE X Y(l dy, lot )
Performance Tips
operations is approximately:
5 .
lot . n . log 2 (n)
2
required. It is longer still if n contains powers of 5. Slowest performance is when n is a prime number, in
2
which case, the number of floating-point operations is approximately 4 . lot . n .
The kernel routines are optimized for values of n that are products of powers of 2, 3, and 5. (Because the
kernel routines have a special case for multiples of 4, even powers of 2 will be slightly faster than odd
powers of 2.)
In the UNICOS implementation, to avoid memory bank conflicts, it is very important to make the leading
dimensions of the arrays odd numbers (or, if that is not possible, make them an odd multiple of 2). To
attain best vectorization performance, the lot size should be at least 64, and preferably it should be a multiple
of 64.
Neither SCFFTM nor CSFFTM is optimized on UNICOS/mk systems.
The Standard FFT routines were designed so that they could be implemented efficiently on many different
architectures. The calling sequence is the same in any implementation. Certain details, however, depend on
the particular implementation. These details are confined to three areas:
• The first area is the size of the table and work arrays. Different systems may need different sizes. No
change is required to the subroutine call, but you might have to change the array sizes in the
004– 2081– 002 313

No special options are supported; therefore, you can always specify an isys argument as constant 0. Other
options may be provided in subsequent software releases.
EXAMPLES
only the isign, n, and table arguments are used; you may use dummy arguments or zeros for the other
REAL TABLE( 100 + 2*1 28)
CALL SCFFTM (0, 128 , 1, 0.0 , DUM MY, 1, DUMMY, 1,
& TAB LE, DUMMY, 0)
Example 2: X is a real array of dimension (0:128, 0:55), and Y is a complex array of dimension (0:64,
0:55). The first 128 elements in each column of X contain data; the extra element forces an odd leading
dimension. Take the FFT of the first 50 columns of X and store the results in the first 50 columns of Y.
Before taking the FFT, initialize the TABLE array, as in example 1.
REA L X(0:128, 0:5 5)
COM PLEX Y(0:64, 0:5 5)
REA L TAB LE(100 + 2*1 28)
REA L WORK((2*1 28 + 4)* 50)
...
CALL SCFFTM (0, 128 , 50, 1.0 , X, 129, Y, 65, TAB LE, WORK, 0)
CALL SCFFTM (1, 128 , 50, 1.0 , X, 129, Y, 65, TAB LE, WORK, 0)
CALL CSFFTM (-1 , 128 , 50, 1.0 /128.0 , Y, 65, X, 129 ,
& TABLE, WOR K, 0)
rather than 0. No change is made in the subroutine calls.
314 004– 2081– 002

REA L X(129, 56)

COM PLE X Y(65, 56)
...
CAL L SCF FTM(0, 128, 50, 1.0 , X, 129 , Y, 65, TABLE, WOR K, 0)
CAL L SCF FTM(1, 128, 50, 1.0 , X, 129 , Y, 65, TAB LE, WOR K, 0)
storage space. In this case, a row must be added to X, because it is equivalenced to a complex array. The
leading dimension of X is two times an odd number; therefore, memory bank conflicts are minimal. Assume
that TABLE is initialized already.
REAL X(1 30, 56)
COM PLEX Y(6 5, 56)
EQU IVALEN CE ( X(1, 1), Y(1 , 1) )
...
CAL L SCF FTM(1, 128, 50, 1.0 , X, 130 , Y, 65, TABLE, WOR K, 0)
SEE ALSO
CCFFT(3S), CCFFTM(3S), SCFFT(3S)
004– 2081– 002 315

SCNVL1D ( 3S ) SCNVL1D ( 3S )
NAME
SCNVL1D – Computes a real one-dimensional (1D) convolution of two vectors
SYNOPSIS
CALL SCNVL1D (domain, isign, shape, symm, a, m, b, n, c, inc, table, work)
IMPLEMENTATION
UNICOS/mk systems
This routine executes on a single PE and uses only private data.
DESCRIPTION
SCNVL1D computes the convolution of a real filter vector a with a real data vector b, producing the output
vector c.
Let
a = a(1), a(2), . . . , a(m)
b = b(1), b(2), . . . , b(n)
be the filter and data vectors. This routine requires that m ≤ n. If m is greater than n, then a and b must be
interchanged in the calling sequence.
The convolution operation can be defined either with or without a zero-padded data vector. If we assume a
zero-padded data vector, then the convolution output sequence would be the following:
c(i) = Sum a(j) * b(i– j+1) for i = 1, m– 1

1≤j≤i
c(i) = Sum a(j) * b(i– j+1) for i = m, n
1≤j≤m
c(i) = Sum a(j) * b(i– j+1) for i = n+1, n+m– 1
i+1– n≤j≤m
If we assume a non zero padded data vector then the convolution sequence would be:
c(i– m+1) = Sum a(j) * b(i– j+1) for i = m, n

1≤j≤m
The routine allows the user to choose between the two forms of the output product: with zero-padded data
or without zero-padded data. For computation of the convolution product with a zero-padded data vector,
the character variable shape is set to ’F’ or ’f’ to indicate the full length output vector (n+m– 1). For
computation of the convolution product without a zero-padded data vector, the character variable shape, is
set to ’V’ or ’v’ to indicate an output vector computed with valid data.
316 004– 2081– 002

The routine allows the user to choose between computing the convolution product in either the time or
frequency domain. This can be done by setting the character variable domain to either ’F’ or ’f’ to indicate
frequency domain or ’T’ or ’t’ to indicate time domain computation.
If the user chooses to compute the convolution product in the frequency domain, then the variable isign is
used to decide if the trig tables are being initialized or the convolution product is being computed. The
SCNVL1D routine would have to be called twice (like the FFT routines), once to initialize the trig tables and
the second time to actually compute the convolution product.
If the user chooses to compute the convolution in the time domain, then the variable isign is ignored and the
convolution product is computed in the first and only pass. In addition, the two other vectors, table and
work, are also ignored.
SCNVL1D also provides a feature of immense importance in several signal processing applications. It allows
the user to set a decimation rate for the output vector. This is done using the argument inc. If inc is set to
1, then all the output elements are computed, i.e., (n+m– 1) for zero-padded convolution and (n– m+1)
elements for non zero-padded convolution. Setting inc to a positive integer greater than 1 makes the routine
compute every (inc)ˆth element of the convolution output. For example, setting inc = 2 means that the
routine computes every other output element.
For example, if m = 10, n = 200 and shape = ’V’, then setting inc = 1 would result in 200– 10+1 = 191
elements of the output vector being computed and stored in c(1), . . . , c(191). If inc is set to 2, then
trunc((n– m+inc)/inc) = 96 elements of the output vector being computed and stored in c(1), . . . , c(96).
Here, trunc is used to indicate the truncation operation.
Another feature of SCNVL1D that is of importance in certain signal processing applications such as FIR
filters is that the filter vector may be symmetric or unsymmetric. If the filter vector is symmetric, the routine
saves some computation by adding the elements of b that contribute equally to the convolution sum. The
filter vector a can be either even or odd symmetric depending on whether m is even or odd. The character
argument symm can be set to ’S’ or ’s’ to indicate symmetry and ’N’ or ’n’ to indicate that a is
non-symmetric.
domain Character*1. (input)
Specifies whether the computation should proceed in the frequency domain or the time domain.
domain = ’F’ or ’f’ for frequency domain computation
domain = ’T’ or ’t’ for time domain computation
Specifies if the routine should initialize the trig tables or proceed with the computation of the
convolution product in the frequency domain. If the computation is to be performed in the time
domain then isign is ignored.
isign = 0 to set the trig tables
isign = 1 to compute the convolution product
shape Character*1. (input)
Specifies if the computation should proceed with or without a zero padded data vector.
004– 2081– 002 317

shape = ’F’ or ’f’ for a zero padded convolution product

shape = ’V’ or ’v’ for a convolution with valid data (no zero padding)
symm Character*1. (input)
Specifies if the filter vector is symmetric or nonsymmetric.
symm = ’S’ or ’s’ for filter vectors that are symmetric
symm = ’N’ or ’n’ for non-symmetric filter vectors
If the filter vector is symmetric the entire length of the vector would have to be stored.
a Real 1D array. (input)
An input array containing the filter vector.
m Integer. (input)
Size of the filter vector.
b Real 1D array. (input)
An input array containing the data vector.
n Integer. (input)
Size of the data vector. n ≥ m.
c Real 1D array. (output)
An output array containing the convolution product of a and b.
inc Integer. (input)
The decimation factor in the computation of elements of the convolution product of a and b. inc
should be a positive integer.
table Real array of size 4(m+n). (input or output)
Table of factors and trigonometric functions. This is used only when the convolution is to be
computed in the frequency domain. If the convolution is computed in the time domain, this
argument is ignored.
work Real array of size 8(m+n). (workspace)
Workspace used when the convolution is computed in the frequency domain. Ignored when
computation is carried out in the time domain.
NOTES
The flexibility of choosing between frequency domain and time domain computation of the convolution has
been provided so that the user may experiment between the two and choose the one that is faster for the
particular problem size at hand.
Usually when n is big and m is small, time domain computation is less expensive. If both m and n are large,
then the frequency domain computation is less expensive. For all problem sizes in between, the user is
encouraged to choose between the two modes depending on the numerical complexity of the two algorithms,
the amount of workspace available, and experimentation.
318 004– 2081– 002

EXAMPLES
If m = 5, n = 10, a = [1 2 3 4 5], and b = [1 2 3 4 5 6 7 8 9 10], then shape = ’F’ and inc = 1 would yield
c = [1 4 10 20 35 50 65 80 95 110 114 106 85 50].
If shape = ’F’ and inc = 3, then c = [1 20 65 110 85].
If shape = ’V’ and inc = 1, then c = [35 50 65 80 95 110].
If shape = ’V’ and inc = 2, then c = [35 65 95].
SEE ALSO
SCNVL2D(3S)
004– 2081– 002 319

NAME
SCNVL2D – Computes a real two-dimensional (2D) convolution of two matrices
SYNOPSIS
CALL SCNVL2D (domain, isign, shape, symm, A, lda, m1, m2, B, ldb, n1, n2, C, ldc,
inc1, inc2, table, work)
IMPLEMENTATION
UNICOS/mk systems
This routine executes on a single PE and uses only private data.
DESCRIPTION
SCNVL2D computes the convolution of a real filter matrix A with a real data matrix B, producing the output
matrix C.
Let the following be the filter and data matrices:
A = a(j,i) 1≤j≤m1, 1≤i≤m2
B = b(j,i) 1≤j≤n1, 1≤i≤n2
This routine requires that m1 ≤ n1 and m2 ≤ n2. If m1 > n1 and m2 > n2, then A and B must be
interchanged in the calling sequence. The following cases cannot be handled by this routine: m1 > n1 and
m2 ≤ n2, m1 ≤ n1 and m2 > n2.
The convolution operation can be defined either with or without a zero-padded data matrix. If we assume a
zero-padded data matrix, then the convolution output sequence would be the following:
c(j,i) = Sum Sum a(k,l) * b(j– k+1,i– l+1)

r1≤l≤r2 1≤k≤j
for j = 1, m1– 1
where:
r1 = 1, and r2 = i for i = 1, m2– 1
r1 = 1, and r2 = m2 for i = m2, n2
r1 = i– n2+1 and r2 = m2 for i = n2+1, n2+m2– 1
320 004– 2081– 002


r1≤l≤r2 1≤k≤m1
for j = m1, n1
where:
r1 = 1, and r2 = i for i = 1, m2– 1
r1 = 1, and r2 = m2 for i = m2, n2
r1≤l≤r2 1≤k≤m1
for j = n1+1, n1+m1– 1
where:
r1 = 1, and r2 = i for i = 1, m2– 1
r1 = 1, and r2 = m2 for i = m2, n2
If we assume a non zero-padded data matrix then the convolution sequence would be
c(j– m1+1,i– m2+1) = Sum Sum a(k,l) * b(j– k+1,i– l+1)
1≤l≤m2 1≤k≤m1
for j = m1, n1
i = m2, n2
The routine allows the user to choose between the two forms of the convolution product shown previously
with zero-padded data or without zero-padded data.
For computation of the convolution product with a zero padded data matrix, the character argument shape is
set to ’F’ or ’f’ to indicate the full shape output matrix (n1+m1– 1) * (n2+m2– 1). For computation of the
convolution product without a zero-padded data matrix, the character variable shape is set to ’V’ or ’v’ to
indicate an output matrix computed with valid data. The size of the output matrix would be (n1– m1+1) x
(n2– m2+1).
The user cannot specify a zero-padded convolution in one dimension and a non zero-padded convolution in
the other.
The routine also allows the user to choose between computing the convolution product in either the time or
frequency domain. This can be done by setting the character variable domain to either ’F’ or ’f’ to indicate
frequency domain or ’T’ or ’t’ to indicate time domain computation.
If the user chooses to compute the convolution product in the frequency domain, then the variable isign is
used to decide if the trig tables are being initialized or the convolution product is being computed. The
SCNVL2D routine would have to be called twice (like the FFT routines), once to initialize the trig tables and
the second time to actually compute the convolution product.
004– 2081– 002 321

If the user chooses to compute the convolution in the time domain, then the variable isign is ignored and the
convolution product is computed in the first and only pass. In addition, the two other vectors, table and
work, are also ignored.
SCNVL2D also provides a feature of immense importance in several signal processing applications. It allows
the user to set a decimation rate in both dimensions for the output matrix. This is done using the arguments
inc1 and inc2. If inc1 is set to 1, then all the output elements along the first dimension are computed, i.e.,
(n1+m1– 1) for zero-padded convolution and (n1– m1+1) elements for non zero-padded convolution. The
same is the case for inc2 = 1 along the second dimension. Setting inc1 and inc2 to a positive integer greater
than 1 makes the routine compute every (inc1)th and (inc2)th element of the convolution output in the two
dimensions. For example setting inc1 = 1 and inc2 = 2 means that the routine computes every other column
in the convolution product.
For example if m1 = 10, m2 = 12, n1 = 200, n2 = 255, and shape = ’V’, then setting inc1 = 1 and inc2 = 2
would result in (200– 10+1) *trunc((255– 12+2)/2) = 191*122 elements of the output matrix being computed
and stored in c(1,1), . . . , c(191,122). Here trunc() is used to indicate the truncation operation.
Another feature of SCNVL2D that is of importance in certain signal processing applications such as FIR
filters is that the filter matrix may be symmetric or unsymmetric. If the filter matrix is symmetric, the
routine saves some computation by adding the elements of B that contribute equally to the convolution sum.
The filter matrix A can be either even or odd symmetric depending on whether m1 and m2 are even or odd.
The character argument symm can be set to ’S’ or ’s’ to indicate symmetry and ’N’ or ’n’ to indicate that A
is non-symmetric.
One restriction in exploiting the symmetry feature is that both m1 and m2 must be either odd or even. The
user cannot have m1 even and m2 odd if symmetry is to be exploited. If symm = ’S’ is specified when m1 =
10 and m2 = 11, for example, them the routine ignores the symm flag and computes the convolution product
assuming no symmetry.
domain Character*1. (input)
Specifies if the computation should proceed in the frequency domain or the time domain.
domain = ’F’ or ’f’ for frequency domain computation
domain = ’T’ or ’t’ for time domain computation
Specifies if the routine should initialize the trig tables or proceed with the computation of the
convolution product in the frequency domain. If the computation is to be performed in the time
domain, isign is ignored. isign = 0 to set the trig tables
isign = 1 to compute the convolution product
shape Character*1. (input)
Specifies if the computation should proceed with or without a zero-padded data vector.
shape = ’F’ or ’f’ for a zero-padded convolution product
shape = ’V’ or ’v’ for a convolution with valid data (no zero padding)
322 004– 2081– 002

symm Character*1. (input)

Specifies if the filter vector is symmetric or nonsymmetric.
symm = ’S’ or ’s’ for filter vectors that are symmetric
symm = ’N’ or ’n’ for non-symmetric filter vectors
If the filter vector is symmetric, the entire length of the vector would have to be stored.
A Real 2D array. (input)
An input array containing the filter matrix.
Leading dimension of the filter matrix.
m1 Integer. (input)
Number of rows in the filter matrix.
m2 Integer. (input)
Number of columns in the filter matrix.
B Real 2D array. (input)
Input array containing the data matrix.
Leading dimension of the data matrix.
n1 Integer. (input)
Number of rows in the data matrix.
n2 Integer. (input)
Number of columns in the data matrix.
C Real 2D array. (output)
An output array containing the convolution product of A and B.
Leading dimension of the output matrix.
inc1 Integer. (input)
Specifies the decimation factor along the rows in the computation of elements of the convolution
product of A and B.
inc1 should be a positive integer.
inc2 Integer. (input)
Specifies the decimation factor along the columns in the computation of elements of the
convolution product of A and B.
inc2 should be a positive integer.
table Real array of size 4(m1+m2+n1+m2). (input or output)
This is used only when the convolution is to be computed in the frequency domain. If the
convolution is computed in the time domain, this argument is ignored.
004– 2081– 002 323

work Real array of size 3(m1+n1)(m2+n2). (workspace)

Workspace used when the convolution is computed in the frequency domain. Ignored when
computation is carried out in the time domain.
NOTES
The flexibility of choosing between frequency domain and time domain computation of the convolution has
been provided so that the user may experiment between the two and choose the one that is faster for the
particular problem size at hand.
Usually when n1 and n2 are big and m1 and m2 are small, time domain computation is less expensive. If
m1, m2, n1, and n2 and n are large, the frequency domain computation is less expensive. For all problem
sizes in between, the user is encouraged to choose between the two modes depending on the numerical
complexity of the two algorithms, the amount of workspace available, and experimentation.
EXAMPLES
If
A = 1 2 3
2 3 1
3 1 2
and
B = 1 2 3 4 5
5 1 2 3 4
4 5 1 2 3
3 4 5 1 2
2 3 4 5 1
shape = ’F’ and inc = 1 would yield

C =
1 4 10 16 22 22 15
7 18 32 29 41 36 17
17 37 48 51 54 40 23
26 40 60 48 51 28 17
20 43 57 60 48 31 11
13 27 44 41 38 12 5
6 11 19 25 16 11 2
If shape = ’F’ and inc1 = 2, inc2 = 1, then
324 004– 2081– 002

C =
1 4 10 16 22 22 15
17 37 48 51 54 40 23
20 43 57 60 48 31 11
6 11 19 25 16 11 2
If shape = ’V’ and inc1 = 2, inc2 = 1, then

C =
48 51 54
57 60 48
SEE ALSO
SCNVL1D(3S)
004– 2081– 002 325

SCONV ( 3S ) SCONV ( 3S )
NAME
SCONV – Performs the convolution of two sequences of real numbers
SYNOPSIS
CALL SCONV (nh, nx, ny, h, x, y)
IMPLEMENTATION
UNICOS/mk systems
DESCRIPTION
SCONV computes the convolution of the filter sequence h with the data sequence x, producing the output
sequence y.
h = h(0), h(1), . . ., h(nh – 1)
x = x(0), x(1), . . ., x(nx – 1)
The "convolution product", y, is the sequence having elements defined by:
y(0) = h(nh– 1) . x(0) + h(nh– 2) . x(1) + . . . + h(0) . x(nh – 1)
y(1) = h(nh– 1) . x(1) + h(nh– 2) . x(2) + . . . + h(0) . x(nh)
y(2) = h(nh– 1) . x(2) + h(nh– 2) . x(3) + . . . + h(0) . x(nh + 1)
This example definition assumes nx > nh.
The precise definition of the convolution is:
0≤j ≤MIN
The number of terms in the output sequence is specified by an argument, ny. If ny < nx, the output sequence
By choosing ny > nx – nh + 1, the routine does what is sometimes called "post-tapered" convolution. The
nh Integer. (input)
nx Integer. (input)
ny Integer. (input)
326 004– 2081– 002

SCONV ( 3S ) SCONV ( 3S )
h Real array of dimension (0, nh−1). (input)

x Real array of dimension (0, nx−1). (input)
y Real array of dimension (0, ny−1). (output)
NOTES
and return.
EXAMPLES
rea l h(0 :2) , x(0 :3), y(0:7)

data (h(i), i = 0, 2) / 1.0 , 2.0 , 3.0 /
dat a (x( i), i = 0, 3) / 4.0, 5.0, 6.0, 7.0 /
call sconv( 3, 4, 8, h, x, y)
print *, y

28. , 34. , 32. , 21. , 0., 0., 0., 0.
SEE ALSO
SCORR(3S), SCORRS(3S)
004– 2081– 002 327

SCORR ( 3S ) SCORR ( 3S )
NAME
SCORR – Performs the correlation of two sequences of real numbers
SYNOPSIS
CALL SCORR (nh, nx, ny, h, x, y)
IMPLEMENTATION
UNICOS/mk systems
DESCRIPTION
SCORR computes the correlation of the filter sequence h with the data sequence x, producing the output
sequence y.
h = h(0), h(1), . . ., h(nh – 1)
x = x(0), x(1), . . ., x(nx – 1)
y(0) = h(0) . x(0) + h(1) . x(1) + . . . + h(nh – 1) . x(nh – 1)
y(1) = h(0) . x(1) + h(1) . x(2) + . . . + h(nh – 1) . x(nh)
y(2) = h(0) . x(2) + h(1) . x(3) + . . . + h(nh – 1) . x(nh + 1)
The precise definition is as follows:
0≤j ≤min
The number of terms in the output sequence is specified by the argument ny. If ny < nx, the output sequence
By choosing ny > nx – nh + 1, the routine does what is sometimes called "post-tapered" correlation. The
stored and no multiplications by zero are actually done. This routine has the following arguments:
nh Integer. (input)
nx Integer. (input)
Specifies the number of elements in the sequence of data sequence, x. nx ≥ 0.
ny Integer. (input)
h Real array of dimension (0, nh−1). (input)
328 004– 2081– 002

SCORR ( 3S ) SCORR ( 3S )

NOTES
If ny = 0, the routine returns. If either nh = 0 or nx = 0, the routine will zero the first ny elements in y and
return.
EXAMPLES
real h(0:2), x(0:3) , y(0 :7)

data (h(i), i = 0, 2) / 1.0 , 2.0 , 3.0 /
dat a (x( i), i = 0, 3) / 4.0, 5.0, 6.0, 7.0 /
call scorr( 3, 4, 8, h, x, y)
print *, y

32. , 38. , 20. , 7., 0., 0., 0., 0.
SEE ALSO
SCONV(3S), SCORRS(3S)
004– 2081– 002 329

SCORRS ( 3S ) SCORRS ( 3S )
NAME
SCORRS – Performs the correlation of two sequences of real numbers (symmetric filter)
SYNOPSIS
CALL SCORRS (nh, nx, ny, h, x, y)
IMPLEMENTATION
UNICOS/mk systems
DESCRIPTION
SCORRS computes the correlation of the symmetric filter sequence h with the data sequence x, producing the
output sequence y. The filter, h, is assumed to be symmetric about its middle.
The computation carried out by SCORRS is exactly the same as that done by routine SCORR, with one
exception: the filter, h, is assumed to be symmetric, so only the first half of the elements are accessed. The
values of the second half are inferred from the first half and do not actually have to be supplied by the
calling routine.
To review the definition of correlation (not necessarily assuming a symmetric filter), suppose h and x are two
sequences of real numbers, having nh and nx elements, respectively. As is customary in signal processing
applications, let the subscripts start at 0, so
h = h(0), h(1), . . ., h(nh – 1)
x = x(0), x(1), . . ., x(nx – 1)
y(0) = h(0) . x(0) + h(1) . x(1) + . . . + h(nh– 1) . x(nh– 1)
y(1) = h(0) . x(1) + h(1) . x(2) + . . . + h(nh– 1) . x(nh)
y(2) = h(0) . x(2) + h(1) . x(3) + . . . + h(nh– 1) . x(nh+1)
The precise definition of correlation is as follows:
0≤j ≤MIN
The SCORRS routine makes the assumption that the filter is symmetric; in other words, that h(nh − j) = h(j),
for 0 ≤ j ≤ nh / 2.
Only the elements h(0) through h (nh/2) are accessed by the routine. The last half of the filter values are not
accessed and do not actually have to be supplied by the calling routine.
330 004– 2081– 002

SCORRS ( 3S ) SCORRS ( 3S )
By choosing ny > nx − nh+1, the routine does what is sometimes called "post-tapered" correlation. The
nh Integer. (input)
nx Integer. (input)
ny Integer. (input)
h Real array of dimension (0, nh/2). (input)
Specifies the input sequence of filter values. Only values h(0) through h (nh/2) are accessed; the
second half of the filter values are inferred from the symmetry of h.
Specifies the output sequence.
NOTES
If ny = 0, the routine returns. If either nh = 0 or nx = 0, the routine zeroes the first ny elements in y and
returns.
EXAMPLES
rea l h(0:2) , x(0 :3) , y(0 :7)

data (h(i), i = 0, 2) / 1.0 , 2.0 , 3.0 /
data (x(i), i = 0, 3) / 4.0 , 5.0 , 6.0 , 7.0 /
cal l sco rrs(5, 4, 8, h, x, y)
pri nt *, y

46. , 38., 20., 7., 0., 0., 0., 0.
SEE ALSO
SCONV(3S), SCORR(3S)
004– 2081– 002 331

INDEX
3D array (FFT) ................................................................................................ descinit3d(3S) ................................................ 219

Absolute value ................................................................................................. sasum(3S) .............................................................. 42
Absolute values of vector elements addition (BLAS1) .................................. sasum(3S) .............................................................. 42
Adds a scalar multiple of a real or complex matrix to a scalar multiple of
another real or complex matrix ....................................................................... sgesum(3S) .......................................................... 100
Adds a scalar multiple of a real or complex vector to another real or
complex vector ................................................................................................ haxpy(3S) .............................................................. 38
Adds a scalar multiple of a real or complex vector to another real or
complex vector ................................................................................................ saxpy(3S) .............................................................. 46
Adds a scalar multiple of a real or complex vector x to a scalar multiple
of another real or complex vector y ............................................................... saxpby(3S) ............................................................ 44
Adds a scalar multiple of a real vector to a sparse real vector ...................... spaxpy(3S) ............................................................ 56
Applies a complex Fast Fourier Transform (FFT) ......................................... cfft2(3S) ............................................................ 201
Applies a complex-to-real Fast Fourier Transform (FFT) .............................. crfft2(3S) .......................................................... 217
Applies a modified Givens plane rotation ...................................................... srotm(3S) .............................................................. 62
Applies a multitasked complex Fast Fourier Transform (FFT) ...................... cfft(3S)............................................................... 195
Applies a multitasked complex-to-complex Fast Fourier Transform (FFT) ... ccfft(3S) ............................................................ 167
Applies a multitasked complex-to-complex Fast Fourier Transform (FFT) ... ggfft(3S) ............................................................ 227
Applies a multitasked three-dimensional complex Fast Fourier Transform
(FFT) ............................................................................................................... cfft3d(3S) .......................................................... 208
Applies a multitasked three-dimensional real-to-complex Fast Fourier
Transform (FFT) ............................................................................................. scfft3d(3S)........................................................ 303
Applies a multitasked two-dimensional complex Fast Fourier Transform
(FFT) ............................................................................................................... cfft2d(3S) .......................................................... 202
Applies a real plane rotation or complex coordinate rotation ........................ srot(3S)................................................................. 58
Applies a real plane rotation to a pair of complex vectors ............................ csrot(3S) .............................................................. 37
Applies a real-to-complex Fast Fourier Transform (FFT) .............................. rcfft2(3S) .......................................................... 285
Applies a three-dimensional (3D) complex-to-complex Fast Fourier
Transform (FFT) to a matrix distributed across a set of processors .............. pccfft3d(3S) ..................................................... 262
Applies a three-dimensional (3D) real-to-complex or complex-to-real Fast
Fourier Transform (FFT) to a matrix distributed across a set of
processors ........................................................................................................ pscfft3d(3S) ..................................................... 277
Applies a three-dimensional complex-to-complex Fast Fourier Transform
(FFT) ............................................................................................................... ccfft3d(3S)........................................................ 178
Applies a two-dimensional (2D) complex-to-complex Fast Fourier
Transform (FFT) to a matrix distributed across a set of processors .............. pccfft2d(3S) ..................................................... 255
Applies a two-dimensional (2D) real-to-complex or complex-to-real Fast
Fourier Transform (FFT) to a matrix distributed across a set of
processors ........................................................................................................ pscfft2d(3S) ..................................................... 269
Applies a two-dimensional complex-to-complex Fast Fourier Transform
(FFT) ............................................................................................................... ccfft2d(3S)........................................................ 172
Applies a two-dimensional real-to-complex or complex-to-real Fast
Fourier Transform (FFT) ................................................................................ scfft2d(3S)........................................................ 296
Applies complex-to-complex Fast Fourier Transforms (FFTs) on multiple
input vectors .................................................................................................... cfftmlt(3S)........................................................ 215
Applies complex-to-real or real-to-complex Fast Fourier Transforms
(FFTs) on multiple input vectors .................................................................... rfftmlt(3S)........................................................ 286
004– 2081– 002 Index-1

Applies multiple multitasked complex Fast Fourier Transforms (FFTs) ....... mcfft(3S) ............................................................ 245
Applies multiple multitasked complex-to-complex Fast Fourier
Transforms (FFTs) .......................................................................................... ccfftm(3S) .......................................................... 183
Applies multiple real-to-complex or complex-to-real Fast Fourier
Transforms (FFTs) .......................................................................................... scfftm(3S) .......................................................... 309
BAKVEC(3S) .................................................................................................... eispack(3S) ......................................................... 23
bakvec(3S) .................................................................................................... eispack(3S) ......................................................... 23
BALANC(3S) .................................................................................................... eispack(3S) ......................................................... 23
balanc(3S) .................................................................................................... eispack(3S) ......................................................... 23
BALBAK(3S) .................................................................................................... eispack(3S) ......................................................... 23
balbak(3S) .................................................................................................... eispack(3S) ......................................................... 23
Banded symmetric systems of linear equations .............................................. eispack(3S) ......................................................... 23
BANDR(3S) ...................................................................................................... eispack(3S) ......................................................... 23
bandr(3S) ...................................................................................................... eispack(3S) ......................................................... 23
BANDV(3S) ...................................................................................................... eispack(3S) ......................................................... 23
bandv(3S) ...................................................................................................... eispack(3S) ......................................................... 23
Basic Linear Algebra Subprogram .................................................................. sspmv(3S) ............................................................ 104
Basic Linear Algebra Subprogram .................................................................. stpsv(3S) ............................................................ 126
Basic Linear Algebra Subprogram .................................................................. strsv(3S) ............................................................ 130
Basic Linear Algebra Subprogram .................................................................. chemm(3S) ............................................................ 135
Basic Linear Algebra Subprogram .................................................................. strmm(3S) ............................................................ 160
Basic Linear Algebra Subprogram .................................................................. hdot(3S)................................................................. 40
Basic Linear Algebra Subprogram .................................................................. srotm(3S) .............................................................. 62
Basic Linear Algebra Subprogram .................................................................. srotmg(3S) ............................................................ 64
Basic Linear Algebra Subprogram .................................................................. intro_blas2(3S) ................................................ 75
BISECT(3S) .................................................................................................... eispack(3S) ......................................................... 23
bisect(3S) .................................................................................................... eispack(3S) ......................................................... 23
BLAS .............................................................................................................. hdot(3S)................................................................. 40
BLAS .............................................................................................................. srotm(3S) .............................................................. 62
BLAS .............................................................................................................. srotmg(3S) ............................................................ 64
BLAS 1 ........................................................................................................... intro_blas1(3S) ................................................ 33
BLAS 2 ........................................................................................................... sspmv(3S) ............................................................ 104
BLAS 2 ........................................................................................................... stpsv(3S) ............................................................ 126
BLAS 2 ........................................................................................................... intro_blas2(3S) ................................................ 75
BLAS 3 ........................................................................................................... intro_blas3(3S) .............................................. 133
BLAS 3 ........................................................................................................... chemm(3S) ............................................................ 135
BLAS 3 ........................................................................................................... strmm(3S) ............................................................ 160
blas1(3S) ...................................................................................................... intro_blas1(3S) ................................................ 33
blas2(3S) ...................................................................................................... intro_blas2(3S) ................................................ 75
blas3(3S) ...................................................................................................... intro_blas3(3S) .............................................. 133
BQR(3S) ........................................................................................................... eispack(3S) ......................................................... 23
bqr(3S) ........................................................................................................... eispack(3S) ......................................................... 23
CAXPBY(3S) .................................................................................................... saxpby(3S) ............................................................ 44
caxpby(3S) .................................................................................................... saxpby(3S) ............................................................ 44
CAXPY(3S) ...................................................................................................... saxpy(3S) .............................................................. 46
caxpy(3S) ...................................................................................................... saxpy(3S) .............................................................. 46
CBABK2(3S) .................................................................................................... eispack(3S) ......................................................... 23
cbabk2(3S) .................................................................................................... eispack(3S) ......................................................... 23
CBAL(3S) ........................................................................................................ eispack(3S) ......................................................... 23
cbal(3S) ........................................................................................................ eispack(3S) ......................................................... 23
Index-2 004– 2081– 002

CCFFT2D(3S) ................................................................................................. ccfft2d(3S)........................................................ 172
ccfft2d(3S) ................................................................................................. ccfft2d(3S)........................................................ 172
CCFFT3D(3S) ................................................................................................. ccfft3d(3S)........................................................ 178
ccfft3d(3S) ................................................................................................. ccfft3d(3S)........................................................ 178
CCFFT(3S) ...................................................................................................... ccfft(3S) ............................................................ 167
ccfft(3S) ...................................................................................................... ccfft(3S) ............................................................ 167
CCFFTM(3S) .................................................................................................... ccfftm(3S) .......................................................... 183
ccfftm(3S) .................................................................................................... ccfftm(3S) .......................................................... 183
cchdc(3S) ...................................................................................................... linpack(3S) ......................................................... 29
cchdd(3S) ...................................................................................................... linpack(3S) ......................................................... 29
cchex(3S) ...................................................................................................... linpack(3S) ......................................................... 29
cchud(3S) ...................................................................................................... linpack(3S) ......................................................... 29
CCNVL(3S) ...................................................................................................... ccnvl(3S) ............................................................ 188
ccnvl(3S) ...................................................................................................... ccnvl(3S) ............................................................ 188
CCNVLF(3S) .................................................................................................... ccnvlf(3S) .......................................................... 192
ccnvlf(3S) .................................................................................................... ccnvlf(3S) .......................................................... 192
CCOPY2(3S) .................................................................................................... scopy2(3S) .......................................................... 143
ccopy2(3S) .................................................................................................... scopy2(3S) .......................................................... 143
CCOPY(3S) ...................................................................................................... scopy(3S) .............................................................. 48
ccopy(3S) ...................................................................................................... scopy(3S) .............................................................. 48
CDOTC(3S) ...................................................................................................... sdot(3S)................................................................. 50
cdotc(3S) ...................................................................................................... sdot(3S)................................................................. 50
CDOTU(3S) ...................................................................................................... sdot(3S)................................................................. 50
cdotu(3S) ...................................................................................................... sdot(3S)................................................................. 50
CFFT2(3S) ...................................................................................................... cfft2(3S) ............................................................ 201
cfft2(3S) ...................................................................................................... cfft2(3S) ............................................................ 201
CFFT2D(3S) .................................................................................................... cfft2d(3S) .......................................................... 202
cfft2d(3S) .................................................................................................... cfft2d(3S) .......................................................... 202
CFFT3D(3S) .................................................................................................... cfft3d(3S) .......................................................... 208
cfft3d(3S) .................................................................................................... cfft3d(3S) .......................................................... 208
CFFT(3S) ........................................................................................................ cfft(3S)............................................................... 195
cfft(3S) ........................................................................................................ cfft(3S)............................................................... 195
CFFTMLT(3S) ................................................................................................. cfftmlt(3S)........................................................ 215
cfftmlt(3S) ................................................................................................. cfftmlt(3S)........................................................ 215
CFTFAX(3S) .................................................................................................... cfftmlt(3S)........................................................ 215
cftfax(3S) .................................................................................................... cfftmlt(3S)........................................................ 215
CG(3S) ............................................................................................................. eispack(3S) ......................................................... 23
cg(3S) ............................................................................................................. eispack(3S) ......................................................... 23
cgbco(3S) ...................................................................................................... linpack(3S) ......................................................... 29
cgbdi(3S) ...................................................................................................... linpack(3S) ......................................................... 29
cgbfa(3S) ...................................................................................................... linpack(3S) ......................................................... 29
CGBMV(3S) ...................................................................................................... sgbmv(3S) .............................................................. 93
cgbmv(3S) ...................................................................................................... sgbmv(3S) .............................................................. 93
cgbsl(3S) ...................................................................................................... linpack(3S) ......................................................... 29
cgeco(3S) ...................................................................................................... linpack(3S) ......................................................... 29
cgedi(3S) ...................................................................................................... linpack(3S) ......................................................... 29
cgefa(3S) ...................................................................................................... linpack(3S) ......................................................... 29
CGEMM(3S) ...................................................................................................... sgemm(3S) ............................................................ 145
CGEMMS(3S) .................................................................................................... sgemms(3S) .......................................................... 148
cgemms(3S) .................................................................................................... sgemms(3S) .......................................................... 148
004– 2081– 002 Index-3

CGEMV(3S) ...................................................................................................... sgemv(3S) .............................................................. 96
CGERC(3S) ...................................................................................................... sger(3S)................................................................. 98
CGERU(3S) ...................................................................................................... sger(3S)................................................................. 98
cgesl(3S) ...................................................................................................... linpack(3S) ......................................................... 29
CGESUM(3S) .................................................................................................... sgesum(3S) .......................................................... 100
cgesum(3S) .................................................................................................... sgesum(3S) .......................................................... 100
cgtsl(3S) ...................................................................................................... linpack(3S) ......................................................... 29
CH(3S) ............................................................................................................. eispack(3S) ......................................................... 23
ch(3S) ............................................................................................................. eispack(3S) ......................................................... 23
CHBMV(3S) ...................................................................................................... chbmv(3S) .............................................................. 78
chbmv(3S) ...................................................................................................... chbmv(3S) .............................................................. 78
CHEMM(3S) ...................................................................................................... chemm(3S) ............................................................ 135
chemm(3S) ...................................................................................................... chemm(3S) ............................................................ 135
CHEMV(3S) ...................................................................................................... chemv(3S) .............................................................. 81
chemv(3S) ...................................................................................................... chemv(3S) .............................................................. 81
CHER2(3S) ...................................................................................................... cher2(3S) .............................................................. 85
cher2(3S) ...................................................................................................... cher2(3S) .............................................................. 85
CHER2K(3S) .................................................................................................... cher2k(3S) .......................................................... 138
cher2k(3S) .................................................................................................... cher2k(3S) .......................................................... 138
CHER(3S) ........................................................................................................ cher(3S)................................................................. 83
cher(3S) ........................................................................................................ cher(3S)................................................................. 83
CHERK(3S) ...................................................................................................... cherk(3S) ............................................................ 141
cherk(3S) ...................................................................................................... cherk(3S) ............................................................ 141
chico(3S) ...................................................................................................... linpack(3S) ......................................................... 29
chidi(3S) ...................................................................................................... linpack(3S) ......................................................... 29
chifa(3S) ...................................................................................................... linpack(3S) ......................................................... 29
chisl(3S) ...................................................................................................... linpack(3S) ......................................................... 29
Cholesky factorization ..................................................................................... linpack(3S) ......................................................... 29
Cholesky factorization ..................................................................................... intro_lapack(3S) ................................................ 7
chpco(3S) ...................................................................................................... linpack(3S) ......................................................... 29
chpdi(3S) ...................................................................................................... linpack(3S) ......................................................... 29
chpfa(3S) ...................................................................................................... linpack(3S) ......................................................... 29
CHPMV(3S) ...................................................................................................... chpmv(3S) .............................................................. 87
chpmv(3S) ...................................................................................................... chpmv(3S) .............................................................. 87
CHPR2(3S) ...................................................................................................... chpr2(3S) .............................................................. 91
chpr2(3S) ...................................................................................................... chpr2(3S) .............................................................. 91
CHPR(3S) ........................................................................................................ chpr(3S)................................................................. 89
chpr(3S) ........................................................................................................ chpr(3S)................................................................. 89
chpsl(3S) ...................................................................................................... linpack(3S) ......................................................... 29
CINVIT(3S) .................................................................................................... eispack(3S) ......................................................... 23
cinvit(3S) .................................................................................................... eispack(3S) ......................................................... 23
COMBAK(3S) .................................................................................................... eispack(3S) ......................................................... 23
combak(3S) .................................................................................................... eispack(3S) ......................................................... 23
COMHES(3S) .................................................................................................... eispack(3S) ......................................................... 23
comhes(3S) .................................................................................................... eispack(3S) ......................................................... 23
COMLR2(3S) .................................................................................................... eispack(3S) ......................................................... 23
comlr2(3S) .................................................................................................... eispack(3S) ......................................................... 23
COMLR(3S) ...................................................................................................... eispack(3S) ......................................................... 23
comlr(3S) ...................................................................................................... eispack(3S) ......................................................... 23
Complex convolution ...................................................................................... ccnvl(3S) ............................................................ 188
Index-4 004– 2081– 002

Complex convolution ...................................................................................... ccnvlf(3S) .......................................................... 192
Complex convolution using Fast Fourier Transform ...................................... ccnvlf(3S) .......................................................... 192
Complex Fast Fourier transform ..................................................................... cfft2(3S) ............................................................ 201
Complex Fast Fourier transform (multiple input vectors) .............................. cfftmlt(3S)........................................................ 215
Complex FFT convolution .............................................................................. ccnvlf(3S) .......................................................... 192
Complex FFT filter ......................................................................................... ccnvlf(3S) .......................................................... 192
Complex filter ................................................................................................. ccnvl(3S) ............................................................ 188
Complex filter ................................................................................................. ccnvlf(3S) .......................................................... 192
Complex filter using Fast Fourier Transform ................................................. ccnvlf(3S) .......................................................... 192
complex general matrix multiplication (BLAS3) ........................................... sgemm(3S) ............................................................ 145
complex general matrix multiplied by a complex symmetric matrix
(BLAS3) .......................................................................................................... ssymm(3S) ............................................................ 152
complex matrix copy operation (BLAS3) ....................................................... scopy2(3S) .......................................................... 143
complex matrix multiplication (BLAS3) ........................................................ sgemms(3S) .......................................................... 148
complex symmetric matrix rank update (BLAS30 ......................................... ssyrk(3S) ............................................................ 158
complex to real computation (FFT) ................................................................ hgfft(3S) ............................................................ 237
Complex vector addition ................................................................................. saxpy(3S) .............................................................. 46
Complex vector addition ................................................................................. ssum(3S)................................................................. 72
Complex vector exchange ............................................................................... sswap(3S) .............................................................. 73
Complex vector multiplication ........................................................................ saxpby(3S) ............................................................ 44
complex vector multiplication (BLAS2) ......................................................... chbmv(3S) .............................................................. 78
complex vector multiplication (BLAS2) ......................................................... chemv(3S) .............................................................. 81
complex vector multiplication (BLAS2) ......................................................... sgemv(3S) .............................................................. 96
Complex-to-real Fast Fourier transform ......................................................... crfft2(3S) .......................................................... 217
Complex-to-real Fast Fourier transform (multiple input vectors) .................. rfftmlt(3S)........................................................ 286
Computes a correlation of two vectors ........................................................... filterg(3S)........................................................ 224
Computes a correlation of two vectors (symmetric coefficient) ..................... filters(3S)........................................................ 225
Computes a dot product (inner product) of two real or complex vectors ...... hdot(3S)................................................................. 40
Computes a dot product (inner product) of two real or complex vectors ...... sdot(3S)................................................................. 50
Computes a real one-dimensional (1D) convolution of two vectors .............. scnvl1d(3S)........................................................ 316
Computes a real two-dimensional (2D) convolution of two matrices ............ scnvl2d(3S)........................................................ 320
Computes a real-to-complex or complex-to-real Fast Fourier Transform
(FFT) ............................................................................................................... hgfft(3S) ............................................................ 237
Computes a real-to-complex or complex-to-real Fast Fourier Transform
(FFT) ............................................................................................................... scfft(3S) ............................................................ 290
Computes the convolution of a complex sequence with one or more other
complex sequences .......................................................................................... ccnvl(3S) ............................................................ 188
Computes the convolution of a complex sequence with one or more other
complex sequences by using a Fourier transform method ............................. ccnvlf(3S) .......................................................... 192
Computes the dot product of a real vector and a real sparse vector .............. spdot(3S) .............................................................. 57
Computes the Euclidean norm of a vector ..................................................... snrm2(3S) .............................................................. 54
Computes the Hadamard product of two vectors ........................................... shad(3S)................................................................. 52
Condition number ............................................................................................ intro_lapack(3S) ................................................ 7
Constructs a Givens plane rotation ................................................................. srotg(3S) .............................................................. 60
Constructs a modified Givens plane rotation .................................................. srotmg(3S) ............................................................ 64
Convolution ..................................................................................................... intro_fft(3S) ................................................... 163
Convolution ..................................................................................................... ccnvl(3S) ............................................................ 188
Convolution ..................................................................................................... ccnvlf(3S) .......................................................... 192
convolution ...................................................................................................... hconv(3S) ............................................................ 231
convolution ...................................................................................................... sconv(3S) ............................................................ 326
004– 2081– 002 Index-5

CONVOLUTION(3S) ........................................................................................ intro_fft(3S) ................................................... 163
convolution(3S) ........................................................................................ intro_fft(3S) ................................................... 163
Copies a real or complex matrix into another real or complex matrix .......... scopy2(3S) .......................................................... 143
Copies a real or complex vector into another real or complex vector ........... scopy(3S) .............................................................. 48
copying matrices (BLAS3) ............................................................................. scopy2(3S) .......................................................... 143
Copying vectors (BLAS1) .............................................................................. scopy(3S) .............................................................. 48
Correlation ....................................................................................................... filterg(3S)........................................................ 224
Correlation ....................................................................................................... filters(3S)........................................................ 225
correlation ....................................................................................................... hcorr(3S) ............................................................ 233
correlation ....................................................................................................... hcorrs(3S) .......................................................... 235
correlation ....................................................................................................... scorr(3S) ............................................................ 328
correlation ....................................................................................................... scorrs(3S) .......................................................... 330
Correlation of symmetric vectors .................................................................... filters(3S)........................................................ 225
Correlation of two vectors .............................................................................. filters(3S)........................................................ 225
Correlation of vectors ..................................................................................... filterg(3S)........................................................ 224
CORTB(3S) ...................................................................................................... eispack(3S) ......................................................... 23
cortb(3S) ...................................................................................................... eispack(3S) ......................................................... 23
CORTH(3S) ...................................................................................................... eispack(3S) ......................................................... 23
corth(3S) ...................................................................................................... eispack(3S) ......................................................... 23
cpbco(3S) ...................................................................................................... linpack(3S) ......................................................... 29
cpbdi(3S) ...................................................................................................... linpack(3S) ......................................................... 29
cpbfa(3S) ...................................................................................................... linpack(3S) ......................................................... 29
cpbsl(3S) ...................................................................................................... linpack(3S) ......................................................... 29
cpoco(3S) ...................................................................................................... linpack(3S) ......................................................... 29
cpodi(3S) ...................................................................................................... linpack(3S) ......................................................... 29
cpofa(3S) ...................................................................................................... linpack(3S) ......................................................... 29
cposl(3S) ...................................................................................................... linpack(3S) ......................................................... 29
cppco(3S) ...................................................................................................... linpack(3S) ......................................................... 29
cppdi(3S) ...................................................................................................... linpack(3S) ......................................................... 29
cppfa(3S) ...................................................................................................... linpack(3S) ......................................................... 29
cppsl(3S) ...................................................................................................... linpack(3S) ......................................................... 29
cptsl(3S) ...................................................................................................... linpack(3S) ......................................................... 29
cqrdc(3S) ...................................................................................................... linpack(3S) ......................................................... 29
cqrsl(3S) ...................................................................................................... linpack(3S) ......................................................... 29
CRFFT2(3S) .................................................................................................... crfft2(3S) .......................................................... 217
crfft2(3S) .................................................................................................... crfft2(3S) .......................................................... 217
CROT(3S) ........................................................................................................ srot(3S)................................................................. 58
crot(3S) ........................................................................................................ srot(3S)................................................................. 58
CROTG(3S) ...................................................................................................... srotg(3S) .............................................................. 60
crotg(3S) ...................................................................................................... srotg(3S) .............................................................. 60
CSCAL(3S) ...................................................................................................... sscal(3S) .............................................................. 70
cscal(3S) ...................................................................................................... sscal(3S) .............................................................. 70
CSFFT2D(3S) ................................................................................................. scfft2d(3S)........................................................ 296
csfft2d(3S) ................................................................................................. scfft2d(3S)........................................................ 296
CSFFT3D(3S) ................................................................................................. scfft3d(3S)........................................................ 303
csfft3d(3S) ................................................................................................. scfft3d(3S)........................................................ 303
CSFFT(3S) ...................................................................................................... scfft(3S) ............................................................ 290
csfft(3S) ...................................................................................................... scfft(3S) ............................................................ 290
CSFFTM(3S) .................................................................................................... scfftm(3S) .......................................................... 309
csfftm(3S) .................................................................................................... scfftm(3S) .......................................................... 309
Index-6 004– 2081– 002

cspco(3S) ...................................................................................................... linpack(3S) ......................................................... 29
cspdi(3S) ...................................................................................................... linpack(3S) ......................................................... 29
cspfa(3S) ...................................................................................................... linpack(3S) ......................................................... 29
CSPMV(3S) ...................................................................................................... sspmv(3S) ............................................................ 104
cspmv(3S) ...................................................................................................... sspmv(3S) ............................................................ 104
CSPR(3S) ........................................................................................................ sspr(3S)............................................................... 106
cspr(3S) ........................................................................................................ sspr(3S)............................................................... 106
cspsl(3S) ...................................................................................................... linpack(3S) ......................................................... 29
CSROT(3S) ...................................................................................................... csrot(3S) .............................................................. 37
csrot(3S) ...................................................................................................... csrot(3S) .............................................................. 37
CSSCAL(3S) .................................................................................................... sscal(3S) .............................................................. 70
csscal(3S) .................................................................................................... sscal(3S) .............................................................. 70
CSUM(3S) ........................................................................................................ ssum(3S)................................................................. 72
csum(3S) ........................................................................................................ ssum(3S)................................................................. 72
csvdc(3S) ...................................................................................................... linpack(3S) ......................................................... 29
CSWAP(3S) ...................................................................................................... sswap(3S) .............................................................. 73
cswap(3S) ...................................................................................................... sswap(3S) .............................................................. 73
CSYMM(3S) ...................................................................................................... ssymm(3S) ............................................................ 152
CSYMV(3S) ...................................................................................................... ssymv(3S) ............................................................ 112
CSYR2K(3S) .................................................................................................... ssyr2k(3S) .......................................................... 155
CSYR(3S) ........................................................................................................ ssyr(3S)............................................................... 114
CSYRK(3S) ...................................................................................................... ssyrk(3S) ............................................................ 158
CTBMV(3S) ...................................................................................................... stbmv(3S) ............................................................ 118
ctbmv(3S) ...................................................................................................... stbmv(3S) ............................................................ 118
CTBSV(3S) ...................................................................................................... stbsv(3S) ............................................................ 121
ctbsv(3S) ...................................................................................................... stbsv(3S) ............................................................ 121
CTPMV(3S) ...................................................................................................... stpmv(3S) ............................................................ 124
ctpmv(3S) ...................................................................................................... stpmv(3S) ............................................................ 124
CTPSV(3S) ...................................................................................................... stpsv(3S) ............................................................ 126
ctpsv(3S) ...................................................................................................... stpsv(3S) ............................................................ 126
CTRMM(3S) ...................................................................................................... strmm(3S) ............................................................ 160
CTRMV(3S) ...................................................................................................... strmv(3S) ............................................................ 128
ctrmv(3S) ...................................................................................................... strmv(3S) ............................................................ 128
CTRSV(3S) ...................................................................................................... strsv(3S) ............................................................ 130
ctrsv(3S) ...................................................................................................... strsv(3S) ............................................................ 130
Dense ............................................................................................................... linpack(3S) ......................................................... 29
Dense linear algebra ........................................................................................ intro_lapack(3S) ................................................ 7
Dense linear system ........................................................................................ linpack(3S) ......................................................... 29
Dense linear system solvers ............................................................................ intro_lapack(3S) ................................................ 7
Dense linear systems ....................................................................................... intro_lapack(3S) ................................................ 7
Dense solver .................................................................................................... linpack(3S) ......................................................... 29
DESCINIT3D(3S) .......................................................................................... descinit3d(3S) ................................................ 219
descinit3d(3S) .......................................................................................... descinit3d(3S) ................................................ 219
Dot product ..................................................................................................... hdot(3S)................................................................. 40
Dot product (BLAS1) ..................................................................................... sdot(3S)................................................................. 50
Eigenvalue problem ........................................................................................ eispack(3S) ......................................................... 23
Eigenvalues ..................................................................................................... eispack(3S) ......................................................... 23
Eigenvectors .................................................................................................... eispack(3S) ......................................................... 23
EISPACK(3S) ................................................................................................. eispack(3S) ......................................................... 23
eispack(3S) ................................................................................................. eispack(3S) ......................................................... 23
004– 2081– 002 Index-7

ELMBAK(3S) .................................................................................................... eispack(3S) ......................................................... 23
elmbak(3S) .................................................................................................... eispack(3S) ......................................................... 23
ELMHES(3S) .................................................................................................... eispack(3S) ......................................................... 23
elmhes(3S) .................................................................................................... eispack(3S) ......................................................... 23
ELTRAN(3S) .................................................................................................... eispack(3S) ......................................................... 23
eltran(3S) .................................................................................................... eispack(3S) ......................................................... 23
Euclidean norm ............................................................................................... snrm2(3S) .............................................................. 54
Fast Fourier transform ..................................................................................... intro_fft(3S) ................................................... 163
Fast Fourier transform ..................................................................................... ccfft(3S) ............................................................ 167
Fast Fourier transform ..................................................................................... ccfft2d(3S)........................................................ 172
Fast Fourier transform ..................................................................................... ccfft3d(3S)........................................................ 178
Fast Fourier transform ..................................................................................... ccfftm(3S) .......................................................... 183
Fast Fourier transform ..................................................................................... cfft(3S)............................................................... 195
Fast Fourier transform ..................................................................................... cfft2(3S) ............................................................ 201
Fast Fourier transform ..................................................................................... cfft2d(3S) .......................................................... 202
Fast Fourier transform ..................................................................................... cfft3d(3S) .......................................................... 208
Fast Fourier transform ..................................................................................... cfftmlt(3S)........................................................ 215
Fast Fourier transform ..................................................................................... crfft2(3S) .......................................................... 217
Fast Fourier transform ..................................................................................... ggfft(3S) ............................................................ 227
Fast Fourier transform ..................................................................................... mcfft(3S) ............................................................ 245
Fast Fourier transform ..................................................................................... rcfft2(3S) .......................................................... 285
Fast Fourier transform ..................................................................................... rfftmlt(3S)........................................................ 286
Fast Fourier transform ..................................................................................... scfft(3S) ............................................................ 290
Fast Fourier transform ..................................................................................... scfft2d(3S)........................................................ 296
Fast Fourier transform ..................................................................................... scfft3d(3S)........................................................ 303
Fast Fourier transform ..................................................................................... scfftm(3S) .......................................................... 309
Fast Fourier transform for multiple input vectors .......................................... rfftmlt(3S)........................................................ 286
FFT .................................................................................................................. intro_fft(3S) ................................................... 163
FFT .................................................................................................................. ccfft(3S) ............................................................ 167
FFT .................................................................................................................. ccfft2d(3S)........................................................ 172
FFT .................................................................................................................. ccfft3d(3S)........................................................ 178
FFT .................................................................................................................. ccfftm(3S) .......................................................... 183
FFT .................................................................................................................. cfft(3S)............................................................... 195
FFT .................................................................................................................. cfft2(3S) ............................................................ 201
FFT .................................................................................................................. cfft2d(3S) .......................................................... 202
FFT .................................................................................................................. cfft3d(3S) .......................................................... 208
FFT .................................................................................................................. cfftmlt(3S)........................................................ 215
FFT .................................................................................................................. crfft2(3S) .......................................................... 217
FFT .................................................................................................................. ggfft(3S) ............................................................ 227
FFT .................................................................................................................. mcfft(3S) ............................................................ 245
FFT .................................................................................................................. rcfft2(3S) .......................................................... 285
FFT .................................................................................................................. rfftmlt(3S)........................................................ 286
FFT .................................................................................................................. scfft(3S) ............................................................ 290
FFT .................................................................................................................. scfft2d(3S)........................................................ 296
FFT .................................................................................................................. scfft3d(3S)........................................................ 303
FFT .................................................................................................................. scfftm(3S) .......................................................... 309
FFT convolution .............................................................................................. ccnvlf(3S) .......................................................... 192
FFT filter ......................................................................................................... ccnvlf(3S) .......................................................... 192
FFT(3S) ........................................................................................................... intro_fft(3S) ................................................... 163
fft(3S) ........................................................................................................... intro_fft(3S) ................................................... 163
Index-8 004– 2081– 002

FFTFAX(3S) .................................................................................................... rfftmlt(3S)........................................................ 286
fftfax(3S) .................................................................................................... rfftmlt(3S)........................................................ 286
FIGI2(3S) ...................................................................................................... eispack(3S) ......................................................... 23
figi2(3S) ...................................................................................................... eispack(3S) ......................................................... 23
FIGI(3S) ........................................................................................................ eispack(3S) ......................................................... 23
figi(3S) ........................................................................................................ eispack(3S) ......................................................... 23
Filter ................................................................................................................ intro_fft(3S) ................................................... 163
Filter ................................................................................................................ ccnvl(3S) ............................................................ 188
Filter ................................................................................................................ ccnvlf(3S) .......................................................... 192
Filter ................................................................................................................ filterg(3S)........................................................ 224
Filter ................................................................................................................ filters(3S)........................................................ 225
Filter ................................................................................................................ hopfilt(3S)........................................................ 243
Filter ................................................................................................................ opfilt(3S) .......................................................... 253
filter sequence ................................................................................................. hconv(3S) ............................................................ 231
filter sequence ................................................................................................. hcorr(3S) ............................................................ 233
filter sequence ................................................................................................. sconv(3S) ............................................................ 326
filter sequence ................................................................................................. scorr(3S) ............................................................ 328
FILTER(3S) .................................................................................................... intro_fft(3S) ................................................... 163
filter(3S) .................................................................................................... intro_fft(3S) ................................................... 163
FILTERG(3S) ................................................................................................. filterg(3S)........................................................ 224
filterg(3S) ................................................................................................. filterg(3S)........................................................ 224
FILTERS(3S) ................................................................................................. filters(3S)........................................................ 225
filters(3S) ................................................................................................. filters(3S)........................................................ 225
Fourier transform ............................................................................................ intro_fft(3S) ................................................... 163
GAXPY(3S) ...................................................................................................... haxpy(3S) .............................................................. 38
gaxpy(3S) ...................................................................................................... haxpy(3S) .............................................................. 38
GDOTC(3S) ...................................................................................................... hdot(3S)................................................................. 40
gdotc(3S) ...................................................................................................... hdot(3S)................................................................. 40
GDOTU(3S) ...................................................................................................... hdot(3S)................................................................. 40
gdotu(3S) ...................................................................................................... hdot(3S)................................................................. 40
General band matrix ........................................................................................ sgbmv(3S) .............................................................. 93
General band matrix ........................................................................................ sgemv(3S) .............................................................. 96
General matrix ................................................................................................. chemm(3S) ............................................................ 135
General matrix ................................................................................................. strmm(3S) ............................................................ 160
General matrix ................................................................................................. sger(3S)................................................................. 98
GGFFT(3S) ...................................................................................................... ggfft(3S) ............................................................ 227
ggfft(3S) ...................................................................................................... ggfft(3S) ............................................................ 227
GHFFT(3S) ...................................................................................................... hgfft(3S) ............................................................ 237
ghfft(3S) ...................................................................................................... hgfft(3S) ............................................................ 237
Givens ............................................................................................................. srotm(3S) .............................................................. 62
Givens ............................................................................................................. srotmg(3S) ............................................................ 64
Givens plane rotation application ................................................................... srotm(3S) .............................................................. 62
Givens plane rotation construction ................................................................. srotg(3S) .............................................................. 60
Givens plane rotation construction ................................................................. srotmg(3S) ............................................................ 64
Hadamard products ......................................................................................... shad(3S)................................................................. 52
HAXPY(3S) ...................................................................................................... haxpy(3S) .............................................................. 38
haxpy(3S) ...................................................................................................... haxpy(3S) .............................................................. 38
HCONV(3S) ...................................................................................................... hconv(3S) ............................................................ 231
hconv(3S) ...................................................................................................... hconv(3S) ............................................................ 231
HCORR(3S) ...................................................................................................... hcorr(3S) ............................................................ 233
004– 2081– 002 Index-9

hcorr(3S) ...................................................................................................... hcorr(3S) ............................................................ 233
HCORRS(3S) .................................................................................................... hcorrs(3S) .......................................................... 235
hcorrs(3S) .................................................................................................... hcorrs(3S) .......................................................... 235
HDOT(3S) ........................................................................................................ hdot(3S)................................................................. 40
hdot(3S) ........................................................................................................ hdot(3S)................................................................. 40
Hermitian band matrix .................................................................................... chbmv(3S) .............................................................. 78
Hermitian matrix ............................................................................................. chemm(3S) ............................................................ 135
Hermitian matrix ............................................................................................. cher(3S)................................................................. 83
Hermitian packed matrix ................................................................................. chpmv(3S) .............................................................. 87
Hermitian packed matrix ................................................................................. chpr2(3S) .............................................................. 91
Hermitian rank 1 update ................................................................................. cher(3S)................................................................. 83
Hermitian rank 1 update ................................................................................. chpr(3S)................................................................. 89
Hermitian rank 2 update ................................................................................. cher2(3S) .............................................................. 85
Hermitian rank 2k update (BLAS3) ............................................................... cher2k(3S) .......................................................... 138
Hermitian rank k update (BLAS3) ................................................................. cherk(3S) ............................................................ 141
HGFFT(3S) ...................................................................................................... hgfft(3S) ............................................................ 237
hgfft(3S) ...................................................................................................... hgfft(3S) ............................................................ 237
HOPFILT(3S) ................................................................................................. hopfilt(3S)........................................................ 243
hopfilt(3S) ................................................................................................. hopfilt(3S)........................................................ 243
HTRIB3(3S) .................................................................................................... eispack(3S) ......................................................... 23
htrib3(3S) .................................................................................................... eispack(3S) ......................................................... 23
HTRIBK(3S) .................................................................................................... eispack(3S) ......................................................... 23
htribk(3S) .................................................................................................... eispack(3S) ......................................................... 23
HTRID3(3S) .................................................................................................... eispack(3S) ......................................................... 23
htrid3(3S) .................................................................................................... eispack(3S) ......................................................... 23
HTRIDI(3S) .................................................................................................... eispack(3S) ......................................................... 23
htridi(3S) .................................................................................................... eispack(3S) ......................................................... 23
IMTQL1(3S) .................................................................................................... eispack(3S) ......................................................... 23
imtql1(3S) .................................................................................................... eispack(3S) ......................................................... 23
IMTQL2(3S) .................................................................................................... eispack(3S) ......................................................... 23
imtql2(3S) .................................................................................................... eispack(3S) ......................................................... 23
IMTQLV(3S) .................................................................................................... eispack(3S) ......................................................... 23
imtqlv(3S) .................................................................................................... eispack(3S) ......................................................... 23
initialize descriptor vector (FFT) .................................................................... descinit3d(3S) ................................................ 219
Initializes a descriptor vector that contains information about the
distribution of a three-dimensional (3D) array across a 3D grid of
processors ........................................................................................................ descinit3d(3S) ................................................ 219
Inner product ................................................................................................... hdot(3S)................................................................. 40
Inner product ................................................................................................... sdot(3S)................................................................. 50
INTRO_BLAS1(3S) ........................................................................................ intro_blas1(3S) ................................................ 33
intro_blas1(3S) ........................................................................................ intro_blas1(3S) ................................................ 33
INTRO_BLAS2(3S) ........................................................................................ intro_blas2(3S) ................................................ 75
intro_blas2(3S) ........................................................................................ intro_blas2(3S) ................................................ 75
INTRO_BLAS3(3S) ........................................................................................ intro_blas3(3S) .............................................. 133
intro_blas3(3S) ........................................................................................ intro_blas3(3S) .............................................. 133
Introduction to BLAS 1 .................................................................................. intro_blas1(3S) ................................................ 33
Introduction to BLAS 3 .................................................................................. intro_blas3(3S) .............................................. 133
Introduction to Eigensystem computation for dense linear systems ............... eispack(3S) ......................................................... 23
Introduction to LAPACK solvers for dense linear systems ........................... intro_lapack(3S) ................................................ 7
Introduction to matrix-matrix linear algebra subprograms ............................. intro_blas3(3S) .............................................. 133
Index-10 004– 2081– 002

Introduction to matrix-vector linear algebra subprograms .............................. intro_blas2(3S) ................................................ 75
Introduction to Scientific Libraries ................................................................. intro_libsci(3S) ................................................ 1
Introduction to Scientific Library routines ...................................................... intro_libsci(3S) ................................................ 1
Introduction to signal processing routines ...................................................... intro_fft(3S) ................................................... 163
Introduction to vector-vector linear algebra subprograms .............................. intro_blas1(3S) ................................................ 33
INTRO_FFT(3S) ............................................................................................. intro_fft(3S) ................................................... 163
intro_fft(3S) ............................................................................................. intro_fft(3S) ................................................... 163
INTRO_LAPACK(3S) ...................................................................................... intro_lapack(3S) ................................................ 7
intro_lapack(3S) ...................................................................................... intro_lapack(3S) ................................................ 7
INTRO_LIBSCI(3S) ...................................................................................... intro_libsci(3S) ................................................ 1
intro_libsci(3S) ...................................................................................... intro_libsci(3S) ................................................ 1
Inverse ............................................................................................................. intro_lapack(3S) ................................................ 7
INVIT(3S) ...................................................................................................... eispack(3S) ......................................................... 23
invit(3S) ...................................................................................................... eispack(3S) ......................................................... 23
LAPACK ......................................................................................................... intro_lapack(3S) ................................................ 7
Lapack ............................................................................................................. intro_lapack(3S) ................................................ 7
LAPACK(3S) .................................................................................................... intro_lapack(3S) ................................................ 7
lapack(3S) .................................................................................................... intro_lapack(3S) ................................................ 7
Level 1 Basic Linear Algebra Subprogram .................................................... hdot(3S)................................................................. 40
Level 1 Basic Linear Algebra Subprogram .................................................... srotm(3S) .............................................................. 62
Level 1 Basic Linear Algebra Subprogram .................................................... srotmg(3S) ............................................................ 64
Level 1 BLAS ................................................................................................. hdot(3S)................................................................. 40
Level 1 BLAS ................................................................................................. srotm(3S) .............................................................. 62
Level 1 BLAS ................................................................................................. srotmg(3S) ............................................................ 64
Level 2 Basic Linear Algebra Subprogram .................................................... sspmv(3S) ............................................................ 104
Level 2 Basic Linear Algebra Subprogram .................................................... stpsv(3S) ............................................................ 126
Level 2 Basic Linear Algebra Subprogram .................................................... intro_blas2(3S) ................................................ 75
Level 2 BLAS ................................................................................................. sspmv(3S) ............................................................ 104
Level 2 BLAS ................................................................................................. stpsv(3S) ............................................................ 126
Level 2 BLAS ................................................................................................. intro_blas2(3S) ................................................ 75
Level 3 Basic Linear Algebra Subprogram .................................................... chemm(3S) ............................................................ 135
Level 3 Basic Linear Algebra Subprogram .................................................... strmm(3S) ............................................................ 160
Level 3 BLAS ................................................................................................. intro_blas3(3S) .............................................. 133
Level 3 BLAS ................................................................................................. chemm(3S) ............................................................ 135
Level 3 BLAS ................................................................................................. strmm(3S) ............................................................ 160
Libsci intro ...................................................................................................... intro_libsci(3S) ................................................ 1
libsci(3S) .................................................................................................... intro_libsci(3S) ................................................ 1
Linear algebra ................................................................................................. intro_lapack(3S) ................................................ 7
Linear digital filter .......................................................................................... intro_fft(3S) ................................................... 163
Linear equations .............................................................................................. hopfilt(3S)........................................................ 243
Linear equations .............................................................................................. opfilt(3S) .......................................................... 253
Linear equations .............................................................................................. linpack(3S) ......................................................... 29
Linear system solvers ...................................................................................... intro_lapack(3S) ................................................ 7
Linear systems ................................................................................................. intro_lapack(3S) ................................................ 7
LINPACK(3S) ................................................................................................. linpack(3S) ......................................................... 29
linpack(3S) ................................................................................................. linpack(3S) ......................................................... 29
LU factorization .............................................................................................. intro_lapack(3S) ................................................ 7
Matrix-matrix multiplication ........................................................................... chemm(3S) ............................................................ 135
Matrix-matrix multiplication ........................................................................... strmm(3S) ............................................................ 160
Matrix-vector linear algebra subprograms ...................................................... intro_blas2(3S) ................................................ 75
004– 2081– 002 Index-11

Matrix-vector multiplication ........................................................................... sspmv(3S) ............................................................ 104
Matrix-vector multiplication ........................................................................... ssymv(3S) ............................................................ 112
Matrix-vector multiplication ........................................................................... stbmv(3S) ............................................................ 118
Matrix-vector multiplication ........................................................................... strmv(3S) ............................................................ 128
Matrix-vector multiplication ........................................................................... chbmv(3S) .............................................................. 78
Matrix-vector multiplication ........................................................................... chemv(3S) .............................................................. 81
MCFFT(3S) ...................................................................................................... mcfft(3S) ............................................................ 245
mcfft(3S) ...................................................................................................... mcfft(3S) ............................................................ 245
MINFIT(3S) .................................................................................................... eispack(3S) ......................................................... 23
minfit(3S) .................................................................................................... eispack(3S) ......................................................... 23
Modified Givens plane rotation ...................................................................... srotm(3S) .............................................................. 62
Modified Givens plane rotation ...................................................................... srotmg(3S) ............................................................ 64
Multiple multitasked complex Fast Fourier transform ................................... ccfftm(3S) .......................................................... 183
Multiple multitasked complex Fast Fourier transform ................................... mcfft(3S) ............................................................ 245
Multiple multitasked real-to-complex Fast Fourier transform ........................ scfftm(3S) .......................................................... 309
Multiple-input vector complex Fast Fourier transform ................................... cfftmlt(3S)........................................................ 215
Multiplies a complex general matrix by a complex Hermitian matrix .......... chemm(3S) ............................................................ 135
Multiplies a complex vector by a complex Hermitian band matrix ............... chbmv(3S) .............................................................. 78
Multiplies a complex vector by a complex Hermitian matrix ........................ chemv(3S) .............................................................. 81
Multiplies a complex vector by a packed complex Hermitian matrix ........... chpmv(3S) .............................................................. 87
Multiplies a real or complex general matrix by a real or complex general
matrix .............................................................................................................. sgemm(3S) ............................................................ 145
Multiplies a real or complex general matrix by a real or complex general
matrix, using Strassen’s algorithm .................................................................. sgemms(3S) .......................................................... 148
Multiplies a real or complex general matrix by a real or complex
symmetric matrix ............................................................................................ ssymm(3S) ............................................................ 152
Multiplies a real or complex general matrix by a real or complex
triangular matrix .............................................................................................. strmm(3S) ............................................................ 160
Multiplies a real or complex symmetric packed matrix by a real or
complex vector ................................................................................................ sspmv(3S) ............................................................ 104
Multiplies a real or complex vector by a real or complex general band
matrix .............................................................................................................. sgbmv(3S) .............................................................. 93
Multiplies a real or complex vector by a real or complex general matrix ..... sgemv(3S) .............................................................. 96
Multiplies a real or complex vector by a real or complex symmetric
matrix .............................................................................................................. ssymv(3S) ............................................................ 112
Multiplies a real or complex vector by a real or complex triangular band
matrix .............................................................................................................. stbmv(3S) ............................................................ 118
Multiplies a real or complex vector by a real or complex triangular
matrix .............................................................................................................. strmv(3S) ............................................................ 128
Multiplies a real or complex vector by a real or complex triangular
packed matrix .................................................................................................. stpmv(3S) ............................................................ 124
Multiplies a real vector by a real symmetric band matrix ............................. ssbmv(3S) ............................................................ 102
Multitasked complex Fast Fourier transform .................................................. ccfft(3S) ............................................................ 167
Multitasked complex Fast Fourier transform .................................................. cfft(3S)............................................................... 195
Multitasked complex Fast Fourier transform .................................................. ggfft(3S) ............................................................ 227
Multitasked complex Fast Fourier transform .................................................. scfft(3S) ............................................................ 290
Multitasked three-dimensional Fast Fourier transform ................................... ccfft3d(3S)........................................................ 178
Multitasked three-dimensional Fast Fourier transform ................................... cfft3d(3S) .......................................................... 208
Multitasked three-dimensional real-to-complex Fast Fourier transform ......... scfft3d(3S)........................................................ 303
Multitasked two-dimensional complex Fast Fourier transform ...................... ccfft2d(3S)........................................................ 172
Index-12 004– 2081– 002

Multitasked two-dimensional complex Fast Fourier transform ...................... cfft2d(3S) .......................................................... 202
Multitasked two-dimensional real-to-complex Fast Fourier transform ........... scfft2d(3S)........................................................ 296
OPFILT(3S) .................................................................................................... opfilt(3S) .......................................................... 253
opfilt(3S) .................................................................................................... opfilt(3S) .......................................................... 253
Optional scaling .............................................................................................. sgesum(3S) .......................................................... 100
ORTBAK(3S) .................................................................................................... eispack(3S) ......................................................... 23
ortbak(3S) .................................................................................................... eispack(3S) ......................................................... 23
ORTHES(3S) .................................................................................................... eispack(3S) ......................................................... 23
orthes(3S) .................................................................................................... eispack(3S) ......................................................... 23
ORTRAN(3S) .................................................................................................... eispack(3S) ......................................................... 23
ortran(3S) .................................................................................................... eispack(3S) ......................................................... 23
Packed Hermitian matrix ................................................................................ chpmv(3S) .............................................................. 87
Packed Hermitian matrix ................................................................................ chpr2(3S) .............................................................. 91
Packed symmetric matrix ................................................................................ sspmv(3S) ............................................................ 104
Packed symmetric matrix ................................................................................ sspr(3S)............................................................... 106
Packed symmetric matrix ................................................................................ sspr2(3S) ............................................................ 108
Packed symmetric matrix ................................................................................ sspr12(3S) .......................................................... 110
Packed triangular matrix ................................................................................. stpmv(3S) ............................................................ 124
Packed triangular system of equations ............................................................ stpsv(3S) ............................................................ 126
PCCFFT2D(3S) ............................................................................................... pccfft2d(3S) ..................................................... 255
pccfft2d(3S) ............................................................................................... pccfft2d(3S) ..................................................... 255
PCCFFT3D(3S) ............................................................................................... pccfft3d(3S) ..................................................... 262
pccfft3d(3S) ............................................................................................... pccfft3d(3S) ..................................................... 262
PCSFFT2D(3S) ............................................................................................... pscfft2d(3S) ..................................................... 269
pcsfft2d(3S) ............................................................................................... pscfft2d(3S) ..................................................... 269
PCSFFT3D(3S) ............................................................................................... pscfft3d(3S) ..................................................... 277
pcsfft3d(3S) ............................................................................................... pscfft3d(3S) ..................................................... 277
Performs Hermitian rank 1 update of a complex Hermitian matrix ............... cher(3S)................................................................. 83
Performs Hermitian rank 1 update of a packed complex Hermitian matrix .. chpr(3S)................................................................. 89
Performs Hermitian rank 2 update of a complex Hermitian matrix ............... cher2(3S) .............................................................. 85
Performs Hermitian rank 2 update of a packed complex Hermitian matrix .. chpr2(3S) .............................................................. 91
Performs Hermitian rank 2k update of a complex Hermitian matrix ............. cher2k(3S) .......................................................... 138
Performs Hermitian rank k update of a complex Hermitian matrix ............... cherk(3S) ............................................................ 141
Performs rank 1 update of a real general matrix ............................................ sger(3S)................................................................. 98
Performs symmetric rank 1 update of a real or complex symmetric matrix .. ssyr(3S)............................................................... 114
Performs symmetric rank 1 update of a real or complex symmetric
packed matrix .................................................................................................. sspr(3S)............................................................... 106
Performs symmetric rank 2 update of a real symmetric matrix ..................... ssyr2(3S) ............................................................ 116
Performs symmetric rank 2 update of a real symmetric packed matrix ........ sspr2(3S) ............................................................ 108
Performs symmetric rank 2k update of a real or complex symmetric
matrix .............................................................................................................. ssyr2k(3S) .......................................................... 155
Performs symmetric rank k update of a real or complex symmetric matrix .. ssyrk(3S) ............................................................ 158
Performs the convolution of two sequences of real numbers ......................... hconv(3S) ............................................................ 231
Performs the convolution of two sequences of real numbers ......................... sconv(3S) ............................................................ 326
Performs the correlation of two sequences of real numbers .......................... hcorr(3S) ............................................................ 233
Performs the correlation of two sequences of real numbers .......................... scorr(3S) ............................................................ 328
Performs the correlation of two sequences of real numbers (symmetric
filter) ................................................................................................................ hcorrs(3S) .......................................................... 235
Performs the correlation of two sequences of real numbers (symmetric
filter) ................................................................................................................ scorrs(3S) .......................................................... 330
004– 2081– 002 Index-13

Performs two simultaneous symmetric rank 1 updates of a real symmetric
packed matrix .................................................................................................. sspr12(3S) .......................................................... 110
Plane rotation .................................................................................................. srotm(3S) .............................................................. 62
Plane rotation .................................................................................................. srotmg(3S) ............................................................ 64
post tapered ..................................................................................................... hconv(3S) ............................................................ 231
post tapered ..................................................................................................... hcorr(3S) ............................................................ 233
post tapered ..................................................................................................... hcorrs(3S) .......................................................... 235
post tapered ..................................................................................................... sconv(3S) ............................................................ 326
post tapered ..................................................................................................... scorr(3S) ............................................................ 328
post tapered ..................................................................................................... scorrs(3S) .......................................................... 330
post-tapered ..................................................................................................... hconv(3S) ............................................................ 231
post-tapered ..................................................................................................... hcorr(3S) ............................................................ 233
post-tapered ..................................................................................................... hcorrs(3S) .......................................................... 235
post-tapered ..................................................................................................... sconv(3S) ............................................................ 326
post-tapered ..................................................................................................... scorr(3S) ............................................................ 328
post-tapered ..................................................................................................... scorrs(3S) .......................................................... 330
PSCFFT2D(3S) ............................................................................................... pscfft2d(3S) ..................................................... 269
pscfft2d(3S) ............................................................................................... pscfft2d(3S) ..................................................... 269
PSCFFT3D(3S) ............................................................................................... pscfft3d(3S) ..................................................... 277
pscfft3d(3S) ............................................................................................... pscfft3d(3S) ..................................................... 277
QR factorization .............................................................................................. linpack(3S) ......................................................... 29
QZHES(3S) ...................................................................................................... eispack(3S) ......................................................... 23
qzhes(3S) ...................................................................................................... eispack(3S) ......................................................... 23
QZIT(3S) ........................................................................................................ eispack(3S) ......................................................... 23
qzit(3S) ........................................................................................................ eispack(3S) ......................................................... 23
QZVAL(3S) ...................................................................................................... eispack(3S) ......................................................... 23
qzval(3S) ...................................................................................................... eispack(3S) ......................................................... 23
QZVEC(3S) ...................................................................................................... eispack(3S) ......................................................... 23
qzvec(3S) ...................................................................................................... eispack(3S) ......................................................... 23
Rank 1 update ................................................................................................. sger(3S)................................................................. 98
RATQR(3S) ...................................................................................................... eispack(3S) ......................................................... 23
ratqr(3S) ...................................................................................................... eispack(3S) ......................................................... 23
RCFFT2(3S) .................................................................................................... rcfft2(3S) .......................................................... 285
rcfft2(3S) .................................................................................................... rcfft2(3S) .......................................................... 285
real general matrix multiplication (BLAS3) ................................................... sgemm(3S) ............................................................ 145
real general matrix multiplied by a real symmetric matrix (BLAS3) ............ ssymm(3S) ............................................................ 152
real matrix copy operation (BLAS3) .............................................................. scopy2(3S) .......................................................... 143
real matrix multiplication (BLAS3) ................................................................ sgemms(3S) .......................................................... 148
real plane rotation ........................................................................................... srot(3S)................................................................. 58
real plane rotation (BLAS1) ........................................................................... csrot(3S) .............................................................. 37
real symmetric matrix rank update (BLAS3) ................................................. ssyrk(3S) ............................................................ 158
real to complex computation (FFT) ................................................................ hgfft(3S) ............................................................ 237
Real vector addition ........................................................................................ haxpy(3S) .............................................................. 38
Real vector addition ........................................................................................ saxpy(3S) .............................................................. 46
Real vector addition ........................................................................................ ssum(3S)................................................................. 72
Real vector exchange ...................................................................................... sswap(3S) .............................................................. 73
Real vector multiplication ............................................................................... saxpby(3S) ............................................................ 44
real vector multiplication (BLAS2) ................................................................ sgemv(3S) .............................................................. 96
Real-to-complex Fast Fourier transform ......................................................... rcfft2(3S) .......................................................... 285
Real-to-complex Fast Fourier transform (multiple input vectors) .................. rfftmlt(3S)........................................................ 286
Index-14 004– 2081– 002

REBAK(3S) ...................................................................................................... eispack(3S) ......................................................... 23
rebak(3S) ...................................................................................................... eispack(3S) ......................................................... 23
REBAKB(3S) .................................................................................................... eispack(3S) ......................................................... 23
rebakb(3S) .................................................................................................... eispack(3S) ......................................................... 23
REDUC2(3S) .................................................................................................... eispack(3S) ......................................................... 23
reduc2(3S) .................................................................................................... eispack(3S) ......................................................... 23
REDUC(3S) ...................................................................................................... eispack(3S) ......................................................... 23
reduc(3S) ...................................................................................................... eispack(3S) ......................................................... 23
RFFTMLT(3S) ................................................................................................. rfftmlt(3S)........................................................ 286
rfftmlt(3S) ................................................................................................. rfftmlt(3S)........................................................ 286
RG(3S) ............................................................................................................. eispack(3S) ......................................................... 23
rg(3S) ............................................................................................................. eispack(3S) ......................................................... 23
RGG(3S) ........................................................................................................... eispack(3S) ......................................................... 23
rgg(3S) ........................................................................................................... eispack(3S) ......................................................... 23
Rotation ........................................................................................................... srotm(3S) .............................................................. 62
Rotation ........................................................................................................... srotmg(3S) ............................................................ 64
RS(3S) ............................................................................................................. eispack(3S) ......................................................... 23
rs(3S) ............................................................................................................. eispack(3S) ......................................................... 23
RSB(3S) ........................................................................................................... eispack(3S) ......................................................... 23
rsb(3S) ........................................................................................................... eispack(3S) ......................................................... 23
RSG(3S) ........................................................................................................... eispack(3S) ......................................................... 23
rsg(3S) ........................................................................................................... eispack(3S) ......................................................... 23
RSGAB(3S) ...................................................................................................... eispack(3S) ......................................................... 23
rsgab(3S) ...................................................................................................... eispack(3S) ......................................................... 23
RSGBA(3S) ...................................................................................................... eispack(3S) ......................................................... 23
rsgba(3S) ...................................................................................................... eispack(3S) ......................................................... 23
RSM(3S) ........................................................................................................... eispack(3S) ......................................................... 23
rsm(3S) ........................................................................................................... eispack(3S) ......................................................... 23
RSP(3S) ........................................................................................................... eispack(3S) ......................................................... 23
rsp(3S) ........................................................................................................... eispack(3S) ......................................................... 23
RST(3S) ........................................................................................................... eispack(3S) ......................................................... 23
rst(3S) ........................................................................................................... eispack(3S) ......................................................... 23
RT(3S) ............................................................................................................. eispack(3S) ......................................................... 23
rt(3S) ............................................................................................................. eispack(3S) ......................................................... 23
SASUM(3S) ...................................................................................................... sasum(3S) .............................................................. 42
sasum(3S) ...................................................................................................... sasum(3S) .............................................................. 42
SAXPBY(3S) .................................................................................................... saxpby(3S) ............................................................ 44
saxpby(3S) .................................................................................................... saxpby(3S) ............................................................ 44
SAXPY(3S) ...................................................................................................... saxpy(3S) .............................................................. 46
saxpy(3S) ...................................................................................................... saxpy(3S) .............................................................. 46
Scalar ............................................................................................................... saxpby(3S) ............................................................ 44
Scalar multiple addition .................................................................................. haxpy(3S) .............................................................. 38
Scalar multiple addition (BLAS1) .................................................................. saxpy(3S) .............................................................. 46
Scales a real or complex vector ...................................................................... sscal(3S) .............................................................. 70
Scaling ............................................................................................................. sgesum(3S) .......................................................... 100
Scaling a complex vector ................................................................................ sscal(3S) .............................................................. 70
Scaling a real vector ....................................................................................... sscal(3S) .............................................................. 70
SCASUM(3S) .................................................................................................... sasum(3S) .............................................................. 42
scasum(3S) .................................................................................................... sasum(3S) .............................................................. 42
SCFFT2D(3S) ................................................................................................. scfft2d(3S)........................................................ 296
004– 2081– 002 Index-15

scfft2d(3S) ................................................................................................. scfft2d(3S)........................................................ 296
SCFFT3D(3S) ................................................................................................. scfft3d(3S)........................................................ 303
scfft3d(3S) ................................................................................................. scfft3d(3S)........................................................ 303
SCFFT(3S) ...................................................................................................... scfft(3S) ............................................................ 290
scfft(3S) ...................................................................................................... scfft(3S) ............................................................ 290
SCFFTM(3S) .................................................................................................... scfftm(3S) .......................................................... 309
scfftm(3S) .................................................................................................... scfftm(3S) .......................................................... 309
schdc(3S) ...................................................................................................... linpack(3S) ......................................................... 29
schdd(3S) ...................................................................................................... linpack(3S) ......................................................... 29
schex(3S) ...................................................................................................... linpack(3S) ......................................................... 29
schud(3S) ...................................................................................................... linpack(3S) ......................................................... 29
Scilib ............................................................................................................... intro_libsci(3S) ................................................ 1
Scilib intro ....................................................................................................... intro_libsci(3S) ................................................ 1
SCNRM2(3S) .................................................................................................... snrm2(3S) .............................................................. 54
scnrm2(3S) .................................................................................................... snrm2(3S) .............................................................. 54
SCNVL1D(3S) ................................................................................................. scnvl1d(3S)........................................................ 316
scnvl1d(3S) ................................................................................................. scnvl1d(3S)........................................................ 316
SCNVL2D(3S) ................................................................................................. scnvl2d(3S)........................................................ 320
scnvl2d(3S) ................................................................................................. scnvl2d(3S)........................................................ 320
SCONV(3S) ...................................................................................................... sconv(3S) ............................................................ 326
sconv(3S) ...................................................................................................... sconv(3S) ............................................................ 326
SCOPY2(3S) .................................................................................................... scopy2(3S) .......................................................... 143
scopy2(3S) .................................................................................................... scopy2(3S) .......................................................... 143
SCOPY(3S) ...................................................................................................... scopy(3S) .............................................................. 48
scopy(3S) ...................................................................................................... scopy(3S) .............................................................. 48
SCORR(3S) ...................................................................................................... scorr(3S) ............................................................ 328
scorr(3S) ...................................................................................................... scorr(3S) ............................................................ 328
SCORRS(3S) .................................................................................................... scorrs(3S) .......................................................... 330
scorrs(3S) .................................................................................................... scorrs(3S) .......................................................... 330
SDOT(3S) ........................................................................................................ sdot(3S)................................................................. 50
sdot(3S) ........................................................................................................ sdot(3S)................................................................. 50
sgbco(3S) ...................................................................................................... linpack(3S) ......................................................... 29
sgbdi(3S) ...................................................................................................... linpack(3S) ......................................................... 29
sgbfa(3S) ...................................................................................................... linpack(3S) ......................................................... 29
SGBMV(3S) ...................................................................................................... sgbmv(3S) .............................................................. 93
sgbmv(3S) ...................................................................................................... sgbmv(3S) .............................................................. 93
sgbsl(3S) ...................................................................................................... linpack(3S) ......................................................... 29
sgeco(3S) ...................................................................................................... linpack(3S) ......................................................... 29
sgedi(3S) ...................................................................................................... linpack(3S) ......................................................... 29
sgefa(3S) ...................................................................................................... linpack(3S) ......................................................... 29
SGEMM(3S) ...................................................................................................... sgemm(3S) ............................................................ 145
sgemm(3S) ...................................................................................................... sgemm(3S) ............................................................ 145
SGEMMS(3S) .................................................................................................... sgemms(3S) .......................................................... 148
sgemms(3S) .................................................................................................... sgemms(3S) .......................................................... 148
SGEMV(3S) ...................................................................................................... sgemv(3S) .............................................................. 96
sgemv(3S) ...................................................................................................... sgemv(3S) .............................................................. 96
SGER(3S) ........................................................................................................ sger(3S)................................................................. 98
sger(3S) ........................................................................................................ sger(3S)................................................................. 98
sgesl(3S) ...................................................................................................... linpack(3S) ......................................................... 29
SGESUM(3S) .................................................................................................... sgesum(3S) .......................................................... 100
Index-16 004– 2081– 002

sgesum(3S) .................................................................................................... sgesum(3S) .......................................................... 100
sgtsl(3S) ...................................................................................................... linpack(3S) ......................................................... 29
SHAD(3S) ........................................................................................................ shad(3S)................................................................. 52
shad(3S) ........................................................................................................ shad(3S)................................................................. 52
Signal processing ............................................................................................ intro_fft(3S) ................................................... 163
Single-precision real and complex LINPACK routines .................................. linpack(3S) ......................................................... 29
Singular value decomposition ......................................................................... eispack(3S) ......................................................... 23
Singular value decomposition ......................................................................... linpack(3S) ......................................................... 29
SNRM2(3S) ...................................................................................................... snrm2(3S) .............................................................. 54
snrm2(3S) ...................................................................................................... snrm2(3S) .............................................................. 54
Solves a real or complex triangular banded system of equations .................. stbsv(3S) ............................................................ 121
Solves a real or complex triangular packed system of equations .................. stpsv(3S) ............................................................ 126
Solves a real or complex triangular system of equations ............................... strsv(3S) ............................................................ 130
Solves Weiner-Levinson linear equations ....................................................... hopfilt(3S)........................................................ 243
Solves Weiner-Levinson linear equations ....................................................... opfilt(3S) .......................................................... 253
Sparse .............................................................................................................. spdot(3S) .............................................................. 57
Sparse dot product .......................................................................................... spdot(3S) .............................................................. 57
Sparse inner product ....................................................................................... spdot(3S) .............................................................. 57
Sparse vector ................................................................................................... spaxpy(3S) ............................................................ 56
Sparse vector ................................................................................................... spdot(3S) .............................................................. 57
SPAXPY(3S) .................................................................................................... spaxpy(3S) ............................................................ 56
spaxpy(3S) .................................................................................................... spaxpy(3S) ............................................................ 56
spbco(3S) ...................................................................................................... linpack(3S) ......................................................... 29
spbdi(3S) ...................................................................................................... linpack(3S) ......................................................... 29
spbfa(3S) ...................................................................................................... linpack(3S) ......................................................... 29
spbsl(3S) ...................................................................................................... linpack(3S) ......................................................... 29
SPDOT(3S) ...................................................................................................... spdot(3S) .............................................................. 57
spdot(3S) ...................................................................................................... spdot(3S) .............................................................. 57
spoco(3S) ...................................................................................................... linpack(3S) ......................................................... 29
spodi(3S) ...................................................................................................... linpack(3S) ......................................................... 29
spofa(3S) ...................................................................................................... linpack(3S) ......................................................... 29
sposl(3S) ...................................................................................................... linpack(3S) ......................................................... 29
sppco(3S) ...................................................................................................... linpack(3S) ......................................................... 29
sppdi(3S) ...................................................................................................... linpack(3S) ......................................................... 29
sppfa(3S) ...................................................................................................... linpack(3S) ......................................................... 29
sppsl(3S) ...................................................................................................... linpack(3S) ......................................................... 29
sptsl(3S) ...................................................................................................... linpack(3S) ......................................................... 29
sqrdc(3S) ...................................................................................................... linpack(3S) ......................................................... 29
sqrsl(3S) ...................................................................................................... linpack(3S) ......................................................... 29
SROT(3S) ........................................................................................................ srot(3S)................................................................. 58
srot(3S) ........................................................................................................ srot(3S)................................................................. 58
SROTG(3S) ...................................................................................................... srotg(3S) .............................................................. 60
srotg(3S) ...................................................................................................... srotg(3S) .............................................................. 60
SROTM(3S) ...................................................................................................... srotm(3S) .............................................................. 62
srotm(3S) ...................................................................................................... srotm(3S) .............................................................. 62
SROTMG(3S) .................................................................................................... srotmg(3S) ............................................................ 64
srotmg(3S) .................................................................................................... srotmg(3S) ............................................................ 64
SSBMV(3S) ...................................................................................................... ssbmv(3S) ............................................................ 102
ssbmv(3S) ...................................................................................................... ssbmv(3S) ............................................................ 102
SSCAL(3S) ...................................................................................................... sscal(3S) .............................................................. 70
004– 2081– 002 Index-17

sscal(3S) ...................................................................................................... sscal(3S) .............................................................. 70
ssico(3S) ...................................................................................................... linpack(3S) ......................................................... 29
ssidi(3S) ...................................................................................................... linpack(3S) ......................................................... 29
ssifa(3S) ...................................................................................................... linpack(3S) ......................................................... 29
ssisl(3S) ...................................................................................................... linpack(3S) ......................................................... 29
sspco(3S) ...................................................................................................... linpack(3S) ......................................................... 29
sspdi(3S) ...................................................................................................... linpack(3S) ......................................................... 29
sspfa(3S) ...................................................................................................... linpack(3S) ......................................................... 29
SSPMV(3S) ...................................................................................................... sspmv(3S) ............................................................ 104
sspmv(3S) ...................................................................................................... sspmv(3S) ............................................................ 104
SSPR12(3S) .................................................................................................... sspr12(3S) .......................................................... 110
sspr12(3S) .................................................................................................... sspr12(3S) .......................................................... 110
SSPR2(3S) ...................................................................................................... sspr2(3S) ............................................................ 108
sspr2(3S) ...................................................................................................... sspr2(3S) ............................................................ 108
SSPR(3S) ........................................................................................................ sspr(3S)............................................................... 106
sspr(3S) ........................................................................................................ sspr(3S)............................................................... 106
sspsl(3S) ...................................................................................................... linpack(3S) ......................................................... 29
SSUM(3S) ........................................................................................................ ssum(3S)................................................................. 72
ssum(3S) ........................................................................................................ ssum(3S)................................................................. 72
ssvdc(3S) ...................................................................................................... linpack(3S) ......................................................... 29
SSWAP(3S) ...................................................................................................... sswap(3S) .............................................................. 73
sswap(3S) ...................................................................................................... sswap(3S) .............................................................. 73
SSYMM(3S) ...................................................................................................... ssymm(3S) ............................................................ 152
ssymm(3S) ...................................................................................................... ssymm(3S) ............................................................ 152
SSYMV(3S) ...................................................................................................... ssymv(3S) ............................................................ 112
ssymv(3S) ...................................................................................................... ssymv(3S) ............................................................ 112
SSYR2(3S) ...................................................................................................... ssyr2(3S) ............................................................ 116
ssyr2(3S) ...................................................................................................... ssyr2(3S) ............................................................ 116
SSYR2K(3S) .................................................................................................... ssyr2k(3S) .......................................................... 155
ssyr2k(3S) .................................................................................................... ssyr2k(3S) .......................................................... 155
SSYR(3S) ........................................................................................................ ssyr(3S)............................................................... 114
ssyr(3S) ........................................................................................................ ssyr(3S)............................................................... 114
SSYRK(3S) ...................................................................................................... ssyrk(3S) ............................................................ 158
ssyrk(3S) ...................................................................................................... ssyrk(3S) ............................................................ 158
STBMV(3S) ...................................................................................................... stbmv(3S) ............................................................ 118
stbmv(3S) ...................................................................................................... stbmv(3S) ............................................................ 118
STBSV(3S) ...................................................................................................... stbsv(3S) ............................................................ 121
stbsv(3S) ...................................................................................................... stbsv(3S) ............................................................ 121
STPMV(3S) ...................................................................................................... stpmv(3S) ............................................................ 124
stpmv(3S) ...................................................................................................... stpmv(3S) ............................................................ 124
STPSV(3S) ...................................................................................................... stpsv(3S) ............................................................ 126
stpsv(3S) ...................................................................................................... stpsv(3S) ............................................................ 126
strco(3S) ...................................................................................................... linpack(3S) ......................................................... 29
strdi(3S) ...................................................................................................... linpack(3S) ......................................................... 29
STRMM(3S) ...................................................................................................... strmm(3S) ............................................................ 160
strmm(3S) ...................................................................................................... strmm(3S) ............................................................ 160
STRMV(3S) ...................................................................................................... strmv(3S) ............................................................ 128
strmv(3S) ...................................................................................................... strmv(3S) ............................................................ 128
strsl(3S) ...................................................................................................... linpack(3S) ......................................................... 29
STRSV(3S) ...................................................................................................... strsv(3S) ............................................................ 130
Index-18 004– 2081– 002

strsv(3S) ...................................................................................................... strsv(3S) ............................................................ 130
Sums the absolute value of elements in a real or complex vector ................. sasum(3S) .............................................................. 42
Sums the elements of a real or complex vector ............................................. ssum(3S)................................................................. 72
SVD(3S) ........................................................................................................... eispack(3S) ......................................................... 23
svd(3S) ........................................................................................................... eispack(3S) ......................................................... 23
Swapping vectors ............................................................................................ sswap(3S) .............................................................. 73
Swaps two real or complex vectors ................................................................ sswap(3S) .............................................................. 73
Symmetric band matrix ................................................................................... ssbmv(3S) ............................................................ 102
Symmetric coefficient ..................................................................................... filters(3S)........................................................ 225
symmetric filter ............................................................................................... hcorrs(3S) .......................................................... 235
symmetric filter ............................................................................................... scorrs(3S) .......................................................... 330
Symmetric matrix ............................................................................................ sspmv(3S) ............................................................ 104
Symmetric matrix ............................................................................................ sspr(3S)............................................................... 106
Symmetric matrix ............................................................................................ sspr2(3S) ............................................................ 108
Symmetric matrix ............................................................................................ sspr12(3S) .......................................................... 110
Symmetric matrix ............................................................................................ ssymv(3S) ............................................................ 112
Symmetric matrix ............................................................................................ ssyr(3S)............................................................... 114
Symmetric matrix ............................................................................................ ssyr2(3S) ............................................................ 116
Symmetric packed matrix ............................................................................... sspmv(3S) ............................................................ 104
Symmetric packed matrix ............................................................................... sspr(3S)............................................................... 106
Symmetric packed matrix ............................................................................... sspr2(3S) ............................................................ 108
Symmetric packed matrix ............................................................................... sspr12(3S) .......................................................... 110
Symmetric rank 1 update ................................................................................ sspr(3S)............................................................... 106
Symmetric rank 1 update ................................................................................ sspr12(3S) .......................................................... 110
Symmetric rank 1 update ................................................................................ ssyr(3S)............................................................... 114
Symmetric rank 2 update ................................................................................ sspr2(3S) ............................................................ 108
Symmetric rank 2 update ................................................................................ ssyr2(3S) ............................................................ 116
Symmetric rank 2k update (BLAS3) .............................................................. ssyr2k(3S) .......................................................... 155
Symmetric vectors ........................................................................................... filters(3S)........................................................ 225
TINVIT(3S) .................................................................................................... eispack(3S) ......................................................... 23
tinvit(3S) .................................................................................................... eispack(3S) ......................................................... 23
TQL1(3S) ........................................................................................................ eispack(3S) ......................................................... 23
tql1(3S) ........................................................................................................ eispack(3S) ......................................................... 23
TQL2(3S) ........................................................................................................ eispack(3S) ......................................................... 23
tql2(3S) ........................................................................................................ eispack(3S) ......................................................... 23
TQLRAT(3S) .................................................................................................... eispack(3S) ......................................................... 23
tqlrat(3S) .................................................................................................... eispack(3S) ......................................................... 23
TRBAK3(3S) .................................................................................................... eispack(3S) ......................................................... 23
trbak3(3S) .................................................................................................... eispack(3S) ......................................................... 23
TRBAK(3S) ...................................................................................................... eispack(3S) ......................................................... 23
trbak(3S) ...................................................................................................... eispack(3S) ......................................................... 23
TRED1(3S) ...................................................................................................... eispack(3S) ......................................................... 23
tred1(3S) ...................................................................................................... eispack(3S) ......................................................... 23
TRED2(3S) ...................................................................................................... eispack(3S) ......................................................... 23
tred2(3S) ...................................................................................................... eispack(3S) ......................................................... 23
TRED3(3S) ...................................................................................................... eispack(3S) ......................................................... 23
tred3(3S) ...................................................................................................... eispack(3S) ......................................................... 23
Triangular band matrix ................................................................................... stbmv(3S) ............................................................ 118
Triangular banded system of equations .......................................................... stbsv(3S) ............................................................ 121
Triangular matrix ............................................................................................ strmv(3S) ............................................................ 128
004– 2081– 002 Index-19

Triangular matrix ............................................................................................ strmm(3S) ............................................................ 160
Triangular packed matrix ................................................................................ stpmv(3S) ............................................................ 124
Triangular packed system of equations .......................................................... stpsv(3S) ............................................................ 126
Triangular system of equations ....................................................................... strsv(3S) ............................................................ 130
TRIDIB(3S) .................................................................................................... eispack(3S) ......................................................... 23
tridib(3S) .................................................................................................... eispack(3S) ......................................................... 23
TSTURM(3S) .................................................................................................... eispack(3S) ......................................................... 23
tsturm(3S) .................................................................................................... eispack(3S) ......................................................... 23
Vector .............................................................................................................. saxpby(3S) ............................................................ 44
Vector addition ................................................................................................ ssum(3S)................................................................. 72
Vector element addition .................................................................................. sasum(3S) .............................................................. 42
Weiner-Levinson linear equations ................................................................... hopfilt(3S)........................................................ 243
Weiner-Levinson linear equations ................................................................... opfilt(3S) .......................................................... 253
Index-20 004– 2081– 002

004 2081 002 Scientific Libraries Reference Manual Volume 1 Version 3.3 July 1999

Uploaded by

Document Information

Copyright

Available Formats

Share this document

Share or Embed Document

Sharing Options

Did you find this document useful?

Is this content inappropriate?

Copyright:

Available Formats

004 2081 002 Scientific Libraries Reference Manual Volume 1 Version 3.3 July 1999

Uploaded by

Copyright:

Available Formats

Scientific Libraries Reference

T , UV, ;W1XM.ZY[X\02W1K;02,]1;WX^02,]%5_`; T W1%5W Y[X

Scientific Libraries Reference Manual, Volume 1 004–2081–002

º`¨ Ê ÀM¡D ÎR·¹¹é

AÂhÏ8ë'Í5É=ÁìÁÐ ¨Á2SK¢`SV¤îè '3 ¼@£?&K)[¥\)3S¦5KB§BQÎ)'r¦5¦5B B`§

ç5¢`BH¼''Î§BB¡j1KB)^¦5)¡j'¥\`KQm'Î¼'3£A¥\=`¦3)'KB`QÆ1B§BÎ§B& \'mAQ)r ¢`

ç5¢`&8)§B§B)¤VB`£¥\`'1§B ¦5)¡j'¥\`d ¢`V¡D)¥\¼'B§BA[K¢`1L13&1ÆB§ÜÎ§B&¸¾KÃL¾K÷

Man page sections

Áç)ÉHV»HÉ=Ãr»=Á ê'3Æ?B¦5HB`8)A¥\KB)Î'r ¢`V¼@AKÎB§BB Â)r

Áð5ðÉHÍ5ÁÀ Í5BmKQ` BQ`¦Ë¼''Î§BB¡j1KB)`= ¢`b¡D)`KB¸3§BK¦

intro_libsci, INTRO_LIBSCI .......................... Introduction to Scientific Library routines .................................................... 1

Solvers for dense linear systems and eigensystems

Vector-vector linear algebra subprograms

Matrix-vector linear algebra subprograms

004– 2081– 002 ix

Matrix-matrix linear algebra subprograms

Signal processing routines (FFT)

x 004– 2081– 002

004– 2081– 002 xi

xii 004– 2081– 002

004– 2081– 002 1

Under C shell (csh):

The majority of LAPACK routines do perform multitasking.

2 004– 2081– 002

004– 2081– 002 3

4 004– 2081– 002

004– 2081– 002 5

The following are the multitasked Superseded routines:

6 004– 2081– 002

004– 2081– 002 7

8 004– 2081– 002

004– 2081– 002 9

Lists of Available LAPACK Routines

CHESV Solves a complex Hermitian indefinite system of linear equations AX = B.

10 004– 2081– 002

SGELS Finds a least squares or minimum norm solution of an overdetermined or underdetermined

004– 2081– 002 11

SPPSVX Solves a symmetric or Hermitian positive definite system of linear equations AX = B (A is

12 004– 2081– 002

004– 2081– 002 13

14 004– 2081– 002

SGEQRF Computes a QR factorization of a general rectangular matrix.

004– 2081– 002 15

16 004– 2081– 002

SOPMTR Multiplies by the orthogonal/unitary matrix Q from SSPTRD/CHPTRD.

004– 2081– 002 17

18 004– 2081– 002

004– 2081– 002 19

20 004– 2081– 002

004– 2081– 002 21

STRTRI Computes the inverse of a triangular matrix.

22 004– 2081– 002

004– 2081– 002 23

Purpose Matrix or Decomposition Name

Forms eigenvectors by back transforming corresponding Real nonsymmetric tridiagonal BAKVEC

24 004– 2081– 002

Purpose Matrix or Decomposition Name

004– 2081– 002 25

Purpose Matrix or Decomposition Name

Forms eigenvectors by back transforming those of the Real general ORTBAK

26 004– 2081– 002

Purpose Matrix or Decomposition Name

Finds eigenvalues and eigenvectors Real symmetric RS

004– 2081– 002 27

T , UV, ;W1XM.ZY[X\02W1K;02,]1;WX^02,]%5_`; T W1%5W Y[X

º`¨ Ê ÀM¡D ÎR·¹¹é

AÂhÏ8ë'Í5É=ÁìÁÐ ¨Á2SK¢`SV¤îè '3 ¼@£?&K)[¥\)3S¦5KB§BQÎ)'r¦5¦5B B`§

ç5¢`BH¼''Î§BB¡j1KB)^¦5)¡j'¥\`KQm'Î¼'3£A¥\=`¦3)'KB`QÆ1B§BÎ§B& \'mAQ)r ¢`

ç5¢`&8)§B§B)¤VB`£¥\`'1§B ¦5)¡j'¥\`d ¢`V¡D)¥\¼'B§BA[K¢`1L13&1ÆB§ÜÎ§B&¸¾KÃL¾K÷

Áç)ÉHV»HÉ=Ãr»=Á ê'3Æ?B¦5HB`8)A¥\KB)Î'r ¢`V¼@AKÎB§BB Â)r

Áð5ðÉHÍ5ÁÀ Í5BmKQ` BQ`¦Ë¼''Î§BB¡j1KB)`= ¢`b¡D)`KB¸3§BK¦