VecElementVariable.cc

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, Rejean Ducharme and University of Montreal
// Copyright (C) 2001-2002 Nicolas Chapados, Ichiro Takeuchi, Jean-Sebastien Senecal
// Copyright (C) 2002 Xiangdong Wang, Christian Dorion

// 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: VecElementVariable.cc,v 1.5 2004/04/27 15:58:16 morinf Exp $
   * This file is part of the PLearn library.
   ******************************************************* */

#include "VecElementVariable.h"

namespace PLearn {
using namespace std;


PLEARN_IMPLEMENT_OBJECT(VecElementVariable,
                        "Variable that is the element of vector vec indexed by variable input",
                        "NO HELP");

VecElementVariable::VecElementVariable(const Vec& vec, Variable* input)
  : inherited(input, 1,1), v(vec)
{
    build_();
}

void
VecElementVariable::build()
{
    inherited::build();
    build_();
}

void
VecElementVariable::build_()
{
    if(input && !input->isScalar())
        PLERROR("IN VecElementVariable(const Vec& vec, Variable* input) input must have nelems() 1 as it is supposed to be an integer index");
}

void
VecElementVariable::declareOptions(OptionList &ol)
{
    declareOption(ol, "v", &VecElementVariable::v, OptionBase::buildoption, "");
    inherited::declareOptions(ol);
}

void VecElementVariable::recomputeSize(int& l, int& w) const
{ l=1; w=1; }

void VecElementVariable::makeDeepCopyFromShallowCopy(map<const void*, void*>& copies)
{
  UnaryVariable::makeDeepCopyFromShallowCopy(copies);
  deepCopyField(v, copies);
}



void VecElementVariable::fprop()
{  valuedata[0] = v[int(input->value[0])]; }


void VecElementVariable::bprop() {}

void VecElementVariable::symbolicBprop() {}



} // end of namespace PLearn

---