Args.h

/*
  Args.{h,c} : INGOR global arguments
  Copyright (C) 2018-2021, Yoshinori Tamada <tamada  A T  ytlab.jp>
  All rights reserved.
 
  Redistribution and use in source and binary forms, with or without
  modification, are permitted provided that the following conditions
  are met:
 
  * Redistributions of source code must retain the above copyright
    notice, this list of conditions and the following disclaimer.
 
  * Redistributions in binary form must reproduce the above copyright
    notice, this list of conditions and the following disclaimer in 
    the documentation and/or other materials provided with the 
    distribution.
 
  * Neither the name of Hirosaki University, Kyoto University, The 
    University of Tokyo, nor the names of its contributors may be 
    used to endorse or promote products derived from this software 
    without specific prior written permission.
 
  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
  FOR A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE
  COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
  INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
  BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
  CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
  ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  POSSIBILITY OF SUCH DAMAGE.
*/
#ifndef __INGOR_ARGS_H
#define __INGOR_ARGS_H
 
#include "filter/Filter.h"
#include "score/Score.h"
 
#include "math/ytGraph.h"
#include "math/ytRNG.h"
 
#define INGOR_DEFAULT_INFILE_TYPE "gdf"
#define INGOR_DEFAULT_OUTPUT_TYPE "nodelist"
#ifdef INGOR_OSS
#define INGOR_DEFAULT_SCORE_NAME "bnrc"
#define INGOR_DEFAULT_ALGO_NAME  "hc"
#else
#define INGOR_DEFAULT_SCORE_NAME "bndc"
#define INGOR_DEFAULT_ALGO_NAME  "cghc"
#endif
#define INGOR_DEFAULT_CANDIDATES 10
#define INGOR_DEFAULT_CANDIDATES_CONT 0
#define INGOR_DEFAULT_CANDIDATES_DISC 0
#define INGOR_DEFAULT_MAX_PARENTS 10
#define INGOR_DEFAULT_MAX_PARENTS_CONT 10
#define INGOR_DEFAULT_MAX_PARENTS_DISC 10
#define INGOR_DEFAULT_TOTAL_MEMORY (1000)  /* in mega byte */
#define INGOR_DEFAULT_CACHE_RATIO (0.3)
 
typedef struct {
  ytStrArray * infiles;     /* Input file names */
  ytStrArray * infileTypes; /* Input file types */
  ytKeyValues * infileArgs; /* Input file args */
 
  int output;                /* if 0, do not output in the main program */
  char * outfile;            /* Output file name */
  char * outfileType;        /* Output file type */
  ytKeyValues * outfileArgs; /* Output file args */
 
  ytData * data; /* original data */
 
  int candidates;
  int candidatesCont;
  int candidatesDisc;
 
  int maxParents;
  int maxParentsCont;
  int maxParentsDisc;
 
  char * scoreName;
  ytKeyValues * scoreArgs;
  Score * sc;
 
  char * algoName;
 
  ytGraph * init;
 
  ytGraph * constrain;
  ytStrArray * constrainFiles;
  ytStrArray * constrainTypes;
  ytArray * constrainArgs;
  char * constrainWrite;
  char * constrainWriteType;
  ytKeyValues * constrainWriteArgs;
  
  ytGraph * fixed;
  char * fixedFile;
  char * fixedType;
  ytKeyValues * fixedArgs;
 
  int bootstrap;
  char * bootstrapMode;
  int blocks;
  char * bootstrapFile;
  ytData * bootstrapData;
  int offset;
 
  int dynamic;
 
  int selfLoop;
 
  int dbn; /* 1 for time expanded (multi-time steps) DBN */
  int sdh; /* 1 for time expanded dynamic-static hybrid BN */
 
  int iteration;
 
  int singleFile;
 
  ytKeyValues * algoArgs;
 
  FilterArgs * filters;
 
  double score;
 
  ytRNG * rng;
 
  int seed;
 
  int verbose;
  int logMode; /* 0: automatic */
  char * logFile;
 
  size_t totalMemory;
  double cacheRatio;
 
  int threads;
 
  int fixRange; /* 1 if value range is fixed for bootstrapping. */
  char * readRange; /* non NUll if value range is given by a file. */
 
  char * outputData; /* If non NULL, output data used for modeling into *.X, *.Y, and *.PR.Y. */
 
  int prompt; /* 1 if prompt mode specified. */
 
  int showDataStat;
 
  int mpi; /* true if USE_MPI is set. */
 
  int MPI_rank; /* 0 if USE_MPI is disabled */
  int MPI_size; /* 1 if USE_MPI is disabled */
#ifdef USE_MPI
  MPI_Comm MPI_comm; /* MPI communicator for grouping procs with simul mode. */
#endif
 
  char * saveData; /* non-NULL for saving preprocessed data. */
  ytKeyValues * saveDataArgs;
 
} Args;
 
Args * Args_parse(int argc, char * argv[]);
 
#endif /* __INGOR_ARGS_H */