ytData.h

/*
  util/ytData.{h,c} : Data container
  Copyright (C) 2018, 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 The Kyoto University 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 __YTLIB_DATA_H
#define __YTLIB_DATA_H
 
#include <stdlib.h>
 
#include "lang/ytObject.h"
#include "ytArray.h"
#include "ytIntArray.h"
#include "ytStrArray.h"
#include "ytKeyValues.h"
 
#include "math/ytRNG.h"
 
#ifndef DOXY
#define ytData_TYPE_REAL 0
#define ytData_TYPE_ORDINAL 1
#define ytData_TYPE_CATEGORICAL 2
#define ytData_TYPE_DISCRETE 3
#endif /* DOXY */
 
typedef struct {
  ytObject obj;
 
  int n;
 
  int p;
 
  double * X;
 
  double * Y;
 
  ytStrArray * names;
 
  ytIntArray * types;
 
  ytKeyValues * sampleAttrs;
 
  ytKeyValues * varAttrs;
 
  ytArray * dict;
 
  ytKeyValues * meta;
 
} ytData;
 
ytData * ytData_new();
void ytData_delete(ytData * this);
 
const char * ytData_typeName(int type);
void ytData_summary(const ytData * data, FILE * fp);
void ytData_varSummary(const ytData * data, FILE * fp);
void ytData_stat(const ytData * this, FILE * fp, int level);
int ytData_getType(const ytData * this, int j);
const char * ytData_getTypeName(const ytData * this, int j);
int ytData_parseType(const char * name);
const char * ytData_getName(const ytData * this, int j);
int ytData_findName(const ytData * this, const char * name);
int ytData_numSamples(const ytData * this);
int ytData_numVariables(const ytData * this);
ytData * ytData_bootstrap(const ytData * this, ytRNG * rng, ytData * data);
void ytData_dynamic(ytData * this);
ytData * ytData_dynamic2(const ytData * this, int * T);
void ytData_print(ytData * this, FILE * fp);
ytData * ytData_pseudoBootstrap(const ytData * this, ytRNG * rng, int blocks, ytData * data);
ytData * ytData_pidBootstrap(const ytData * this, ytRNG * rng, int n, int F, ytData * data);
ytArray * ytData_readPrimaryIDList(const ytData * this, const char * file);
ytData * ytData_listBootstrap(const ytData * this, ytRNG * rng, int n, ytArray * listSet, int F, ytData * data);
void ytData_extractRange(const ytData * this, ytKeyValues * kv);
void ytData_checkRange(const ytData * this, ytDoubleArray * xlar, ytDoubleArray * xrar);
ytData * ytData_hybrid(ytData * this, int n);
ytData * ytData_dehybrid(ytData * this, int N);
ytData * ytData_dbn(ytData * this, int T);
ytArray * ytData_collectPrimaryId(const ytData * this);
void ytData_varInfo(const ytData * this, int j, FILE * fp);
const ytStrArray * ytData_getCategories(const ytData * this, int j);
void ytData_convertAllToReal(ytData * this);
void ytData_splitXY(ytData * this);
ytData * ytData_selectVars(const ytData * this, const ytStrArray * names);
void ytData_dump(const ytData * this, FILE * fp);
int ytData_countNAN(const ytData * this);
int ytData_debug(int argc, char * argv[]);
 
#ifdef USE_MPI
void ytData_MPI_Bcast(ytData ** data, int root, MPI_Comm comm);
#endif /* USE_MPI */
 
#endif /* __YTLIB_DATA_H */