ComplexParameter.h

Go to the documentation of this file.

#if !defined(COMPLEXPARAMETER)
#define COMPLEXPARAMETER

//******************************************************************************
// This file is part of AmpTools, a package for performing Amplitude Analysis
// 
// Copyright Trustees of Indiana University 2010, all rights reserved
// 
// This software written by Matthew Shepherd, Ryan Mitchell, and 
//                  Hrayr Matevosyan at Indiana University, Bloomington
// 
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions
// are met:
// 1. Redistributions of source code must retain the above copyright
//    notice and author attribution, this list of conditions and the
//    following disclaimer. 
// 2. Redistributions in binary form must reproduce the above copyright
//    notice and author attribution, this list of conditions and the
//    following disclaimer in the documentation and/or other materials
//    provided with the distribution.
// 3. Neither the name of the University nor the names of its contributors
//    may be used to endorse or promote products derived from this software
//    without specific prior written permission.
// 
// Creation of derivative forms of this software for commercial
// utilization may be subject to restriction; written permission may be
// obtained from the Trustees of Indiana University.
// 
// INDIANA UNIVERSITY AND THE AUTHORS MAKE NO REPRESENTATIONS OR WARRANTIES, 
// EXPRESS OR IMPLIED.  By way of example, but not limitation, INDIANA 
// UNIVERSITY MAKES NO REPRESENTATIONS OR WARRANTIES OF MERCANTABILITY OR 
// FITNESS FOR ANY PARTICULAR PURPOSE OR THAT THE USE OF THIS SOFTWARE OR 
// DOCUMENTATION WILL NOT INFRINGE ANY PATENTS, COPYRIGHTS, TRADEMARKS, 
// OR OTHER RIGHTS.  Neither Indiana University nor the authors shall be 
// held liable for any liability with respect to any claim by the user or 
// any other party arising from use of the program.
//******************************************************************************

#include <string>
#include <complex>

#include "MinuitInterface/MIObserver.h"
#include "MinuitInterface/MinuitParameter.h"

class MinuitMinimizationManager;
class MISubject;

using namespace std;

class ComplexParameter : public MIObserver
{
  
public:
  
  ComplexParameter( const string& name,
                   MinuitMinimizationManager& aManager,
                   complex< double > initialValue = complex< double >( 1, 0 ),
                   bool purelyReal = false );
  
  ~ComplexParameter();
  
  void update( const MISubject* callingSubject );
  
  void setValue( complex< double > value );
  
  void fix();
  
  void free();
  
  const string& name() const { return m_name; }
  
  string realName() const { return m_name + "_re"; }
  
  string imagName() const { return m_name + "_im"; }
  
  bool isPurelyReal() const { return m_purelyReal == true; }
  
  bool isFixed() const;
   
  complex< double > value() const { return m_value; }
  
  const complex< double >* constValuePtr() const { return &m_value; }
  
  complex< double >* valuePtr() { return &m_value; }
  
private:
  
  // prevent default construction or copying
  ComplexParameter();
  ComplexParameter( const ComplexParameter& );
  
  string m_name;
  complex< double > m_value;
  bool m_purelyReal;
  
  // parameters to hold the two numbers that represent this complex parameter
  MinuitParameter* m_realPar;
  MinuitParameter* m_imPar;
};

#endif