oaComplex.h

Go to the documentation of this file.

// *****************************************************************************
// *****************************************************************************
// oaComplex.h
//
// This file contains definitions for the oaComplex and oaComplexArray template
// classes.  oaComplex represents a complex number, while oaComplexArray
// represents an array of complex numbers.
//
// *****************************************************************************
// Except as specified in the OpenAccess terms of use of Cadence or Silicon
// Integration Initiative, this material may not be copied, modified,
// re-published, uploaded, executed, or distributed in any way, in any medium,
// in whole or in part, without prior written permission from Cadence.
//
//                Copyright 2002-2005 Cadence Design Systems, Inc.
//                           All Rights Reserved.
//
//  $Author: icftcm $
//  $Revision: #1 $
//  $Date: 2010/08/09 $
//  $State: Exp $
// *****************************************************************************
// *****************************************************************************



#if !defined(oaComplex_P)
#define oaComplex_P



// *****************************************************************************
// Nested includes
// *****************************************************************************
#include "oaArray.h"



// *****************************************************************************
// Declare and define types in the OpenAccess namespace.
// *****************************************************************************
BEGIN_OA_NAMESPACE



// *****************************************************************************
// Forward Class Declarations
// *****************************************************************************
template <class T>
class oaChecker;



// *****************************************************************************
// oaComplex
// *****************************************************************************
template <class obj>
class oaComplex {
public:
                            oaComplex();
                            oaComplex(obj   realIn,
                                      obj   imagIn);
                            oaComplex(const oaComplex &c);

    obj                     &real();
    obj                     &imag();
    obj                     real() const;
    obj                     imag() const;

    oaComplex               &operator+=(const oaComplex &c);
    oaComplex               &operator-=(const oaComplex &c);
    oaComplex               &operator*=(const oaComplex &c);
    oaComplex               &operator/=(const oaComplex &c);
    oaComplex               &operator=(const oaComplex &c);
    oaComplex               operator-() const;

    oaBoolean               operator==(const oaComplex &c);
    oaBoolean               operator!=(const oaComplex &c);
    oaBoolean               operator==(const oaComplex &c) const;
    oaBoolean               operator!=(const oaComplex &c) const;

private:
    obj                     r;
    obj                     i;

    friend class oaChecker<oaComplex<obj> >;
};



// *****************************************************************************
// oaComplexArray
// *****************************************************************************
template <class obj>
class oaComplexArray : public oaArray<oaComplex<obj> > {
public:
                            oaComplexArray(const oaUInt4 sizeIn = 0);
                            oaComplexArray(const oaComplexArray &array);
};



// *****************************************************************************
// Operators for oaComplex
// *****************************************************************************
template <class obj>
inline oaComplex<obj>
    operator+(const oaComplex<obj>  &c1,
              const oaComplex<obj>  &c2);

template <class obj>
inline oaComplex<obj>
    operator-(const oaComplex<obj>  &c1,
              const oaComplex<obj>  &c2);

template <class obj>
inline oaComplex<obj>
    operator*(const oaComplex<obj>  &c1,
              const oaComplex<obj>  &c2);

template <class obj>
inline oaComplex<obj>
    operator/(const oaComplex<obj>  &c1,
              const oaComplex<obj>  &c2);



END_OA_NAMESPACE



#endif

Return to top of page

Copyright © 2002 - 2010 Cadence Design Systems, Inc.
All Rights Reserved.