OptAdam.hpp

/*
 * OptAdam.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_OPTADAM_HPP__
#define __PDS_OPTADAM_HPP__
 
#include <string>
#include <Pds/Vector>
#include <Pds/Shape>
 
namespace Pds{
 
 
class OptAdam
{
 
private:
 
    Pds::SampleBlock m;
    Pds::SampleBlock v;
    double beta1;
    double beta2;
    double epsilon;
    unsigned int t;
 
    Pds::SampleBlock tmp;
public:
 
    OptAdam(void);
    
    OptAdam(unsigned int N, double beta1=0.9,double beta2=0.999, double epsilon=1e-8);
    
    OptAdam(Pds::Size Sz, double beta1=0.9,double beta2=0.999, double epsilon=1e-8);
    
    OptAdam(unsigned int Nch, Pds::Size Sz, double beta1=0.9,double beta2=0.999, double epsilon=1e-8);
 
    OptAdam(const Pds::OptAdam &B);
 
    
    ~OptAdam(); 
    
public:
 
    Pds::OptAdam& operator = (const Pds::OptAdam &B);
    
    bool Copy(const Pds::OptAdam &B);
    
    void MakeEmpty(void);
    
    bool Reset(void);
    
    bool IsEmpty(void) const;
public:
 
    bool OptimizeGradient(Pds::Matrix &g);
    
    bool OptimizeGradient(Pds::SampleBlock &g);
public:
 
    bool SetT(unsigned int t);
    
    double GetBeta1(void) const;
    
    double GetBeta2(void) const;
    
    Pds::Shape GetShape(void) const;
    
    double GetEpsilon(void) const;
    
public:
 
    void Print(std::string str="") const;
    
 
}; // Class OptAdam
 
} // namespace Pds
 
 
    std::ostream& operator<<(std::ostream &out,const Pds::OptAdam &z);
 
 
#endif