linker.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 "linker.h"
#include "neuralnet.h"

namespace farsa {

Linker::Linker( Cluster* from, Cluster* to, QString name )
    : Updatable(name) {
    this->fromc = from;
    getFromVector = fromc->getDelegateFor( "outputs" );
    fromVectorName = "outputs";
    this->toc = to;
    getToVector = toc->getDelegateFor( "inputs" );
    toVectorName = "inputs";
}

Linker::Linker( ConfigurationParameters& params, QString prefix )
    : Updatable( params, prefix ) {
    fromc = params.getObjectFromParameter<Cluster>( prefix + "from", true );
    toc = params.getObjectFromParameter<Cluster>( prefix + "to", true );
    if ( !fromc || !toc ) throw ClusterFromOrToMissing();
    QString str = params.getValue( prefix + "fromVector" );
    if ( str.isEmpty() ) {
        getFromVector = fromc->getDelegateFor( "outputs" );
        fromVectorName = "outputs";
    } else {
        getFromVector = fromc->getDelegateFor( str );
        fromVectorName = str;
    }
    str = params.getValue( prefix + "toVector" );
    if ( str.isEmpty() ) {
        getToVector = toc->getDelegateFor( "inputs" );
        toVectorName = "inputs";
    } else {
        getToVector = toc->getDelegateFor( str );
        toVectorName = str;
    }
}

void Linker::save(ConfigurationParameters& params, QString prefix)
{
    Updatable::save( params, prefix );
    params.startObjectParameters(prefix, "Linker", this);
    params.createParameter(prefix, "from", fromc );
    if ( fromVectorName != "outputs" ) {
        params.createParameter( prefix, "fromVector", fromVectorName );
    }
    params.createParameter(prefix, "to", toc );
    if ( toVectorName != "inputs" ) {
        params.createParameter( prefix, "toVector", toVectorName );
    }
}

void Linker::describe( QString type ) {
    Updatable::describe( type );
    Descriptor d = addTypeDescription( type, "The Linker connect two Cluster" );
    d.describeObject( "from" ).type( "Cluster" ).props( IsMandatory ).help( "The Linker will get values from this Cluster" );
    d.describeString( "fromVector" ).def( "outputs" ).help( "The vector on which the Linker will get values from" );
    d.describeObject( "to" ).type( "Cluster" ).props( IsMandatory ).help( "The Linker will write values to this Cluster" );
    d.describeString( "toVector" ).def( "inputs" ).help( "The vector on which the Linker will write values to" );
}

}