ʻOhana
Population structure, admixture history, and selection using learning methods.
Public Types | Static Public Member Functions
jade::basic_blas< TValue > Class Template Reference

A template for a class providing access to BLAS. More...

#include <jade.blas.hpp>

+ Collaboration diagram for jade::basic_blas< TValue >:

Public Types

typedef TValue value_type
 The value type. More...
 
typedef CBLAS_ORDER layout_type
 A type indicating whether the elements of a matrix are in row-major or column-major order. More...
 
typedef CBLAS_TRANSPOSE transpose_type
 A type indicating a kind of transpose operation to perform on a matrix. More...
 

Static Public Member Functions

static value_type dot (const int n, const value_type *x, const int incx, const value_type *y, const int incy)
 Computes a vector-vector dot product. More...
 
static void gemm (const layout_type Order, const transpose_type TransA, const transpose_type TransB, const int M, const int N, const int K, const value_type alpha, const value_type *A, const int lda, const value_type *B, const int ldb, const value_type beta, value_type *C, const int ldc)
 Computes a matrix-matrix product with general matrices. More...
 
static void gemv (const layout_type order, const transpose_type trans, const int m, const int n, const value_type alpha, const value_type *a, const int lda, const value_type *x, const int incx, const value_type beta, value_type *y, const int incy)
 Computes a matrix-vector product using a general matrix. More...
 

Detailed Description

template<typename TValue>
class jade::basic_blas< TValue >

A template for a class providing access to BLAS.

Definition at line 18 of file jade.blas.hpp.

Member Typedef Documentation

◆ layout_type

template<typename TValue >
typedef CBLAS_ORDER jade::basic_blas< TValue >::layout_type

A type indicating whether the elements of a matrix are in row-major or column-major order.

Definition at line 26 of file jade.blas.hpp.

◆ transpose_type

template<typename TValue >
typedef CBLAS_TRANSPOSE jade::basic_blas< TValue >::transpose_type

A type indicating a kind of transpose operation to perform on a matrix.

Definition at line 30 of file jade.blas.hpp.

◆ value_type

template<typename TValue >
typedef TValue jade::basic_blas< TValue >::value_type

The value type.

Definition at line 22 of file jade.blas.hpp.

Member Function Documentation

◆ dot()

template<typename TValue >
static value_type jade::basic_blas< TValue >::dot ( const int  n,
const value_type x,
const int  incx,
const value_type y,
const int  incy 
)
static

Computes a vector-vector dot product.

Returns
The result of the dot product of x and y, if n is positive. Otherwise, returns 0.
Parameters
nThe number of elements.
xThe X array.
incxThe X increment.
yThe Y array.
incyThe Y increment.

◆ gemm()

template<typename TValue >
static void jade::basic_blas< TValue >::gemm ( const layout_type  Order,
const transpose_type  TransA,
const transpose_type  TransB,
const int  M,
const int  N,
const int  K,
const value_type  alpha,
const value_type A,
const int  lda,
const value_type B,
const int  ldb,
const value_type  beta,
value_type C,
const int  ldc 
)
static

Computes a matrix-matrix product with general matrices.

Parameters
OrderThe order.
TransATranspose A.
TransBTranspose B.
MRows of A.
NColumns of B.
KThe order.
alphaAlpha scalar.
AA matrix.
ldaStride of A.
BB matrix.
ldbStride of B.
betaBeta scalar.
CC matrix.
ldcStride of C.
+ Here is the caller graph for this function:

◆ gemv()

template<typename TValue >
static void jade::basic_blas< TValue >::gemv ( const layout_type  order,
const transpose_type  trans,
const int  m,
const int  n,
const value_type  alpha,
const value_type a,
const int  lda,
const value_type x,
const int  incx,
const value_type  beta,
value_type y,
const int  incy 
)
static

Computes a matrix-vector product using a general matrix.

Parameters
orderThe layout.
transTranspose.
mRows of A.
nColumns of A.
alphaAlpha scalar.
aA matrix.
ldaStride of A.
xX vector.
incxStride of X.
betaBeta scalar.
yY vector.
incyStride of Y.

The documentation for this class was generated from the following file: