1$TEMPLATE[blas.qbk]
2[/
3
4THIS FILE IS AUTOMATICALLY GENERATED, PLEASE DO NOT EDIT!
5
6]
7
8[section $groupname]
9
10[heading Prototype]
11There $PROTOTYPE_OVERLOADS `$groupname` available, please see below.
12$PROTOTYPES
13
14[heading Description]
15
16`$groupname` (short for $FRIENDLY_NAME) provides a C++
17interface to BLAS routines $SUBROUTINES.
18$PURPOSE
19
20The selection of the BLAS routine is done during compile-time,
21and is determined by the type of values contained in type `$FIRST_TYPENAME`.
22The type of values is obtained through the `value_type` meta-function
23 `typename value_type<$FIRST_TYPENAME>::type`.
24Table X below illustrates to which specific routine this dispatching will take place.
25
26[table Dispatching of $groupname.
27$DISPATCH_TABLE
28]
29
30The original routines $SUBROUTINES have $NO_ARGUMENTS_LEVEL0 arguments,
31whereas `$groupname` requires $NO_ARGUMENTS_LEVEL2 arguments.
32
33[table Deduction of arguments of $groupname.
34]
35
36[heading Definition]
37Defined in header [headerref $header].
38
39[heading Parameters or Requirements on Types]
40
41[variablelist Parameters
42    [[MatrixA] [The definition of term 1]]
43    [[MatrixB] [The definition of term 2]]
44    [[MatrixC] [
45    The definition of term 3.
46
47    Definitions may contain paragraphs.
48    ]]
49]
50
51[heading Complexity]
52
53[heading Example]
54``
55#include <$header>
56using namespace boost::numeric::bindings;
57
58blas::$groupname( x, y, z );
59
60``
61
62this will output
63
64``
65[5] 0 1 2 3 4 5
66``
67
68[heading Notes]
69
70[heading See Also]
71
72* Originating Fortran source files $ORIGINATING_SOURCES at Netlib.
73
74[endsect]
75$TEMPLATE[blas_prototype.qbk]
76``
77$groupname( $LEVEL2 );
78``
79$TEMPLATE[end]
80