common.h

/* MLPACK 0.2
 *
 * Copyright (c) 2008, 2009 Alexander Gray,
 *                          Garry Boyer,
 *                          Ryan Riegel,
 *                          Nikolaos Vasiloglou,
 *                          Dongryeol Lee,
 *                          Chip Mappus, 
 *                          Nishant Mehta,
 *                          Hua Ouyang,
 *                          Parikshit Ram,
 *                          Long Tran,
 *                          Wee Chin Wong
 *
 * Copyright (c) 2008, 2009 Georgia Institute of Technology
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License as
 * published by the Free Software Foundation; either version 2 of the
 * License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
 * 02110-1301, USA.
 */
#ifndef BASE_COMMON_H
#define BASE_COMMON_H

#ifndef _REENTRANT
#define _REENTRANT
#endif

#include "fastlib/base/basic_types.h" /*generated by build*/
#include "fastlib/base/compiler.h"
#include "fastlib/base/ansi_colors.h"
//#include "base/basic_types.h" /*generated by build*/
//#include "compiler.h"
//#include "ansi_colors.h"

#include <stdlib.h>
#include <stdio.h>
#include <string.h>
#include <ctype.h>
#include <math.h>
#include <limits.h>
#include <float.h>

EXTERN_C_BEGIN

#define NOP ((void)0)

#define COMMA ,



/* Types and definitions to assist managment of problem scale. */

/* Ensure that one and only one problem scale is selected. */
#if defined(SCALE_MASSIVE)
#if defined(SCALE_LARGE) || defined(SCALE_NORMAL)
#error Only one of SCALE_MASSIVE, SCALE_LARGE, or SCALE_NORMAL may be defined.
#endif
#elif defined(SCALE_LARGE) 
#if defined(SCALE_NORMAL)
#error Only one of SCALE_MASSIVE, SCALE_LARGE, or SCALE_NORMAL may be defined.
#endif
#elif !defined(SCALE_NORMAL)
#define SCALE_NORMAL
#endif

#if defined(SCALE_MASSIVE)
typedef int64 index_t;          /* For larger than RAM data sets. */
#elif defined(SCALE_LARGE)
typedef ssize_t index_t;        /* As large as this machine can handle. */
#elif defined(SCALE_NORMAL)
typedef int index_t;            /* Normal sized data; usually 32-bit. */
#endif

#if defined(SCALE_MASSIVE)
#define LI L64
#elif defined(SCALE_LARGE)
#define LI "l"                  /* TODO: confirm correct. */
#elif defined(SCALE_NORMAL)
#define LI ""
#endif

#define KILOBYTE (((size_t)1) << 10)

#define MEGABYTE (((size_t)1) << 20)

#define GIGABYTE (((size_t)1) << 30)
/* Add more of these as necessary. */



/* Tools for FASTlib stderr messages, warnings, and errors. */

extern int segfault_on_abort;
extern int abort_on_nonfatal;
extern int pause_on_nonfatal;
extern int print_notify_locs;

typedef enum {
  FL_MSG_FATAL = 0,
  FL_MSG_NONFATAL = 1,
  FL_MSG_NOTIFY_STAR = 2,
  FL_MSG_NOTIFY = 3
} fl_msg_t;

extern char fl_msg_marker[];
extern const char *fl_msg_color[];

COMPILER_NO_RETURN
void fl_abort(void);

void fl_pause(void);

void fl_print_msg_header(char marker, const char *color);

void fl_print_msg_loc(const char *file, const char *func, int line);

COMPILER_NO_RETURN
COMPILER_PRINTF(4, 5)
void fl_print_fatal_msg(const char *file, const char *func, int line,
                        const char* format, ...);

COMPILER_PRINTF(5, 6)
void fl_print_msg(const char *file, const char *func, int line,
                  fl_msg_t msg_type, const char* format, ...);

#define FATAL(msg_params...) (fl_print_fatal_msg( \
    __FILE__, __FUNCTION__, __LINE__, msg_params))

#define NONFATAL(msg_params...) (fl_print_msg( \
    __FILE__, __FUNCTION__, __LINE__, FL_MSG_NONFATAL, msg_params))

#define NOTIFY_STAR(msg_params...) (fl_print_msg( \
    __FILE__, __FUNCTION__, __LINE__, FL_MSG_NOTIFY_STAR, msg_params))

#define NOTIFY(msg_params...) (fl_print_msg( \
    __FILE__, __FUNCTION__, __LINE__, FL_MSG_NOTIFY, msg_params))

void fl_print_progress(const char *name, int perc);



void hex_to_stream(FILE *stream, const char *src, const char *ok_char);

char *hex_to_string(char *dest, const char *src, const char *ok_char);

char *unhex_in_place(char *str);



/* Tools for expressing success or failure of FASTlib functions. */

typedef enum {
  SUCCESS_FAIL = 31,
  SUCCESS_WARN = 48,
  SUCCESS_PASS = 96
} success_t;

#define PASSED(x) (likely((x) >= SUCCESS_PASS))

#define FAILED(x) (unlikely((x) <= SUCCESS_FAIL))

#define MUST_PASS_MSG(x, msg_params...) \
    (likely(x >= SUCCESS_PASS) ? NOP : FATAL(msg_params))

#define MUST_PASS(x) \
    MUST_PASS_MSG(x, "MUST_PASS failed: %s", #x)

#define MUST_NOT_FAIL_MSG(x, msg_params...) \
    (likely(x > SUCCESS_FAIL) ? NOP : FATAL(msg_params))

#define MUST_NOT_FAIL(x) \
    MUST_NOT_FAIL_MSG(x, "MUST_NOT_FAIL failed: %s", #x)

#define SUCCESS_FROM_C(x) (unlikely((x) < 0) ? SUCCESS_FAIL : SUCCESS_PASS)



EXTERN_C_END

#endif /* BASE_COMMON_H */