VwEnvironment.h

Go to the documentation of this file.

/*
 * Copyright (c) 2009 Yahoo! Inc.  All rights reserved.  The copyrights
 * embodied in the content of this file are licensed under the BSD
 * (revised) open source license.
 *
 * 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 3 of the License, or
 * (at your option) any later version.
 *
 * Written (W) 2011 Shashwat Lal Das
 * Copyright (C) 2011 Berlin Institute of Technology and Max-Planck-Society.
 */

#ifndef _VW_ENV_H__
#define _VW_ENV_H__

#include <shogun/lib/config.h>

#include <shogun/base/SGObject.h>
#include <shogun/base/DynArray.h>
#include <shogun/lib/DataType.h>
#include <shogun/lib/common.h>
#include <shogun/lib/v_array.h>
#include <shogun/classifier/vw/vw_constants.h>

namespace shogun
{

class CVwEnvironment: public CSGObject
{
public:
    CVwEnvironment();

    virtual ~CVwEnvironment() { }

    inline void set_num_bits(vw_size_t bits) { num_bits = bits; }

    inline vw_size_t get_num_bits() { return num_bits; }

    inline void set_mask(vw_size_t m) { mask = m; }

    inline vw_size_t get_mask() { return mask; }

    inline float64_t get_min_label() { return min_label; }

    inline float64_t get_max_label() { return max_label; }

    inline vw_size_t num_threads() { return 1 << thread_bits; }

    inline vw_size_t length() { return 1 << num_bits; }

    void set_stride(vw_size_t new_stride);

    virtual const char* get_name() const { return "VwEnvironment"; }

private:
    virtual void init();

public:
    vw_size_t num_bits;
    vw_size_t thread_bits;
    vw_size_t mask;
    vw_size_t thread_mask;
    vw_size_t stride;

    float64_t min_label;
    float64_t max_label;

    float32_t eta;
    float32_t eta_decay_rate;

    bool adaptive;
    bool exact_adaptive_norm;
    float32_t l1_regularization;

    bool random_weights;
    float32_t initial_weight;

    float32_t update_sum;

    float32_t t;
    float64_t initial_t;
    float32_t power_t;

    int64_t example_number;
    float64_t weighted_examples;
    float64_t weighted_unlabeled_examples;
    float64_t weighted_labels;
    vw_size_t total_features;
    float64_t sum_loss;
    vw_size_t passes_complete;
    vw_size_t num_passes;

    vw_size_t ngram;
    vw_size_t skips;

    bool ignore_some;
    bool ignore[256];

    DynArray<char*> pairs;

    const char* vw_version;
    vw_size_t v_length;
};

}
#endif // _VW_ENV_H__