FCLayer.hpp

/*
 * FCLayer.hpp
 * 
 * Copyright 2018 Fernando Pujaico Rivera <fernando.pujaico.rivera@gmail.com>
 * 
 * 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 Street, Fifth Floor, Boston,
 * MA 02110-1301, USA.
 * 
 */
 
#ifndef __PDS_FCLAYER_HPP__
#define __PDS_FCLAYER_HPP__
 
#include <string>
#include <Pds/Ra>
#include <Pds/AbstractLayer>
 
namespace Pds{
 
 
class FCLayer: public AbstractLayer
{
 
private:
    // Número de entradas
    unsigned int Nin;
    // Número de salidas
    unsigned int Nout;
    // Matriz de pesos
    Pds::Matrix W;
    // Funcion de activacion
    double (*ActFunc)(double);
    // Derivada de la funcion de activación
    double (*DActFunc)(double);
    
public:
 
    FCLayer(void);
    
    FCLayer(unsigned int Nin,unsigned int Nout);
 
    FCLayer(unsigned int Nin, unsigned int Nout, double(*func)(double), double(*dfunc)(double));    
        
    FCLayer(const Pds::Matrix &W);
        
    FCLayer(const Pds::Matrix &W, double(*func)(double), double(*dfunc)(double));
    
 
    FCLayer(const Pds::FCLayer &B);
 
    
    ~FCLayer(); 
    
public:
    bool Rand(double minval,double maxval);
    
    
    bool SetActFunc(double (*func)(double),double (*dfunc)(double));
    
public:
    bool IsEmpty(void) const;
    
    unsigned int Ninputs(void) const;
    
    unsigned int Noutputs(void) const;
    
    
    Pds::Shape GetInputShape(void) const;
    
    
    Pds::Shape GetOutputShape(const Pds::Shape &In) const;
    
    
    std::string WToString(void) const;
    
    
    const Pds::Matrix &GetW(void) const;
    
    Pds::Ra::FuncPointer GetActFunc(void) const;
    
    
    Pds::Ra::FuncPointer GetDActFunc(void) const;
public:
    bool ExportXmlToStream(std::ofstream &myfile) const;
 
    std::string ExportXmlToString(void) const;
    
    bool ImportXmlFromString(   const std::string &str);
 
    bool SaveInStream(std::ofstream &myfile) const;
    
 
        
    bool LoadFromStream(std::ifstream &ifs);
public:
    Pds::TensorBlock PredictTensor(const Pds::TensorBlock &In) const;
    
    Pds::SampleBlock Predict(const Pds::SampleBlock &In) const;
 
    Pds::Vector Predict(const Pds::Vector &In) const;
 
    bool Predict(const Pds::Vector &In, Pds::Vector &Out) const;   
 
    bool Predict(const Pds::Vector &In, Pds::Vector &Out, Pds::Vector &Z) const;   
public:
    static bool DeltaBackPropagation(   const Pds::Matrix &W,
                                        const Pds::Vector &delta_p1,
                                        double (*dfunc_m1)(double),
                                        const Pds::Vector &z,                                    
                                        Pds::Vector &delta);
    
    bool WUpdate(double alpham, const Pds::Matrix &Q_1, double lambda=0);
public:
    void Print(std::string str="") const;
 
    void PrintStylized(std::string str="") const;
    
    unsigned int SummaryLine(unsigned int width=12) const;
    
    void MakeEmpty(void);
    
    
    Pds::AbstractLayer* Clone(void)
    {
      return new Pds::FCLayer(*this);
    }
    
}; // Class FCLayer
 
} // namespace Pds
 
 
#endif