JComplexPhase.hh

Go to the documentation of this file.

#ifndef __JOSCPROB__JCOMPLEXPHASE__
#define __JOSCPROB__JCOMPLEXPHASE__

#include "JLang/JException.hh"

#include "JTools/JGrid.hh"

#include "JOscProb/JOscParameter.hh"


/**
 * \author bjung, mdejong
 */

namespace JOSCPROB {}
namespace JPP { using namespace JOSCPROB; }

namespace JOSCPROB {

  using JTOOLS::JGrid;
  

  /**
   * Implementation of oscillation complex phase.
   */
  template<class T = double>
  struct JComplexPhase :
    public JOscParameter<T>
  {
    typedef JComplexPhase<T>                          JComplexPhase_t;
    typedef JOscParameter<T>                          JOscParameter_t;
    
    typedef typename JOscParameter_t::JParameter_t    JParameter_t;
    typedef typename JOscParameter_t::argument_type   argument_type;
    
    
    /**
     * Default constructor.
     */
    JComplexPhase() :
      JOscParameter_t()
    {}


    /**
     * Constructor.
     *
     * \param  value      complex phase value [rad]
     */
    explicit JComplexPhase(argument_type value) :
      JOscParameter_t(value)
    {
      using namespace JPP;
      
      if (!is_valid()) {
        THROW(JValueOutOfRange, "JComplexPhase::JComplexPhase(): Invalid complex phase " << value);
      }
    }


    /**
     * Assignment operator.
     *
     * \param  value      complex phase value [rad]
     * \return            complex phase
     */
    JComplexPhase_t& operator=(argument_type value)
    {
      this->setValue(value);

      return *this;
    }


    /**
     * Check validity of oscillation parameter.
     *
     * \return            true if valid; else false
     */
    bool is_valid() const override
    {
      const T& phase = this->getValue();
      
      return this->isDefined() ? !(phase < 0.0 || phase > 2 * M_PI) : true;
    }


    /**
     * Auxiliary function to create a complex phase parameter grid.
     *
     * \param  value             complex phase value [rad]
     * \return                   complex phase parameter
     */
    static JComplexPhase_t make_parameter(argument_type value)
    {
      return JComplexPhase_t(value);
    }
  };


  /**
   * Template specialization for parameter grid.
   */
  template<>
  struct JComplexPhase<JGrid<double> > :
    public JOscParameter<JGrid<double> >
  {
    typedef JGrid<double>                              JGrid_t;    
    typedef JComplexPhase<JGrid_t>                     JComplexPhase_t;
    typedef JOscParameter<JGrid_t>                     JOscParameter_t;
    
    typedef typename JOscParameter_t::JParameter_t     JParameter_t;
    typedef typename JOscParameter_t::argument_type    argument_type;
    
    typedef typename JGrid_t::abscissa_type            abscissa_type;
    
    
    /**
     * Default constructor.
     */
    JComplexPhase()
    {}


    /**
     * Constructor.
     *
     * \param  grid       complex phase parameter grid [rad]
     */
    explicit JComplexPhase(argument_type grid) :
      JOscParameter_t(grid)
    {
      using namespace JPP;
      
      if (!is_valid()) {
        THROW(JValueOutOfRange, "JComplexPhase::JComplexPhase(): Invalid complex phase grid " << grid);
      }
    }


    /**
     * Constructor.
     *
     * \param  nx         number of elements
     * \param  Xmin       lower limit [rad]
     * \param  Xmax       upper limit [rad]
     */
    JComplexPhase(const int            nx,
                  const abscissa_type& xmin,
                  const abscissa_type& xmax) :
      JOscParameter_t(JGrid_t(nx, xmin, xmax))
    {}


    /**
     * Constructor.
     *
     * \param  value      complex phase value [rad]
     */
    explicit JComplexPhase(const abscissa_type& value) :
      JComplexPhase(1, value, value)
    {}


    /**
     * Assignment operator.
     *
     * \param  value      complex phase parameter grid [rad]
     * \return            complex phase
     */
    JComplexPhase_t& operator=(argument_type grid)
    {
      this->setValue(grid);

      return *this;
    }


    /**
     * Check validity of oscillation parameter.
     *
     * \return            true if valid; else false
     */
    bool is_valid() const override
    {
      const abscissa_type minPhase = this->getValue().getXmin();
      const abscissa_type maxPhase = this->getValue().getXmax();      
      
      return (this->isDefined() ? !(minPhase < 0.0 || minPhase > 2 * M_PI ||
                                    maxPhase < 0.0 || maxPhase > 2 * M_PI) : true);
    }


    /**
     * Auxiliary function to create a complex phase parameter grid.
     *
     * \param  value             complex phase value [rad]
     * \return                   complex phase parameter
     */
    static JComplexPhase_t make_parameter(const abscissa_type& value)
    {
      return JComplexPhase_t(value);
    }
  };
}

#endif