TComplex.hpp

Go to the documentation of this file.

#ifndef __TComplex__
#define __TComplex__

#include "../Basics/CCountedObject.hpp"
using Exponent::Basics::CCountedObject;

//  ===========================================================================

namespace Exponent
{
    namespace MathTools
    {
        template <class TypeName> class TComplex : public CCountedObject
        {
            EXPONENT_CLASS_DECLARATION;
//  ===========================================================================

        public:

//  ===========================================================================

            TComplex(const TypeName real = 0, const TypeName imag = 0) : m_real(real), m_imag(imag)
            {
                EXPONENT_CLASS_CONSTRUCTION(TComplex<TypeName>);
            }

            virtual ~TComplex()
            {
                EXPONENT_CLASS_DESTRUCTION(TComplex<TypeName>);
            }

//  ===========================================================================
            
            TComplex<TypeName> operator + (const TComplex<TypeName> &complex)
            {
                TComplex<TypeName> answer(m_real + complex.m_real, m_imag + complex.m_imag);
                return answer;
            }
            
            TComplex<TypeName> operator - (const TComplex<TypeName> &complex)
            {
                TComplex<TypeName> answer(m_real - complex.m_real, m_imag - complex.m_imag);
                return answer;
            }
            
            TComplex<TypeName> operator * (const TComplex<TypeName> &complex)
            {
                TComplex<TypeName> answer(m_real * complex.m_real - m_imag * complex.m_imag, m_real * complex.m_imag + complex.m_imag * complex.m_real);
                return answer;
            }
            
            TComplex<TypeName> operator / (const TComplex<TypeName> &complex)
            {
                TComplex<TypeName> answer(m_real * complex.m_real + m_imag * complex.m_imag, m_imag * complex.m_real - m_real * complex.m_imag);
                return answer / complex.getMagnitudeSquared();
            }
            
            TComplex<TypeName> operator = (const TComplex<TypeName> &complex)
            {
                TComplex<TypeName> answer(complex.m_real, complex.m_imag);
                return answer;
            }
            
            TComplex<TypeName> operator * (const TypeName value)
            {
                TComplex<TypeName> answer(m_real * value, m_imag * value);
                return answer;
            }
            
            TComplex<TypeName> operator / (const TypeName value)
            {
                assert(value != 0);
                TComplex<TypeName> answer(m_real / value, m_imag / value);
                return answer;
            }

//  ===========================================================================

            void setRealAndImaginaryFromMagnitudeAndPhase(const TypeName magnitude, const TypeName phase)
            {   
                m_real = magnitude * cos(phase);
                m_imag = magnitude * sin(phase);
            }

            void setRealAndImaginary(const TypeName real, const TypeName imag)
            {
                m_real = real;
                m_imag = imag;
            }

//  ===========================================================================

            TypeName getMagnitude() const
            {
                return sqrt(m_real * m_real + m_imag * m_imag);
            }

            TypeName getMagnitudeSquared() const
            {
                return m_real * m_real + m_imag * m_imag;
            }

            TypeName getPhase() const
            {
                return atan2(m_imag, m_real);
            }

//  ===========================================================================

            TypeName getReal() const
            {
                return m_real;
            }

            TypeName getImaginary() const
            {
                return m_imag;
            }

//  ===========================================================================

        protected:

//  ===========================================================================

            TypeName m_real;            
            TypeName m_imag;            
        };

        EXPONENT_TEMPLATE_CLASS_IMPLEMENTATION(TComplex<TypeName>, TypeName, CCountedObject);
    }
}
#endif  // End of TComplex.hpp

---