rotg

Prototype

There are two prototypes of rotg available, please see below.

rotg( Scalar >, Scalar >, Scalar >, Scalar > );

rotg( Scalar& a, Scalar& b, Scalar >, Scalar& s );

Description

rotg (short for TODO) provides a C++ interface to BLAS routines SROTG, DROTG, CROTG, and ZROTG.

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

Table 1.20. Dispatching of rotg.

Value type of $FIRST_TYPENAME	BLAS routine	CBLAS routine	CUBLAS routine
`float`	SROTG	cblas_srotg	cublasSrotg
`double`	DROTG	cblas_drotg	cublasDrotg
`complex<float>`	CROTG	Unavailable	Unavailable
`complex<double>`	ZROTG	Unavailable	Unavailable

The original routines SROTG, DROTG, CROTG, and ZROTG have four arguments, whereas rotg requires four arguments.

Table 1.21. Deduction of arguments of rotg.

Definition

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

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

this will output

[5] 0 1 2 3 4 5