SubInputVMatrix.cc

Go to the documentation of this file.

// -*- C++ -*-

// SubInputVMatrix.cc
//
// Copyright (C) 2004 Olivier Delalleau 
// 
// 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: SubInputVMatrix.cc,v 1.4 2004/07/07 17:30:48 tihocan Exp $ 
   ******************************************************* */

// Authors: Olivier Delalleau

#include "SubInputVMatrix.h"

namespace PLearn {
using namespace std;

// SubInputVMatrix //
SubInputVMatrix::SubInputVMatrix()
: inherited(),
  j_start(0),
  n_inputs(-1)
{
}

PLEARN_IMPLEMENT_OBJECT(SubInputVMatrix, 
    "A VMat that only takes part of the input of its source VMat.", 
    "This can be useful for instance to only take the first k components\n"
    "after applying some dimensionality reduction method."
);

// declareOptions //
void SubInputVMatrix::declareOptions(OptionList& ol)
{
  declareOption(ol, "j_start", &SubInputVMatrix::j_start, OptionBase::buildoption,
      "The column we start at.");

  declareOption(ol, "n_inputs", &SubInputVMatrix::n_inputs, OptionBase::buildoption,
      "The number of inputs to keep (-1 means we keep them all, from j_start).");

  // Now call the parent class' declareOptions
  inherited::declareOptions(ol);
}

// build //
void SubInputVMatrix::build()
{
  inherited::build();
  build_();
}

// build_ //
void SubInputVMatrix::build_()
{
  if (source) {
    if (n_inputs == -1) {
      // Default value: we keep all inputs.
      n_inputs = source->inputsize() - j_start;
    }
    if (n_inputs < 0 || n_inputs + j_start > source->inputsize()) {
      PLERROR("In SubInputVMatrix::build_ - Source VMatrix hasn't enough inputs");
    }
    int n_removed = source->inputsize() - n_inputs;
    inputsize_ = n_inputs;
    width_ = source->width() - n_removed;
    setMetaInfoFromSource();
    // TODO fieldnames and such probably won't be set properly.
  }
}

// getNewRow //
void SubInputVMatrix::getNewRow(int i, const Vec& v) const
{
  // First fill the input part.
  source->getSubRow(i, j_start, v.subVec(0, n_inputs));
  // Then the rest (target + weight).
  source->getSubRow(
      i,
      source->inputsize(),
      v.subVec(n_inputs, v.length() - n_inputs));
}

// makeDeepCopyFromShallowCopy //
void SubInputVMatrix::makeDeepCopyFromShallowCopy(map<const void*, void*>& copies)
{
  inherited::makeDeepCopyFromShallowCopy(copies);
}

} // end of namespace PLearn

---