asum

Prototype

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

asum( const VectorX& x );

Description

asum (short for absolute sum) provides a C++ interface to BLAS routines SASUM, DASUM, SCASUM, and DZASUM.

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.4. Dispatching of asum.

Value type of VectorX	BLAS routine	CBLAS routine	CUBLAS routine
`float`	SASUM	cblas_sasum	cublasSasum
`double`	DASUM	cblas_dasum	cublasDasum
`complex<float>`	SCASUM	cblas_scasum	cublasScasum
`complex<double>`	DZASUM	cblas_dzasum	Unavailable

The original routines SASUM, DASUM, SCASUM, and DZASUM have three arguments, whereas asum requires one arguments.

Table 1.5. Deduction of arguments of asum.

Definition

Defined in header boost/numeric/bindings/blas/level1/asum.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/asum.hpp>
using namespace boost::numeric::bindings;

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

this will output

[5] 0 1 2 3 4 5