NAG CPP Interface
nagcpp::blas::dlange (f06ra)

1 Purpose

2 Specification

#include "f06/nagcpp_f06ra.hpp"

template <typename A>

double dlange(const string norm, const A &a, OptionalF06RA opt)

template <typename A>

double dlange(const string norm, const A &a)

3 Description

4 References

5 Arguments

1: $\mathbf{norm}$ – string Input

On entry: specifies the value to be returned.

$\mathbf{norm}=\text{'1'}$ or $\text{'O'}$

The $1$-norm.

$\mathbf{norm}=\text{'I'}$

The $\infty$-norm.

$\mathbf{norm}=\text{'F'}$ or $\text{'E'}$

The Frobenius (or Euclidean) norm.

$\mathbf{norm}=\text{'M'}$

The value ${\displaystyle \underset{i,j}{\max }}\left|a_{ij}\right|$ (not a norm).

Constraint: $\mathbf{norm}=\text{'1'}$, $\text{'O'}$, $\text{'I'}$, $\text{'F'}$, $\text{'E'}$ or $\text{'M'}$.

2: $\mathbf{a}(\mathbf{m},\mathbf{n})$ – double array Input

On entry: the $m\times n$ matrix $A$.

3: $\mathbf{opt}$ – OptionalF06RA Input/Output

Optional parameter container, derived from Optional.

6 Exceptions and Warnings

Raises: ErrorException

$\mathbf{errorid}=1$

On entry, error in parameter norm.
Constraint: $\mathbf{norm}=\text{"1"},\text{"O"},\text{"I"},\text{"F"},\text{"E"}\text{ or }\text{"M"}$.

$\mathbf{errorid}=2$

On entry, error in parameter $\mathbf{m}$.
Constraint: $\mathbf{m}\ge 0$.

$\mathbf{errorid}=3$

On entry, error in parameter $\mathbf{n}$.
Constraint: $\mathbf{n}\ge 0$.

$\mathbf{errorid}=10601$

On entry, argument $⟨\mathit{\text{value}}⟩$ must be a $⟨\mathit{\text{value}}⟩$ x $⟨\mathit{\text{value}}⟩$ array.
Supplied argument has $⟨\mathit{\text{value}}⟩$ dimensions.

$\mathbf{errorid}=10601$

On entry, argument $⟨\mathit{\text{value}}⟩$ must be a $⟨\mathit{\text{value}}⟩$ x $⟨\mathit{\text{value}}⟩$ array.
Supplied argument was a $⟨\mathit{\text{value}}⟩$ x $⟨\mathit{\text{value}}⟩$ array.

$\mathbf{errorid}=10601$

On entry, argument $⟨\mathit{\text{value}}⟩$ must be a $⟨\mathit{\text{value}}⟩$ x $⟨\mathit{\text{value}}⟩$ array.
Not all of the sizes for the supplied array could be ascertained.

$\mathbf{errorid}=10602$

On entry, the raw data component of $⟨\mathit{\text{value}}⟩$ is null.

$\mathbf{errorid}=10603$

On entry, unable to ascertain a value for $⟨\mathit{\text{value}}⟩$.

$\mathbf{errorid}=10604$

On entry, the data in $⟨\mathit{\text{value}}⟩$ is stored in $⟨\mathit{\text{value}}⟩$ Major Order.
The data was expected to be in $⟨\mathit{\text{value}}⟩$ Major Order.

$\mathbf{errorid}=\mathrm{-99}$

An unexpected error has been triggered by this routine.

$\mathbf{errorid}=\mathrm{-999}$

Dynamic memory allocation failed.

7 Accuracy

8 Parallelism and Performance

9 Further Comments

10 Example