csrcnv.c

/*!
\file  
\brief A simple program to convert between different matrix formats that are supported
       by the gk_csr_Read/gk_csr_Write functions.

\date 5/30/2013
\author George
\version \verbatim $Id: csrcnv.c 15314 2013-10-05 16:50:50Z karypis $ \endverbatim
*/

#include <GKlib.h>

/*************************************************************************/
/*! Data structures for the code */
/*************************************************************************/
typedef struct {
  int inf, outf;    /* input/output format */
  int numbering;    /* input numbering (output when applicable) */
  int readvals;     /* input values (output when applicable) */
  int writevals;    /* output values */
  int rshuf, cshuf; /* random shuffle of rows/columns */
  int symmetric;    /* a symmetric shuffle */
  int mincolfreq;   /* column prunning */
  int maxcolfreq;   /* column prunning */
  int minrowfreq;   /* row prunning */
  int maxrowfreq;   /* row prunning */
  float rownrmfltr; /* row-lowfilter threshold */
  int compactcols;  /* if to renumber columns to eliminate empty ones */
  int transpose;    /* transpose the output matrix */
  char *infile;     /* input file */
  char *outfile;    /* output file */
} params_t;


/*************************************************************************/
/*! Constants */
/*************************************************************************/
#define CMD_NUMONE        1
#define CMD_NOREADVALS    2
#define CMD_NOWRITEVALS   3
#define CMD_RSHUF         4
#define CMD_CSHUF         5
#define CMD_SYMMETRIC     6
#define CMD_MINCOLFREQ    7
#define CMD_MAXCOLFREQ    8
#define CMD_MINROWFREQ    9
#define CMD_MAXROWFREQ    10
#define CMD_ROWNRMFLTR    11
#define CMD_COMPACTCOLS   12
#define CMD_TRANSPOSE     13
#define CMD_HELP          100


/*************************************************************************/
/*! Local variables */
/*************************************************************************/
static struct gk_option long_options[] = {
  {"numone",      0,      0,      CMD_NUMONE},
  {"noreadvals",  0,      0,      CMD_NOREADVALS},
  {"nowritevals", 0,      0,      CMD_NOWRITEVALS},
  {"rshuf",       0,      0,      CMD_RSHUF},
  {"cshuf",       0,      0,      CMD_CSHUF},
  {"symmetric",   0,      0,      CMD_SYMMETRIC},
  {"mincolfreq",  1,      0,      CMD_MINCOLFREQ},
  {"maxcolfreq",  1,      0,      CMD_MAXCOLFREQ},
  {"minrowfreq",  1,      0,      CMD_MINROWFREQ},
  {"maxrowfreq",  1,      0,      CMD_MAXROWFREQ},
  {"rownrmfltr",  1,      0,      CMD_ROWNRMFLTR},
  {"compactcols", 0,      0,      CMD_COMPACTCOLS},
  {"transpose",   0,      0,      CMD_TRANSPOSE},
  {"help",        0,      0,      CMD_HELP},
  {0,             0,      0,      0}
};


/*-------------------------------------------------------------------*/
/* Mini help  */
/*-------------------------------------------------------------------*/
static char helpstr[][100] = {
" ",
"Usage: csrconv [options] <infile> <inf> <outfile> <outf>",
" ",
" Required parameters",
"  infile, outfile",
"     The name of the input/output CSR file.",
" ",
"  inf/outf",
"     The format of the input/output file.",
"     Supported values are:",
"        1  GK_CSR_FMT_CLUTO",
"        2  GK_CSR_FMT_CSR",
"        3  GK_CSR_FMT_METIS",
"        4  GK_CSR_FMT_BINROW",
"        6  GK_CSR_FMT_IJV",
"        7  GK_CSR_FMT_BIJV",
" ",
" Optional parameters",
"  -numone",
"     Specifies that the numbering of the input file starts from 1. ",
"     It only applies to CSR/IJV formats.",
" ",
"  -nowritevals",
"     Specifies that no values will be output.",
" ",
"  -noreadvals",
"     Specifies that the values will not be read when applicable.",
" ",
"  -rshuf",
"     Specifies that the rows will be randmly shuffled prior to output.",
" ",
"  -cshuf",
"     Specifies that the columns will be randmly shuffled prior to output.",
" ",
"  -symmetric",
"     Specifies that the row+column shuffling will be symmetric.",
" ",
"  -mincolfreq=int",
"     Used to prune infrequent columns.",
" ",
"  -maxcolfreq=int",
"     Used to prune frequent columns.",
" ",
"  -minrowfreq=int",
"     Used to prune infrequent rows.",
" ",
"  -maxrowfreq=int",
"     Used to prune frequent.",
" ",
"  -rownrmfltr=float",
"     The parameter to use for the row-wise low filter.",
" ",
"  -compactcols",
"     Specifies if empty columns will be removed and the columns renumbered.",
" ",
"  -transpose",
"     Specifies that the transposed matrix will be written.",
" ",
"  -help",
"     Prints this message.",
""
};

static char shorthelpstr[][100] = {
" ",
"   Usage: csrconv [options] <infile> <inf> <outfile> <outf>",
"          use 'csrconv -help' for a summary of the options.",
""
};
 

/*************************************************************************/
/*! This is the entry point of the command-line argument parser */
/*************************************************************************/
params_t *parse_cmdline(int argc, char *argv[])
{
  int i;
  int c, option_index;
  params_t *params;

  params = (params_t *)gk_malloc(sizeof(params_t), "parse_cmdline: params");

  /* initialize the params data structure */
  params->numbering = 0;
  params->readvals  = 1;
  params->writevals = 1;
  params->rshuf     = 0;
  params->cshuf     = 0;
  params->symmetric = 0;
  params->transpose = 0;

  params->mincolfreq  = -1;
  params->minrowfreq  = -1;
  params->maxcolfreq  = -1;
  params->maxrowfreq  = -1;
  params->rownrmfltr  = -1;
  params->compactcols = 0;

  params->inf       = -1;
  params->outf      = -1;
  params->infile    = NULL;
  params->outfile   = NULL;


  /* Parse the command line arguments  */
  while ((c = gk_getopt_long_only(argc, argv, "", long_options, &option_index)) != -1) {
    switch (c) {
      case CMD_NUMONE:
        params->numbering = 1;
        break;
      case CMD_NOREADVALS:
        params->readvals = 0;
        break;
      case CMD_NOWRITEVALS:
        params->writevals = 0;
        break;
      case CMD_RSHUF:
        params->rshuf = 1;
        break;
      case CMD_CSHUF:
        params->cshuf = 1;
        break;
      case CMD_SYMMETRIC:
        params->symmetric = 1;
        break;
      case CMD_TRANSPOSE:
        params->transpose = 1;
        break;


      case CMD_MINCOLFREQ:
        if (gk_optarg) params->mincolfreq = atoi(gk_optarg);
        break;
      case CMD_MINROWFREQ:
        if (gk_optarg) params->minrowfreq = atoi(gk_optarg);
        break;
      case CMD_MAXCOLFREQ:
        if (gk_optarg) params->maxcolfreq = atoi(gk_optarg);
        break;
      case CMD_MAXROWFREQ:
        if (gk_optarg) params->maxrowfreq = atoi(gk_optarg);
        break;
      case CMD_ROWNRMFLTR:
        if (gk_optarg) params->rownrmfltr = atof(gk_optarg);
        break;
      case CMD_COMPACTCOLS:
        params->compactcols = 1;
        break;

      case CMD_HELP:
        for (i=0; strlen(helpstr[i]) > 0; i++)
          printf("%s\n", helpstr[i]);
        exit(0);
        break;
      case '?':
      default:
        printf("Illegal command-line option(s)\nUse %s -help for a summary of the options.\n", argv[0]);
        exit(0);
    }
  }

  if (argc-gk_optind != 4) {
    printf("Unrecognized parameters.");
    for (i=0; strlen(shorthelpstr[i]) > 0; i++)
      printf("%s\n", shorthelpstr[i]);
    exit(0);
  }

  params->infile  = gk_strdup(argv[gk_optind++]);
  params->inf     = atoi(argv[gk_optind++]);
  params->outfile = gk_strdup(argv[gk_optind++]);
  params->outf    = atoi(argv[gk_optind++]);

  if (!gk_fexists(params->infile))
    errexit("input file %s does not exist.\n", params->infile);

  return params;
}


/*************************************************************************/
/*! the entry point */
/**************************************************************************/
int main(int argc, char *argv[])
{
  int what;
  params_t *params;
  gk_csr_t *mat, *mat1, *smat;
 
  /* get command-line options */
  params = parse_cmdline(argc, argv);

  /* read the data */
  mat = gk_csr_Read(params->infile, params->inf, params->readvals, params->numbering);

  /* deal with weird transformations */
  if (params->mincolfreq != -1 || params->maxcolfreq != -1) {
    params->mincolfreq = (params->mincolfreq == -1 ? 0 : params->mincolfreq);
    params->maxcolfreq = (params->maxcolfreq == -1 ? mat->nrows : params->maxcolfreq);

    printf("Column prune: %d %d; nnz: %zd => ", 
        params->mincolfreq, params->maxcolfreq, mat->rowptr[mat->nrows]);
    mat1 = gk_csr_Prune(mat, GK_CSR_COL, params->mincolfreq, params->maxcolfreq);
    gk_csr_Free(&mat);
    mat = mat1;
    mat1 = NULL;

    printf("%zd\n", mat->rowptr[mat->nrows]);
  }
  
  if (params->minrowfreq != -1 || params->maxrowfreq != -1) {
    params->minrowfreq = (params->minrowfreq == -1 ? 0 : params->minrowfreq);
    params->maxrowfreq = (params->maxrowfreq == -1 ? mat->ncols : params->maxrowfreq);

    printf("Row prune: %d %d; nnz: %zd => ", 
        params->minrowfreq, params->maxrowfreq, mat->rowptr[mat->nrows]);
    mat1 = gk_csr_Prune(mat, GK_CSR_ROW, params->minrowfreq, params->maxrowfreq);
    gk_csr_Free(&mat);
    mat = mat1;
    mat1 = NULL;

    printf("%zd\n", mat->rowptr[mat->nrows]);
  }

  if (params->rownrmfltr >= 0.0) {
    //gk_csr_Scale(mat, GK_CSR_LOG);
    //gk_csr_Scale(mat, GK_CSR_IDF2);

    printf("Row low filter: %f; nnz: %zd => ", params->rownrmfltr, mat->rowptr[mat->nrows]);
    mat1 = gk_csr_LowFilter(mat, GK_CSR_ROW, 2, params->rownrmfltr);
    gk_csr_Normalize(mat1, GK_CSR_ROW, 2);

    gk_csr_Free(&mat);
    mat = mat1;
    mat1 = NULL;

    printf("%zd\n", mat->rowptr[mat->nrows]);
  }

  if (params->compactcols) {
    printf("Compacting columns: %d => ", mat->ncols);
    gk_csr_CompactColumns(mat);
    printf("%d\n", mat->ncols);
  }


  if (params->rshuf || params->cshuf) {
    if (params->rshuf && params->cshuf)
      what = GK_CSR_ROWCOL;
    else if (params->rshuf)
      what = GK_CSR_ROW;
    else
      what = GK_CSR_COL;

    smat = gk_csr_Shuffle(mat, what, params->symmetric);
    gk_csr_Free(&mat);
    mat = smat;
  }

  if (params->writevals && mat->rowval == NULL) 
    mat->rowval = gk_fsmalloc(mat->rowptr[mat->nrows], 1.0, "mat->rowval");

  if (params->transpose) {
    mat1 = gk_csr_Transpose(mat);
    gk_csr_Free(&mat);
    mat = mat1;
    mat1 = NULL;
  }

  gk_csr_Write(mat, params->outfile, params->outf, params->writevals, 0);

  gk_csr_Free(&mat);

}