---

complex_parameter.h

Go to the documentation of this file.

// SuperMix version 1.0  C++ source file
//
// Copyright (c) 1999 California Institute of Technology.
// All rights reserved.
//
// Redistribution and use in source and binary forms for noncommercial
// purposes are permitted provided that the above copyright notice and
// this paragraph are duplicated in all such forms and that any
// documentation and other materials related to such distribution and
// use acknowledge that the software was developed by California
// Institute of Technology. Redistribution and/or use in source or
// binary forms is not permitted for any commercial purpose. Use of
// this software does not include a permitted use of the Institute's
// name or trademark for any purpose.
//
// DISCLAIMER:
// THIS SOFTWARE AND/OR RELATED MATERIALS ARE PROVIDED "AS-IS" WITHOUT
// WARRANTY OF ANY KIND INCLUDING ANY WARRANTIES OF PERFORMANCE OR
// MERCHANTABILITY OR FITNESS FOR A PARTICULAR USE OR PURPOSE (AS SET
// FORTH IN UCC 23212-2313) OR FOR ANY PURPOSE WHATSOEVER, FOR THE
// LICENSED PRODUCT, HOWEVER USED.  IN NO EVENT SHALL CALTECH/JPL BE
// LIABLE FOR ANY DAMAGES AND/OR COSTS, INCLUDING BUT NOT LIMITED TO
// INCIDENTAL OR CONSEQUENTIAL DAMAGES OF ANY KIND, INCLUDING ECONOMIC
// DAMAGE OR INJURY TO PROPERTY AND LOST PROFITS, REGARDLESS OF
// WHETHER CALTECH/JPL SHALL BE ADVISED, HAVE REASON TO KNOW, OR IN
// FACT SHALL KNOW OF THE POSSIBILITY.  THE USER BEARS ALL RISK
// RELATING TO QUALITY AND PERFORMANCE OF THE SOFTWARE AND/OR RELATED
// MATERIALS.
//
// **************************************************************************
 
// **************************************************************************
//
// 5/13/01:  Converted comments to javadoc format
// 5/8/01:   Fixed a sinister bug where double arguments are
//           cast to ints vice converted to Complex
// 11/23/98: Added operator= and constructor to shadow real
//           parameters (JSW)
// 8/19/98:  Fixed default operator =
//
// **************************************************************************

#ifndef COMPLEX_PARAMETER_H
#define COMPLEX_PARAMETER_H 1

#include "abstract_complex_parameter.h"
#include <iostream.h>
#include "abstract_real_parameter.h"

class complex_parameter : public abstract_complex_parameter
{
public:

  complex_parameter(Complex v = Complex(0.0));

  complex_parameter(int v);

  complex_parameter(double v);

//    // Create a clone of the argument
//    complex_parameter(const complex_parameter &) ;

  complex_parameter(const abstract_complex_parameter *p);

  complex_parameter(const abstract_real_parameter *p);

  enum {CARTESIAN = 1, POLAR = 2};

  complex_parameter(const abstract_real_parameter &p1,
                    const abstract_real_parameter &p2,
                    int imode = CARTESIAN) ;  

  inline bool is_shadow() const ;

  inline bool is_local() const ;

  bool is_cartesian() const { return mode == CARTESIAN; }

  bool is_polar() const { return mode == POLAR; }

  Complex get() const;

  inline complex_parameter& set(Complex v);

  complex_parameter& clone(const complex_parameter & p);

  complex_parameter & shadow(const abstract_complex_parameter & p);

  complex_parameter & shadow(const abstract_real_parameter & p);

  complex_parameter & shadow(const abstract_real_parameter &p1,
                             const abstract_real_parameter &p2,
                             int imode = CARTESIAN);

  complex_parameter& operator =(Complex v) { return set(v); }

  complex_parameter& operator =(double v) { return set(v); }

  complex_parameter& operator =(int v) { return set(Complex(v)); }

  complex_parameter& operator =(const complex_parameter & p)
  { return clone(p); }

  complex_parameter& operator =(const abstract_complex_parameter * p);

  complex_parameter& operator =(const abstract_real_parameter * p);

private:
  Complex value;

  // used with CARTESIAN and POLAR
  enum {VALUE = 0, C_SHADOW = 3, R_SHADOW = 4};

  int mode ;

  union { 
    const abstract_complex_parameter *cp;
    const abstract_real_parameter *rp1;
  };

  const abstract_real_parameter *rp2;

  mutable bool get_flag ;
};

// inline member function definitions

inline bool complex_parameter::is_shadow() const
{ return mode != VALUE; }

inline bool complex_parameter::is_local() const
{ return mode == VALUE; }

inline complex_parameter& complex_parameter::set(Complex v)
{ mode = VALUE; value = v; return *this; }

inline complex_parameter & operator +=(complex_parameter & p, Complex d)
{ return p.set(p.get() + d); }

inline complex_parameter & operator -=(complex_parameter & p, Complex d)
{ return p.set(p.get() - d); }

inline complex_parameter & operator *=(complex_parameter & p, Complex d)
{ return p.set(p.get() * d); }

inline complex_parameter & operator /=(complex_parameter & p, Complex d)
{ return p.set(p.get() / d); }

istream &operator >>(istream&, complex_parameter&);

#endif /* COMPLEX_PARAMETER_H */

---

Please direct comments and corrections to supermix@submm.caltech.edu
Go to the supermix home page
Generated by 1.2.7