matrix.h

Go to the documentation of this file.

#if !defined(INC_OSKI_MATRIX_H) && !defined(OSKI_UNBIND)

#define INC_OSKI_MATRIX_H

#include <oski/common.h>
#include <oski/matcommon.h>
#include <oski/structhint.h>
#include <oski/trace.h>

#if defined(DO_NAME_MANGLING)

#define oski_matstruct_t    MANGLE_(oski_matstruct_t)
#define oski_matrix_t       MANGLE_(oski_matrix_t)
#define const_oski_matrix_t      MANGLE_(const_oski_matrix_t)

#define oski_CreateMatStruct  MANGLE_(oski_CreateMatStruct)
#define oski_DestroyMatStruct MANGLE_(oski_DestroyMatStruct)

#endif

typedef struct
{
  oski_matcommon_t props;   
  oski_matspecific_t input_mat;        
  int is_shared;    
  double time_stream;        
  oski_structhint_t structhints;    
  oski_trace_t workhints;          
  oski_trace_t trace;          
  oski_timer_t timer;          
  oski_matspecific_t tuned_mat;        
  char *tuned_xforms;       
}
oski_matstruct_t;

typedef oski_matstruct_t *oski_matrix_t;

typedef const oski_matstruct_t *const_oski_matrix_t;

oski_matstruct_t *oski_CreateMatStruct (void);

void oski_DestroyMatStruct (oski_matstruct_t * A);

/* -------------------------------------------------------
 *  Diagnostics.
 */

#define OSKI_CHECK_MAT_DIMS( m, n )   (((m) >= 0) && ((n) >= 0))

#define OSKI_IS_SQUARE_MAT( m, n )  ((m) == (n))

/* -------------------------------------------------------
 *  The matrix type module interface.
 */

#include <oski/CSR/format.h>

#if defined(DO_NAME_MANGLING)

#define oski_DestroyMatRepr_funcpt \
    MANGLE_(oski_DestroyMatRepr_funcpt)
#define oski_CreateMatReprFromCSR_funcpt \
    MANGLE_(oski_CreateMatReprFromCSR_funcpt)
#define oski_CreateSubmatReprFromCSR_funcpt \
    MANGLE_(oski_CreateSubmatReprFromCSR_funcpt)
#define oski_CopyMatRepr_funcpt \
    MANGLE_(oski_CopyMatRepr_funcpt)
#define oski_CalcMatRepr1Norm_funcpt \
    MANGLE_(oski_CalcMatRepr1Norm_funcpt)
#define oski_ConvertMatReprToCSR_funcpt \
        MANGLE_(oski_ConvertMatReprToCSR_funcpt)

#define tagOski_submat_t MANGLE_(tagOski_submat_t)
#define oski_submat_t    MANGLE_(oski_submat_t)

#endif

typedef struct tagOski_submat_t
{
  oski_index_t i0;    
  oski_index_t j0;    
  oski_index_t num_rows;    
  oski_index_t num_cols;    
}
oski_submat_t;

typedef void (*oski_DestroyMatRepr_funcpt) (void *mat);

#if 1
typedef void *(*oski_CreateMatReprFromCSR_funcpt) (const oski_matCSR_t * mat,
                           const oski_matcommon_t *
                           props, ...);
#endif

typedef void *(*oski_CreateSubmatReprFromCSR_funcpt) (const oski_matCSR_t *
                              mat,
                              const oski_matcommon_t *
                              props,
                              const oski_submat_t *
                              sub, ...);

typedef oski_matCSR_t *(*oski_ConvertMatReprToCSR_funcpt) (const void *,
                               const
                               oski_matcommon_t *
                               props);

typedef void *(*oski_CopyMatRepr_funcpt) (const void *,
                      const oski_matcommon_t * props);

typedef double (*oski_CalcMatRepr1Norm_funcpt) (const void *mat,
                        const oski_matcommon_t *
                        props);

/* ----- Generic (matrix type-independent) kernel implementations ----- */

#include <oski/matmult.h>
#include <oski/ata.h>
#include <oski/trisolve.h>
#include <oski/a_and_at.h>
#include <oski/matpow.h>

#endif /* !defined(INC_OSKI_MATRIX_H) */

#if defined(OSKI_UNBIND)
#  include <oski/matcommon.h>
#  include <oski/trace.h>
#  include <oski/CSR/format.h>
#  undef INC_OSKI_MATRIX_H
#  undef oski_matstruct_t
#  undef oski_matrix_t
#  undef const_oski_matrix_t
#  undef oski_CreateMatStruct
#  undef oski_DestroyMatStruct
#  undef OSKI_CHECK_MAT_DIMS
#  undef OSKI_IS_SQUARE_MAT
#  undef oski_DestroyMatRepr_funcpt
#  undef oski_CreateMatReprFromCSR_funcpt
#  undef oski_CreateSubmatReprFromCSR_funcpt
#  undef oski_CopyMatRepr_funcpt
#  undef oski_CalcMatRepr1Norm_funcpt
#  undef tagOski_submat_t
#  undef oski_submat_t
#endif

/* eof */

---