neuralnet.h

Go to the documentation of this file.

/********************************************************************************
 *  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  *
 ********************************************************************************/

#ifndef NEURALNET_H
#define NEURALNET_H

#include "nnfwconfig.h"
#include <parametersettable.h>
#include "cluster.h"
#include "linker.h"

namespace farsa {

class NeuralNetObserver {
public:
    virtual ~NeuralNetObserver() { }
    virtual void onStepDone() { };
};

class FARSA_NNFW_API NeuralNet : public ParameterSettableWithConfigureFunction {
public:
    NeuralNet();
    ~NeuralNet();
    void setName( QString name ) {
        namev = name;
    };
    QString name() {
        return namev;
    };
    ParameterSettableUI* getUIManager();
    void addObserver( NeuralNetObserver* observer );
    void removeObserver( NeuralNetObserver* observer );
    void addCluster( Cluster* c, bool isInput = false, bool isOutput = false );
    void addInputCluster( Cluster* c ) {
        addCluster( c, true, false );
    };
    void addOutputCluster( Cluster* c ) {
        addCluster( c, false, true );
    };
    bool removeCluster( Cluster* c );
    void markAsInput( Cluster* c );
    void markAsOutput( Cluster* c );
    void unmark( Cluster* c );
    void unmarkAll();
    bool isIsolated( Cluster* c ) const;
    ClusterList clusters() const;
    ClusterList inputClusters() const;
    ClusterList outputClusters() const;
    ClusterList hiddenClusters() const;
    void addLinker( Linker* l );
    bool removeLinker( Linker* );
    LinkerList linkers() const;
    LinkerList linkers( Cluster* c, bool out = false ) const;
    void setOrder( Updatable* updatables[], unsigned int dim );
    void setOrder( const UpdatableList& );
    UpdatableList order() const {
        return ups;
    };
    void step() {
        for( unsigned int i=0; i<dimUps; i++ ) {
            ups[i]->update();
        }
        foreach( NeuralNetObserver* obs, observers ) {
            obs->onStepDone();
        }
    };
    void randomize( double min, double max );
    template<class PointerTo>
    PointerTo byName( QString aName, PointerTo& aPointer ) {
        aPointer = dynamic_cast<PointerTo>( getByName(aName) );
        return aPointer;
    };
    Updatable* getByName( QString );
    bool find( const Cluster* ) const;
    bool find( const Linker* ) const;
    bool find( const Updatable* ) const;
    virtual void configure(ConfigurationParameters& params, QString prefix);
    virtual void save(ConfigurationParameters& params, QString prefix);
    static void describe( QString type );
protected:
    QString namev;
    ClusterList clustersv;
    ClusterList inclusters;
    ClusterList outclusters;
    ClusterList hidclusters;
    LinkerList  linkersv;

    typedef QMap<QString, Cluster*> ClustersMap;
    ClustersMap clsMap;

    typedef QMap<Cluster*, LinkerList> LinkVecMap;
    LinkVecMap inLinks;
    LinkVecMap outLinks;

    typedef QMap<QString, Linker*> LinkersMap;
    LinkersMap lksMap;

    UpdatableList ups;
    unsigned int dimUps;
    
    QList<NeuralNetObserver*> observers;
};

}

#endif