CompactVMatrix.h

Go to the documentation of this file.

// -*- C++ -*-

// PLearn (A C++ Machine Learning Library)
// Copyright (C) 1998 Pascal Vincent
// Copyright (C) 1999-2002 Pascal Vincent, Yoshua Bengio and University of Montreal
//

// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are met:
// 
//  1. Redistributions of source code must retain the above copyright
//     notice, this list of conditions and the following disclaimer.
// 
//  2. 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.
// 
//  3. The name of the authors may not be used to endorse or promote
//     products derived from this software without specific prior written
//     permission.
// 
// THIS SOFTWARE IS PROVIDED BY THE AUTHORS ``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 AUTHORS 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.
// 
// This file is part of the PLearn library. For more information on the PLearn
// library, go to the PLearn Web site at www.plearn.org


 

/* *******************************************************      
   * $Id: CompactVMatrix.h,v 1.7 2004/07/09 19:42:23 tihocan Exp $
   * This file is part of the PLearn library.
   ******************************************************* */


#ifndef CompactCompactVMatrix_INC
#define CompactCompactVMatrix_INC

#include "RowBufferedVMatrix.h"
#include "VMat.h"

namespace PLearn {
using namespace std;

class CompactVMatrix : public RowBufferedVMatrix
{
    typedef RowBufferedVMatrix inherited;
    class SDBVMatrix;

  protected:
    
    Storage<unsigned char> data;
    int row_n_bytes; 
    int n_bits; 
    int n_symbols; 
    int n_fixedpoint; 
    int n_variables; 
    bool one_hot_encoding; 
  public:
    TVec<int> n_symbol_values; 
    int nbits() { return n_bits; }
    int nsymbols() { return n_symbols; }
    int nfixedpoint() { return n_fixedpoint; }
  protected:
    Vec fixedpoint_min, fixedpoint_max; 
    Vec delta; 
    TVec<int> variables_permutation; 

  static unsigned char n_bits_in_byte[256];
  static void set_n_bits_in_byte();

  public:
    int n_last; 
  protected:
    int normal_width;         
  public:
    void setOneHotMode(bool on=true);

    // ******************
    // *  Constructors  *
    // ******************
    CompactVMatrix(); 

    CompactVMatrix(int the_length, int n_variables, int n_binary, int n_nonbinary_discrete,
                   int n_fixed_point, TVec<int>& n_symbolvalues, Vec& fixed_point_min,
                   Vec& fixed_point_max, bool one_hot_encoding=true);

    CompactVMatrix(VMat m, int keep_last_variables_last=1, bool onehot_encoding=true);


    CompactVMatrix(const string& filename, int nlast=1);

    CompactVMatrix(CompactVMatrix* cvm, VMat m, bool rescale=false, bool check=true);

    void append(CompactVMatrix* vm);

    void perturb(int i, Vec row, real noise_level, int n_last);

    TVec<int>& permutation_vector() { return variables_permutation; }
    
  protected:

    virtual void getNewRow(int i, const Vec& v) const;

  public:


    virtual real squareDifference(int i, int j);

    virtual real dotProduct(int i, int j) const;

    virtual real dot(int i1, int i2, int inputsize) const;
    virtual real dot(int i, const Vec& v) const;


    virtual void encodeAndPutRow(int i, Vec v);
    virtual void putRow(int i, Vec v);
    virtual void putSubRow(int i, int j, Vec v);

    virtual void save(const string& filename)
    { Object::save(filename); } 
    //virtual void write(ostream& out) const;

    //virtual void oldread(istream& in);

    PLEARN_DECLARE_OBJECT(CompactVMatrix);
    void makeDeepCopyFromShallowCopy(map<const void*, void*>& copies);
    virtual void build() {}  

  protected:
    int symbols_offset; 
    int fixedpoint_offset; 
    Vec row_norms; 
};

DECLARE_OBJECT_PTR(CompactVMatrix);

} // end of namespace PLearn
#endif

---