scamac_statistics.h

Go to the documentation of this file.

#ifndef SCAMAC_STATISTICS_H
#define SCAMAC_STATISTICS_H

#include "scamac_generator.h"

typedef struct {
  // matrix data
  ScamacIdx nrow,ncol;
  // number of rows incorporated into the statistics so far
  ScamacIdx ncontributed;
  // valtype
  int valtype;

  // pattern statistics
  ScamacIdx n_nz;
  ScamacIdx n_nz_left, n_nz_right;
  ScamacIdx n_nz_row_min, n_nz_row_max;
  ScamacIdx n_nz_row_max_left, n_nz_row_max_right; // only max - min always = 0
  ScamacIdx n_zero_row, n_zero_diag;
  // bandwidth
  ScamacIdx bw_left,bw_right;

  // value statistics
  double v_min_re,v_max_re;
  double v_min_im,v_max_im;
  double v_abs;
  double v_min_re_diag,v_max_re_diag;
  double v_min_im_diag,v_max_im_diag;
  double v_abs_diag;
  // number of diagonally dominant rows
  ScamacIdx n_diag_dominant;
  // minimal |diag|-sum |offdiag|. Positive if and only if all rows are diagonally dominant
  double diag_minus_offdiag;

  // spectral statistics
  double gershgorin_min_re, gershgorin_max_re, gershgorin_min_im, gershgorin_max_im;

} scamac_matrix_statistics_st;

typedef struct {
  // matrix data
  ScamacIdx nrow, ncol;
  // pattern size
  int px,py;
  // number of rows incorporated into the pattern so far
  ScamacIdx ncontributed;
  // the pattern (array dimension px * py)
  ScamacIdx * pat;
} scamac_matrix_pattern_st;

ScamacErrorCode scamac_collect_statistics_and_pattern(const ScamacGenerator * gen, ScamacFlag flag, scamac_matrix_statistics_st * st, scamac_matrix_pattern_st ** pt);

ScamacErrorCode scamac_statistics_empty  (scamac_matrix_statistics_st * st, ScamacIdx nrow, ScamacIdx ncol, int valtype);
ScamacErrorCode scamac_statistics_update (scamac_matrix_statistics_st * st, ScamacIdx irow, ScamacIdx nzr, const ScamacIdx * cind, const double * val);
ScamacErrorCode scamac_statistics_combine(scamac_matrix_statistics_st * stcomb, const scamac_matrix_statistics_st * st);
ScamacErrorCode scamac_statistics_print  (const scamac_matrix_statistics_st * st, char ** desc);


ScamacErrorCode scamac_pattern_alloc  (int px, int py, scamac_matrix_pattern_st ** pt);
ScamacErrorCode scamac_pattern_empty  (scamac_matrix_pattern_st * pt, ScamacIdx nrow, ScamacIdx ncol, int valtype);
ScamacErrorCode scamac_pattern_update (scamac_matrix_pattern_st * pt, ScamacIdx irow, ScamacIdx nzr, const ScamacIdx * cind);
ScamacErrorCode scamac_pattern_combine(scamac_matrix_pattern_st * ptcomb, const scamac_matrix_pattern_st * pt);
ScamacErrorCode scamac_pattern_print  (const scamac_matrix_pattern_st * pt, char ** desc);
ScamacErrorCode scamac_pattern_free   (scamac_matrix_pattern_st * pt);

#endif /* SCAMAC_STATISTICS_H */