biasedcluster.cpp

/********************************************************************************
 *  Neural Network Framework.                                                   *
 *  Copyright (C) 2005-2011 Gianluca Massera <emmegian@yahoo.it>                *
 *                                                                              *
 *  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 St, Fifth Floor, Boston, MA  02110-1301  USA  *
 ********************************************************************************/

#include "biasedcluster.h"
#include "liboutputfunctions.h"
#include "randomgenerator.h"
#include "configurationhelper.h"

namespace farsa {

BiasedCluster::BiasedCluster( unsigned int numNeurons, QString name )
    : Cluster( numNeurons, name), biasesdata(numNeurons, true), tempdata(numNeurons) {
    //--- create the delegate for biases
    setDelegateFor<BiasedCluster, &BiasedCluster::biases>( "biases" );
    biasesdata.zeroing();
}

BiasedCluster::BiasedCluster( ConfigurationParameters& params, QString prefix )
    : Cluster( params, prefix ), biasesdata(numNeurons(), true), tempdata(numNeurons()) {
    //--- create the delegate for biases
    setDelegateFor<BiasedCluster, &BiasedCluster::biases>( "biases" );

    QString vectorSizeErrorTmpl( "The number of elements of the %1 vector in configuration file (%1) is different from the number of neurons (%2)");
    // biases is a vector, that is a list of space-separated values
    QVector<double> vect = ConfigurationHelper::getVector( params, prefix + "biases" );
#ifdef FARSA_DEBUG
    if ( !vect.isEmpty() && vect.size() != (int)numNeurons() ) {
        qWarning() << vectorSizeErrorTmpl.arg( "biases" ).arg( vect.size() ).arg( numNeurons() );
    }
#endif
    biasesdata.copyValues( vect );
}

BiasedCluster::~BiasedCluster() {
}

void BiasedCluster::update() {
    //--- in order to avoid to create a temporary vector at each call
    //--- it use the tempdata and the subtract function of algebra.h
    outFunction()->apply( subtract( tempdata, inputs(), biases() ), outputs() );
    setNeedReset( true );
}

void BiasedCluster::setBias( unsigned int neuron, double bias ) {
    biasesdata[neuron] = bias;
}

void BiasedCluster::setAllBiases( double bias ) {
    biasesdata.setAll( bias );
}

void BiasedCluster::setBiases( const DoubleVector& bias ) {
    biasesdata.copyValues( bias );
}

double BiasedCluster::getBias( unsigned int neuron ) {
    return biasesdata[neuron];
}

void BiasedCluster::randomize( double min, double max ) {
    for ( unsigned int i = 0; i < numNeurons(); i++ ) {
        biasesdata[i] = globalRNG->getDouble( min, max );
    }
}

void BiasedCluster::save(ConfigurationParameters& params, QString prefix)
{
    Cluster::save( params, prefix );
    params.startObjectParameters(prefix, "BiasedCluster", this);
    // First creating a string list, then transforming to a single string
    QStringList list;
    for (unsigned int i = 0; i < biasesdata.size(); i++) {
        list.push_back(QString::number(biasesdata[i]));
    }
    params.createParameter(prefix, "biases", list.join(" "));
}

void BiasedCluster::describe( QString type ) {
    Cluster::describe( type );
    Descriptor d = addTypeDescription( type, "A Cluster where neurons have also a bias value", "The bias values are subtracted from the input values before the calculation of the output" );
    d.describeReal( "biases" ).props( IsList ).help( "The vector of bias values. It must contains numNeurons elements" );
}

}