Phase.h

//-*-C++-*-
/***************************************************************************
 *
 *   Copyright (C) 2004-2009 by Willem van Straten
 *   Licensed under the Academic Free License version 2.1
 *
 ***************************************************************************/
 
// psrchive/More/MEAL/MEAL/Phase.h
 
#ifndef __MEAL_Phase_H
#define __MEAL_Phase_H
 
#include "MEAL/OneParameter.h"
#include <complex>
 
namespace MEAL
{
  template<typename Parent>
  class Phase : public Parent 
  {
 
  public:
 
    Phase (double _scale = 1.0) : parameter (this)
    { parameter.set_name ("phase"); scale = _scale; }
 
    // ///////////////////////////////////////////////////////////////////
    //
    // Function implementation
    //
    // ///////////////////////////////////////////////////////////////////
 
    std::string get_name () const
    { return "Phase<" + std::string(Parent::Name) + ">"; }
 
  protected:
 
    typedef typename Parent::Result Return;
 
    void calculate (Return& result, std::vector<Return>* gradient);
   
    OneParameter parameter;
    double scale;
  };
 
}
 
template<typename Parent>
void MEAL::Phase<Parent>::calculate (Return& result, std::vector<Return>* grad)
{
  double phase = this->get_param(0);
 
  double cos_phase = cos(scale * phase);
  double sin_phase = sin(scale * phase);
 
  if (MEAL::Function::verbose)
    std::cerr << get_name () << "::calculate scale=" << scale 
              << " phase=" << phase*180/M_PI << " deg" 
              << " cos=" << cos_phase << " sin=" << sin_phase << std::endl;
 
  result = std::complex<double>(cos_phase, sin_phase);
 
  if (grad)
  {
    (*grad)[0] = scale * std::complex<double>(-sin_phase, cos_phase);
    
    if (MEAL::Function::verbose)
      std::cerr << "MEAL::Phase<Parent>::calculate gradient" << std::endl
           << "   " << (*grad)[0] << std::endl;
  } 
}
 
#endif