.TH "nrm2" 3 "Wed Feb 7 2024 11:30:40" "Version 3.12.0" "LAPACK" \" -*- nroff -*- .ad l .nh .SH NAME nrm2 \- nrm2: || x ||_2 .SH SYNOPSIS .br .PP .SS "Functions" .in +1c .ti -1c .RI "real(wp) function \fBdnrm2\fP (n, x, incx)" .br .RI "\fBDNRM2\fP " .ti -1c .RI "real(wp) function \fBdznrm2\fP (n, x, incx)" .br .RI "\fBDZNRM2\fP " .ti -1c .RI "real(wp) function \fBscnrm2\fP (n, x, incx)" .br .RI "\fBSCNRM2\fP " .ti -1c .RI "real(wp) function \fBsnrm2\fP (n, x, incx)" .br .RI "\fBSNRM2\fP " .in -1c .SH "Detailed Description" .PP .SH "Function Documentation" .PP .SS "real(wp) function dnrm2 (integer n, real(wp), dimension(*) x, integer incx)" .PP \fBDNRM2\fP .PP \fBPurpose:\fP .RS 4 .PP .nf DNRM2 returns the euclidean norm of a vector via the function name, so that DNRM2 := sqrt( x'*x ) .fi .PP .RE .PP \fBParameters\fP .RS 4 \fIN\fP .PP .nf N is INTEGER number of elements in input vector(s) .fi .PP .br \fIX\fP .PP .nf X is DOUBLE PRECISION array, dimension ( 1 + ( N - 1 )*abs( INCX ) ) .fi .PP .br \fIINCX\fP .PP .nf INCX is INTEGER, storage spacing between elements of X If INCX > 0, X(1+(i-1)*INCX) = x(i) for 1 <= i <= n If INCX < 0, X(1-(n-i)*INCX) = x(i) for 1 <= i <= n If INCX = 0, x isn't a vector so there is no need to call this subroutine\&. If you call it anyway, it will count x(1) in the vector norm N times\&. .fi .PP .RE .PP \fBAuthor\fP .RS 4 Edward Anderson, Lockheed Martin .RE .PP \fBDate\fP .RS 4 August 2016 .RE .PP \fBContributors:\fP .RS 4 Weslley Pereira, University of Colorado Denver, USA .RE .PP \fBFurther Details:\fP .RS 4 .PP .nf Anderson E\&. (2017) Algorithm 978: Safe Scaling in the Level 1 BLAS ACM Trans Math Softw 44:1--28 https://doi\&.org/10\&.1145/3061665 Blue, James L\&. (1978) A Portable Fortran Program to Find the Euclidean Norm of a Vector ACM Trans Math Softw 4:15--23 https://doi\&.org/10\&.1145/355769\&.355771 .fi .PP .RE .PP .SS "real(wp) function dznrm2 (integer n, complex(wp), dimension(*) x, integer incx)" .PP \fBDZNRM2\fP .PP \fBPurpose:\fP .RS 4 .PP .nf DZNRM2 returns the euclidean norm of a vector via the function name, so that DZNRM2 := sqrt( x**H*x ) .fi .PP .RE .PP \fBParameters\fP .RS 4 \fIN\fP .PP .nf N is INTEGER number of elements in input vector(s) .fi .PP .br \fIX\fP .PP .nf X is COMPLEX*16 array, dimension (N) complex vector with N elements .fi .PP .br \fIINCX\fP .PP .nf INCX is INTEGER, storage spacing between elements of X If INCX > 0, X(1+(i-1)*INCX) = x(i) for 1 <= i <= n If INCX < 0, X(1-(n-i)*INCX) = x(i) for 1 <= i <= n If INCX = 0, x isn't a vector so there is no need to call this subroutine\&. If you call it anyway, it will count x(1) in the vector norm N times\&. .fi .PP .RE .PP \fBAuthor\fP .RS 4 Edward Anderson, Lockheed Martin .RE .PP \fBDate\fP .RS 4 August 2016 .RE .PP \fBContributors:\fP .RS 4 Weslley Pereira, University of Colorado Denver, USA .RE .PP \fBFurther Details:\fP .RS 4 .PP .nf Anderson E\&. (2017) Algorithm 978: Safe Scaling in the Level 1 BLAS ACM Trans Math Softw 44:1--28 https://doi\&.org/10\&.1145/3061665 Blue, James L\&. (1978) A Portable Fortran Program to Find the Euclidean Norm of a Vector ACM Trans Math Softw 4:15--23 https://doi\&.org/10\&.1145/355769\&.355771 .fi .PP .RE .PP .SS "real(wp) function scnrm2 (integer n, complex(wp), dimension(*) x, integer incx)" .PP \fBSCNRM2\fP .PP \fBPurpose:\fP .RS 4 .PP .nf SCNRM2 returns the euclidean norm of a vector via the function name, so that SCNRM2 := sqrt( x**H*x ) .fi .PP .RE .PP \fBParameters\fP .RS 4 \fIN\fP .PP .nf N is INTEGER number of elements in input vector(s) .fi .PP .br \fIX\fP .PP .nf X is COMPLEX array, dimension (N) complex vector with N elements .fi .PP .br \fIINCX\fP .PP .nf INCX is INTEGER, storage spacing between elements of X If INCX > 0, X(1+(i-1)*INCX) = x(i) for 1 <= i <= n If INCX < 0, X(1-(n-i)*INCX) = x(i) for 1 <= i <= n If INCX = 0, x isn't a vector so there is no need to call this subroutine\&. If you call it anyway, it will count x(1) in the vector norm N times\&. .fi .PP .RE .PP \fBAuthor\fP .RS 4 Edward Anderson, Lockheed Martin .RE .PP \fBDate\fP .RS 4 August 2016 .RE .PP \fBContributors:\fP .RS 4 Weslley Pereira, University of Colorado Denver, USA .RE .PP \fBFurther Details:\fP .RS 4 .PP .nf Anderson E\&. (2017) Algorithm 978: Safe Scaling in the Level 1 BLAS ACM Trans Math Softw 44:1--28 https://doi\&.org/10\&.1145/3061665 Blue, James L\&. (1978) A Portable Fortran Program to Find the Euclidean Norm of a Vector ACM Trans Math Softw 4:15--23 https://doi\&.org/10\&.1145/355769\&.355771 .fi .PP .RE .PP .SS "real(wp) function snrm2 (integer n, real(wp), dimension(*) x, integer incx)" .PP \fBSNRM2\fP .PP \fBPurpose:\fP .RS 4 .PP .nf SNRM2 returns the euclidean norm of a vector via the function name, so that SNRM2 := sqrt( x'*x )\&. .fi .PP .RE .PP \fBParameters\fP .RS 4 \fIN\fP .PP .nf N is INTEGER number of elements in input vector(s) .fi .PP .br \fIX\fP .PP .nf X is REAL array, dimension ( 1 + ( N - 1 )*abs( INCX ) ) .fi .PP .br \fIINCX\fP .PP .nf INCX is INTEGER, storage spacing between elements of X If INCX > 0, X(1+(i-1)*INCX) = x(i) for 1 <= i <= n If INCX < 0, X(1-(n-i)*INCX) = x(i) for 1 <= i <= n If INCX = 0, x isn't a vector so there is no need to call this subroutine\&. If you call it anyway, it will count x(1) in the vector norm N times\&. .fi .PP .RE .PP \fBAuthor\fP .RS 4 Edward Anderson, Lockheed Martin .RE .PP \fBDate\fP .RS 4 August 2016 .RE .PP \fBContributors:\fP .RS 4 Weslley Pereira, University of Colorado Denver, USA .RE .PP \fBFurther Details:\fP .RS 4 .PP .nf Anderson E\&. (2017) Algorithm 978: Safe Scaling in the Level 1 BLAS ACM Trans Math Softw 44:1--28 https://doi\&.org/10\&.1145/3061665 Blue, James L\&. (1978) A Portable Fortran Program to Find the Euclidean Norm of a Vector ACM Trans Math Softw 4:15--23 https://doi\&.org/10\&.1145/355769\&.355771 .fi .PP .RE .PP .SH "Author" .PP Generated automatically by Doxygen for LAPACK from the source code\&.