Class sysc::OutputComplexScalarData

Definition: OutputComplexScalarData.hpp (line 24)

Provide a class for output complex scalar data.

Output scalar data provides read-only access to an array of complex scalars.

Members

• empty
• getData1
• getData2
• getDataType
• isSplitComplex
• m_data1
• m_data2
• m_dataType
• m_isSplitComplex
• m_size
• operator=
• operator=
• OutputComplexScalarData
• OutputComplexScalarData
• OutputComplexScalarData
• OutputComplexScalarData
• OutputComplexScalarData
• OutputComplexScalarData
• OutputComplexScalarData
• OutputComplexScalarData
• OutputComplexScalarData
• OutputComplexScalarData
• OutputComplexScalarData
• OutputComplexScalarData
• OutputComplexScalarData
• size

Private attributes

Variable m_dataType

Definition: OutputComplexScalarData.hpp (line 219)

sysc::PrimitiveType sysc::OutputComplexScalarData::m_dataType {sysc::Double}

Type: sysc::PrimitiveType

Variable m_isSplitComplex

Definition: OutputComplexScalarData.hpp (line 220)

bool sysc::OutputComplexScalarData::m_isSplitComplex {false}

Type: bool

Variable m_data1

Definition: OutputComplexScalarData.hpp (line 222)

const void* sysc::OutputComplexScalarData::m_data1 {nullptr}

Type: const void *

Variable m_data2

Definition: OutputComplexScalarData.hpp (line 223)

const void* sysc::OutputComplexScalarData::m_data2 {nullptr}

Type: const void *

Variable m_size

Definition: OutputComplexScalarData.hpp (line 225)

std::size_t sysc::OutputComplexScalarData::m_size {0}

Type: std::size_t

Public functions

Function OutputComplexScalarData

sysc::OutputComplexScalarData::OutputComplexScalarData(const std::vector< std::complex< double >> &dataComplex)

Provide a constructor for output complex scalar data with compact storage for complex components.

Parameters:

• dataComplex: - reference to the STL vector of complex double-precision data

Parameters:

• const std::vector< std::complex< double >> & dataComplex

Return type:

Function OutputComplexScalarData

sysc::OutputComplexScalarData::OutputComplexScalarData(const std::complex< double > *dataComplex, std::size_t size)

Provide a constructor for output complex scalar data with compact storage for complex components.

Parameters:

• dataComplex: - pointer to an array of complex double-precision scalars
• size: - number of scalars

Parameters:

• const std::complex< double > * dataComplex
• std::size_t size

Return type:

Function OutputComplexScalarData

sysc::OutputComplexScalarData::OutputComplexScalarData(const double *dataComplex, std::size_t size)

Provide a constructor for output complex scalar data with compact storage for complex components.

Parameters:

• dataComplex: - pointer to an array of complex double-precision scalars
• size: - number of scalars

Parameters:

• const double * dataComplex
• std::size_t size

Return type:

Function OutputComplexScalarData

sysc::OutputComplexScalarData::OutputComplexScalarData(const std::vector< double > &dataReal, const std::vector< double > &dataImaginary)

Create an output complex scalar data access object with split storage for compex components.

Parameters:

• dataReal: - reference to an STL vector of double-precision data, that stores the real components of the complex scalars.
• dataImaginary: - reference to an STL vector of double-precision data, that stores the imaginary components of the complex scalars.

Parameters:

• const std::vector< double > & dataReal
• const std::vector< double > & dataImaginary

Return type:

Function OutputComplexScalarData

sysc::OutputComplexScalarData::OutputComplexScalarData(const double *dataReal, const double *dataImaginary, std::size_t size)

Create an output complex scalar data access object with split storage for compex components.

Parameters:

• dataReal: - pointer to an array of double-precision data, that stores the real components of the complex scalars.
• dataImaginary: - pointer to an array of double-precision data, that stores the imaginary components of the complex scalars.
• size: - number of complex scalars

Parameters:

• const double * dataReal
• const double * dataImaginary
• std::size_t size

Return type:

Function OutputComplexScalarData

sysc::OutputComplexScalarData::OutputComplexScalarData(const std::vector< std::complex< float >> &dataComplex)

Provide a constructor for output complex scalar data with compact storage for complex components.

Parameters:

• dataComplex: - reference to the STL vector of complex single-precision data

Parameters:

• const std::vector< std::complex< float >> & dataComplex

Return type:

Function OutputComplexScalarData

sysc::OutputComplexScalarData::OutputComplexScalarData(const std::complex< float > *dataComplex, std::size_t size)

Provide a constructor for output complex scalar data with compact storage for complex components.

Parameters:

• dataComplex: - pointer to an array of complex single-precision scalars
• size: - number of scalars

Parameters:

• const std::complex< float > * dataComplex
• std::size_t size

Return type:

Function OutputComplexScalarData

sysc::OutputComplexScalarData::OutputComplexScalarData(const float *dataComplex, std::size_t size)

Provide a constructor for output complex scalar data with compact storage for complex components.

Parameters:

• dataComplex: - pointer to an array of complex single-precision scalars
• size: - number of scalars

Parameters:

• const float * dataComplex
• std::size_t size

Return type:

Function OutputComplexScalarData

sysc::OutputComplexScalarData::OutputComplexScalarData(const std::vector< float > &dataReal, const std::vector< float > &dataImaginary)

Create an output complex scalar data access object with split storage for compex components.

Parameters:

• dataReal: - reference to an STL vector of single-precision data, that stores the real components of the complex scalars.
• dataImaginary: - reference to an STL vector of single-precision data, that stores the imaginary components of the complex scalars.

Parameters:

• const std::vector< float > & dataReal
• const std::vector< float > & dataImaginary

Return type:

Function OutputComplexScalarData

sysc::OutputComplexScalarData::OutputComplexScalarData(const float *dataReal, const float *dataImaginary, std::size_t size)

Create an output complex scalar data access object with split storage for compex components.

Parameters:

• dataReal: - pointer to an array of single-precision data, that stores the real components of the complex scalars.
• dataImaginary: - pointer to an array of single-precision data, that stores the imaginary components of the complex scalars.
• size: - number of complex scalars

Parameters:

• const float * dataReal
• const float * dataImaginary
• std::size_t size

Return type:

Function OutputComplexScalarData

sysc::OutputComplexScalarData::OutputComplexScalarData()=default

Provide a default constructor.

Return type:

Function OutputComplexScalarData

sysc::OutputComplexScalarData::OutputComplexScalarData(const OutputComplexScalarData &)=default

Provide a copy-constructor.

Parameters:

• const OutputComplexScalarData &

Return type:

Function OutputComplexScalarData

sysc::OutputComplexScalarData::OutputComplexScalarData(OutputComplexScalarData &&)=default

Provide a move-constructor.

Parameters:

• OutputComplexScalarData &&

Return type:

Function operator=

OutputComplexScalarData& sysc::OutputComplexScalarData::operator=(const OutputComplexScalarData &)=default

Provide a copy-assign operator.

Parameters:

• const OutputComplexScalarData &

Return type: OutputComplexScalarData &

Function operator=

OutputComplexScalarData& sysc::OutputComplexScalarData::operator=(OutputComplexScalarData &&)=default

Provide a move-assign operator.

Parameters:

• OutputComplexScalarData &&

Return type: OutputComplexScalarData &

Function size

std::size_t sysc::OutputComplexScalarData::size() const noexcept

Get the size of data.

Return type: std::size_t

Function empty

bool sysc::OutputComplexScalarData::empty() const noexcept

Check if array "data" is empty.

Return type: bool

Function getDataType

sysc::PrimitiveType sysc::OutputComplexScalarData::getDataType() const noexcept

Get the primitive type of data.

For internal use only (no back-compatibility guarantee).

Return type: sysc::PrimitiveType

Function isSplitComplex

bool sysc::OutputComplexScalarData::isSplitComplex() const noexcept

Query whether it's a split or compact vector layout.

For internal use only (no back-compatibility guarantee).

Return type: bool

Function getData1

const void* sysc::OutputComplexScalarData::getData1() const noexcept

Get pointer to data1.

For internal use only (no back-compatibility guarantee).

Return type: const void *

Function getData2

const void* sysc::OutputComplexScalarData::getData2() const noexcept

Get pointer to data2.

For internal use only (no back-compatibility guarantee).

Return type: const void *

References:

• sysc::Double