nrm2

Prototype

There is one prototype of nrm2 available, please see below.

nrm2( const VectorX& x );

Description

nrm2 (short for TODO) provides a C++ interface to BLAS routines SNRM2, DNRM2, SCNRM2, and DZNRM2.

The selection of the BLAS routine is done during compile-time, and is determined by the type of values contained in type VectorX. The type of values is obtained through the value_type meta-function typename value_type<VectorX>::type. Table X below illustrates to which specific routine this dispatching will take place.

Table 1.16. Dispatching of nrm2.

Value type of VectorX	BLAS routine	CBLAS routine	CUBLAS routine
`float`	SNRM2	cblas_snrm2	cublasSnrm2
`double`	DNRM2	cblas_dnrm2	cublasDnrm2
`complex<float>`	SCNRM2	cblas_scnrm2	cublasScnrm2
`complex<double>`	DZNRM2	cblas_dznrm2	Unavailable

The original routines SNRM2, DNRM2, SCNRM2, and DZNRM2 have three arguments, whereas nrm2 requires one arguments.

Table 1.17. Deduction of arguments of nrm2.

Definition

Defined in header boost/numeric/bindings/blas/level1/nrm2.hpp.

Parameters or Requirements on Types

Parameters

MatrixA

The definition of term 1

MatrixB

The definition of term 2

MatrixC

The definition of term 3.

Definitions may contain paragraphs.

Complexity

Example

#include <boost/numeric/bindings/blas/level1/nrm2.hpp>
using namespace boost::numeric::bindings;

blas::nrm2( x, y, z );

this will output

[5] 0 1 2 3 4 5