matpow.h File Reference

Sparse $A^k\cdot x$ implementation. More...

#include <oski/matmult.h>

Go to the source code of this file.

Data Structures

struct  oski_traceargs_MatPowMult_t
 Trace argument signature for oski_MatPowMult(). More...

Defines

#define INC_OSKI_MATPOW_H
 oski/matpow.h included.
#define GET_XFLOP_MatPowMult(args)
 Compute the "flop factor.".
Name mangling.
#define oski_MatPowMult_funcpt   MANGLE_(oski_MatPowMult_funcpt)
#define oski_MatReprPowMult_funcpt   MANGLE_(oski_MatReprPowMult_funcpt)
#define oski_CheckArgsMatPowMult   MANGLE_(oski_CheckArgsMatPowMult)
#define oski_MatPowMult   MANGLE_(oski_MatPowMult)
#define oski_traceargs_MatPowMult_t   MANGLE_(oski_traceargs_MatPowMult_t)
#define oski_MakeArglistMatPowMult   MANGLE_(oski_MakeArglistMatPowMult)

Typedefs

typedef int(* oski_MatPowMult_funcpt )(const oski_matrix_t A_tunable, oski_matop_t opA, int power, oski_value_t alpha, const oski_vecview_t x_view, oski_value_t beta, oski_vecview_t y_view, oski_vecview_t T_view)
 Function pointer type for oski_MatPowMult().
typedef int(* oski_MatReprPowMult_funcpt )(const void *A, const oski_matcommon_t *props, oski_matop_t opA, int power, oski_value_t alpha, const oski_vecview_t x_view, oski_value_t beta, oski_vecview_t y_view, oski_vecview_t T_view)
 Function pointer type for a matrix type-specific implementation of oski_MatPowMult().

Functions

int oski_MatPowMult (const oski_matrix_t A_tunable, oski_matop_t opA, int power, oski_value_t alpha, const oski_vecview_t x_view, oski_value_t beta, oski_vecview_t y_view, oski_vecview_t T_view)
 Computes a power of a matrix times a vector, or $y \leftarrow \alpha\cdot\mathrm{op}(A)^\rho x + \beta\cdot y$.
int oski_CheckArgsMatPowMult (const oski_matrix_t A_tunable, oski_matop_t opA, int power, oski_value_t alpha, const oski_vecview_t x_view, oski_value_t beta, oski_vecview_t y_view, oski_vecview_t T_view, const char *caller)
 Check arguments passed to oski_MatPowMult().
void oski_MakeArglistMatPowMult (oski_matop_t op, int power, oski_value_t alpha, const oski_vecview_t x_view, oski_value_t beta, const oski_vecview_t y_view, const oski_vecview_t T_view, oski_traceargs_MatPowMult_t *args)
 Initialize a static argument signature for a call to oski_MatPowMult().


Detailed Description

Sparse $A^k\cdot x$ implementation.


Define Documentation

#define GET_XFLOP_MatPowMult ( args   ) 

Value:

(2.0 * ((const oski_traceargs_MatPowMult_t *)(args))->num_vecs \
         * ((const oski_traceargs_MatPowMult_t *)(args))->power)
Compute the "flop factor.".

Referenced by DumpTrace().

#define INC_OSKI_MATPOW_H

oski/matpow.h included.


Function Documentation

int oski_CheckArgsMatPowMult ( const oski_matrix_t  A_tunable,
oski_matop_t  opA,
int  power,
oski_value_t  alpha,
const oski_vecview_t  x_view,
oski_value_t  beta,
const oski_vecview_t  y_view,
const oski_vecview_t  T_view,
const char *  caller 
)

Check arguments passed to oski_MatPowMult().

Returns:
0 if all arguments are OK, or an error code (plus a call to the error handler) otherwise.
Todo:
Need more verbose error messages in the event that the vectors have improper dimensions.

References ERR_BAD_ARG, ERR_BAD_MAT, ERR_BAD_VECVIEW, INVALID_MAT, INVALID_VEC, MACRO_TO_STRING, oski_vecstruct_t::num_cols, oski_matcommon_t::num_rows, oski_vecstruct_t::num_rows, OSKI_CHECK_MATOP, OSKI_ERR_BAD_MAT_MS, OSKI_ERR_BAD_MATOP_MS, OSKI_ERR_BAD_POWER_MS, OSKI_ERR_BAD_VEC_MS, OSKI_ERR_MAT_NOTSQUARE_MS, OSKI_ERR_VEC1_ONLY, OSKI_ERR_VEC_FEW_MS, OSKI_MATPROP_IS_SQUARE, and oski_matstruct_t::props.


Generated on Fri Apr 8 22:35:19 2011 for BeBOP Optimized Sparse Kernel Interface Library by  doxygen 1.5.9