std::complex< arbb::scalar< T > > Class Template Reference

Specialization of std::complex over Intel(R) ArBB scalar types. More...

List of all members.

Public Types

typedef arbb::scalar< T > value_type
 The type used to represent the real and imaginary values of the complex number.

Public Member Functions

 complex ()
 Default constructor.
 complex (const complex &other)
 Copy constructor.
 complex (const value_type &real)
 Equivalent to complex(real, 0).
 complex (const value_type &real, const value_type &imag)
 Constructs a complex number with the given real and imaginary values.
 complex (typename arbb::uncaptured< value_type >::type real, typename arbb::uncaptured< value_type >::type imag)
 Constructs a complex number with the given real and imaginary values.
template<arbb_scalar_type_t U>
 complex (const complex< arbb::scalar< U > > &other)
 Casts the real and imaginary values from other to value_type.
complex & operator= (const complex &other)
 Assignment operator.
complex & operator+= (const complex &other)
 Adds other using complex addition.
complex & operator-= (const complex &other)
 Subtracts other using complex subtraction.
complex & operator*= (const complex &other)
 Multiplies with other using complex multiplication.
complex & operator/= (const complex &other)
 Divides by other using complex division.
value_type real () const
 Returns the real component of the complex number.
value_type imag () const
 Returns the imaginary component of the complex number.

Detailed Description

template<arbb_scalar_type_t T>
class std::complex< arbb::scalar< T > >

Specialization of std::complex over Intel(R) ArBB scalar types.

Definition at line 33 of file complex.hpp.


Member Typedef Documentation

template<arbb_scalar_type_t T>
typedef arbb ::scalar<T> std::complex< arbb::scalar< T > >::value_type

The type used to represent the real and imaginary values of the complex number.

Definition at line 37 of file complex.hpp.


Constructor & Destructor Documentation

template<arbb_scalar_type_t T>
std::complex< arbb::scalar< T > >::complex (  ) 

Default constructor.

template<arbb_scalar_type_t T>
std::complex< arbb::scalar< T > >::complex ( const complex< arbb::scalar< T > > &  other  ) 

Copy constructor.

template<arbb_scalar_type_t T>
std::complex< arbb::scalar< T > >::complex ( const value_type real  ) 

Equivalent to complex(real, 0).

template<arbb_scalar_type_t T>
std::complex< arbb::scalar< T > >::complex ( const value_type real,
const value_type imag 
)

Constructs a complex number with the given real and imaginary values.

template<arbb_scalar_type_t T>
std::complex< arbb::scalar< T > >::complex ( typename arbb::uncaptured< value_type >::type  real,
typename arbb::uncaptured< value_type >::type  imag 
)

Constructs a complex number with the given real and imaginary values.

template<arbb_scalar_type_t T>
template<arbb_scalar_type_t U>
std::complex< arbb::scalar< T > >::complex ( const complex< arbb::scalar< U > > &  other  )  [inline, explicit]

Casts the real and imaginary values from other to value_type.


Member Function Documentation

template<arbb_scalar_type_t T>
complex& std::complex< arbb::scalar< T > >::operator= ( const complex< arbb::scalar< T > > &  other  ) 

Assignment operator.

template<arbb_scalar_type_t T>
complex& std::complex< arbb::scalar< T > >::operator+= ( const complex< arbb::scalar< T > > &  other  ) 

Adds other using complex addition.

template<arbb_scalar_type_t T>
complex& std::complex< arbb::scalar< T > >::operator-= ( const complex< arbb::scalar< T > > &  other  ) 

Subtracts other using complex subtraction.

template<arbb_scalar_type_t T>
complex& std::complex< arbb::scalar< T > >::operator*= ( const complex< arbb::scalar< T > > &  other  ) 

Multiplies with other using complex multiplication.

template<arbb_scalar_type_t T>
complex& std::complex< arbb::scalar< T > >::operator/= ( const complex< arbb::scalar< T > > &  other  ) 

Divides by other using complex division.

template<arbb_scalar_type_t T>
value_type std::complex< arbb::scalar< T > >::real (  )  const

Returns the real component of the complex number.

template<arbb_scalar_type_t T>
value_type std::complex< arbb::scalar< T > >::imag (  )  const

Returns the imaginary component of the complex number.


The documentation for this class was generated from the following file:

Submit feedback on this help topic

Copyright © 2010, Intel Corporation. All rights reserved.