Class sysc::InputComplexVectorData

Definition: InputComplexVectorData.hpp (line 29)

Provide a class for input complex vector data.

Input vector data provides read and write access to an array of complex vector data.

The size is the total number of complex vectors, not the total number of components, i.e. if all data is stored in one contiguous array, then size is 1/6 the size of that array.

Members

• empty
• getData1
• getData2
• getData3
• getData4
• getData5
• getData6
• getDataType
• getDimension
• InputComplexVectorData
• InputComplexVectorData
• InputComplexVectorData
• InputComplexVectorData
• InputComplexVectorData
• InputComplexVectorData
• InputComplexVectorData
• InputComplexVectorData
• InputComplexVectorData
• InputComplexVectorData
• InputComplexVectorData
• InputComplexVectorData
• InputComplexVectorData
• InputComplexVectorData
• InputComplexVectorData
• InputComplexVectorData
• InputComplexVectorData
• InputComplexVectorData
• InputComplexVectorData
• InputComplexVectorData
• InputComplexVectorData
• InputComplexVectorData
• InputComplexVectorData
• InputComplexVectorData
• InputComplexVectorData
• InputComplexVectorData
• InputComplexVectorData
• InputComplexVectorData
• InputComplexVectorData
• isSplitComplex
• isSplitVector
• m_data1
• m_data2
• m_data3
• m_data4
• m_data5
• m_data6
• m_dataType
• m_dimension
• m_isSplitComplex
• m_isSplitVector
• m_size
• operator=
• operator=
• size

Private attributes

Variable m_dataType

Definition: InputComplexVectorData.hpp (line 615)

sysc::PrimitiveType sysc::InputComplexVectorData::m_dataType {sysc::Double}

Type: sysc::PrimitiveType

Variable m_isSplitVector

Definition: InputComplexVectorData.hpp (line 616)

bool sysc::InputComplexVectorData::m_isSplitVector {false}

Type: bool

Variable m_isSplitComplex

Definition: InputComplexVectorData.hpp (line 617)

bool sysc::InputComplexVectorData::m_isSplitComplex {false}

Type: bool

Variable m_data1

Definition: InputComplexVectorData.hpp (line 619)

void* sysc::InputComplexVectorData::m_data1 {nullptr}

Type: void *

Variable m_data2

Definition: InputComplexVectorData.hpp (line 620)

void* sysc::InputComplexVectorData::m_data2 {nullptr}

Type: void *

Variable m_data3

Definition: InputComplexVectorData.hpp (line 621)

void* sysc::InputComplexVectorData::m_data3 {nullptr}

Type: void *

Variable m_data4

Definition: InputComplexVectorData.hpp (line 622)

void* sysc::InputComplexVectorData::m_data4 {nullptr}

Type: void *

Variable m_data5

Definition: InputComplexVectorData.hpp (line 623)

void* sysc::InputComplexVectorData::m_data5 {nullptr}

Type: void *

Variable m_data6

Definition: InputComplexVectorData.hpp (line 624)

void* sysc::InputComplexVectorData::m_data6 {nullptr}

Type: void *

Variable m_size

Definition: InputComplexVectorData.hpp (line 626)

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

Type: std::size_t

Variable m_dimension

Definition: InputComplexVectorData.hpp (line 627)

Dimension sysc::InputComplexVectorData::m_dimension {Dimension::D3}

Type: Dimension

Public functions

Function InputComplexVectorData

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

Provide a constructor for input complex vector data with compact storage for both vector components and complex components.

Parameters:

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

Parameters:

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

Return type:

Function InputComplexVectorData

sysc::InputComplexVectorData::InputComplexVectorData(std::vector< std::complex< double >> &dataComplex, Dimension dimension)

Provide a constructor for 2D input complex vector data with compact storage for both vector components and complex components.

Parameters:

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

Parameters:

• std::vector< std::complex< double >> & dataComplex
• Dimension dimension

Return type:

Function InputComplexVectorData

sysc::InputComplexVectorData::InputComplexVectorData(double *dataComplex, std::size_t size)

Provide a constructor for input complex vector data with compact storage for both vector components and complex components.

Parameters:

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

Parameters:

• double * dataComplex
• std::size_t size

Return type:

Function InputComplexVectorData

sysc::InputComplexVectorData::InputComplexVectorData(double *dataComplex, std::size_t size, Dimension dimension)

Provide a constructor for 2D input complex vector data with compact storage for both vector components and complex components.

Parameters:

• dataComplex: - pointer to an array of complex double-precision vectors
• size: - number of vectors.
• dimension: - dimension of complex vector data.

Parameters:

• double * dataComplex
• std::size_t size
• Dimension dimension

Return type:

Function InputComplexVectorData

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

Provide a constructor for input complex vector data with compact storage for both vector components and complex components.

Parameters:

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

Parameters:

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

Return type:

Function InputComplexVectorData

sysc::InputComplexVectorData::InputComplexVectorData(std::complex< double > *dataComplex, std::size_t size, Dimension dimension)

Provide a constructor for 2D input complex vector data with compact storage for both vector components and complex components.

Parameters:

• data: - pointer to an array of complex double-precision vectors.
• size: - number of vectors.
• dimension: - dimension of complex vector data.

Parameters:

• std::complex< double > * dataComplex
• std::size_t size
• Dimension dimension

Return type:

Function InputComplexVectorData

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

Create an input complex vector data access object with compact storage for vector components and split storage for complex components.

Parameters:

• dataReal: - reference to the STL vector of double-precision data, that stores the real components of the complex vectors in compact storage format.
• dataImaginary: - reference to the STL vector of double-precision data, that stores the imaginary components of the complex vectors in compact storage format.

Parameters:

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

Return type:

Function InputComplexVectorData

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

Create an input complex vector data access object with compact storage for vector components and split storage for complex components.

Parameters:

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

Parameters:

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

Return type:

Function InputComplexVectorData

sysc::InputComplexVectorData::InputComplexVectorData(std::vector< std::complex< double >> &dataComplex1, std::vector< std::complex< double >> &dataComplex2, std::vector< std::complex< double >> &dataComplex3)

Create an input complex vector data access object with split storage for vector components and compact storage for complex components.

Parameters:

• dataComplex1: - reference to the STL vector of complex double-precision data that stores the first components of the vectors of complex numbers.
• dataComplex2: - reference to the STL vector of complex double-precision data that stores the second components of the vectors of complex numbers.
• dataComplex3: - reference to the STL vector of complex double-precision data that stores the third components of the vectors of complex numbers.

Parameters:

• std::vector< std::complex< double >> & dataComplex1
• std::vector< std::complex< double >> & dataComplex2
• std::vector< std::complex< double >> & dataComplex3

Return type:

Function InputComplexVectorData

sysc::InputComplexVectorData::InputComplexVectorData(std::complex< double > *dataComplex1, std::complex< double > *dataComplex2, std::complex< double > *dataComplex3, std::size_t size)

Create an input complex vector data access object with split storage for vector components and compact storage for complex components.

Parameters:

• dataComplex1: - pointer to an array of double-precision complex data that stores the first components of the vectors of complex numbers.
• dataComplex2: - pointer to an array of double-precision complex data that stores the second components of the vectors of complex numbers.
• dataComplex3: - pointer to an array of double-precision complex data that stores the third components of the vectors of complex numbers.
• size: - number of vectors.

Parameters:

• std::complex< double > * dataComplex1
• std::complex< double > * dataComplex2
• std::complex< double > * dataComplex3
• std::size_t size

Return type:

Function InputComplexVectorData

sysc::InputComplexVectorData::InputComplexVectorData(double *dataComplex1, double *dataComplex2, double *dataComplex3, std::size_t size)

Create an input complex vector data access object with split storage for vector components and compact storage for complex components.

Parameters:

• dataComplex1: - pointer to an array of double-precision data that stores the first components of the vectors of complex numbers.
• dataComplex2: - pointer to an array of double-precision data that stores the second components of the vectors of complex numbers.
• dataComplex3: - pointer to an array of double-precision data that stores the third components of the vectors of complex numbers.
• size: - number of vectors.

Parameters:

• double * dataComplex1
• double * dataComplex2
• double * dataComplex3
• std::size_t size

Return type:

Function InputComplexVectorData

sysc::InputComplexVectorData::InputComplexVectorData(std::vector< double > &dataReal1, std::vector< double > &dataImaginary1, std::vector< double > &dataReal2, std::vector< double > &dataImaginary2, std::vector< double > &dataReal3, std::vector< double > &dataImaginary3)

Create an input complex vector data access object with split storage for vector components and split storage for complex components.

Parameters:

• dataReal1: - reference to the STL vector of double-precision data that stores the first real components of the vectors of complex numbers.
• dataImaginary1: - reference to the STL vector of double-precision data that stores the first imaginary components of the vectors of complex numbers.
• dataReal2: - reference to the STL vector of double-precision data that stores the second real components of the vectors of complex numbers.
• dataImaginary2: - reference to the STL vector of double-precision data that stores the second imaginary components of the vectors of complex numbers.
• dataReal3: - reference to the STL vector of double-precision data that stores the third real components of the vectors of complex numbers.
• dataImaginary3: - reference to the STL vector of double-precision data that stores the third imaginary components of the vectors of complex numbers.

Parameters:

• std::vector< double > & dataReal1
• std::vector< double > & dataImaginary1
• std::vector< double > & dataReal2
• std::vector< double > & dataImaginary2
• std::vector< double > & dataReal3
• std::vector< double > & dataImaginary3

Return type:

Function InputComplexVectorData

sysc::InputComplexVectorData::InputComplexVectorData(double *dataReal1, double *dataImaginary1, double *dataReal2, double *dataImaginary2, double *dataReal3, double *dataImaginary3, std::size_t size)

Create an input complex vector data access object with split storage for vector components and split storage for complex components.

Parameters:

• dataReal1: - pointer to an array of double-precision data that stores the first real components of the vectors of complex numbers.
• dataImaginary1: - pointer to an array of double-precision data that stores the first imaginary components of the vectors of complex numbers.
• dataReal2: - pointer to an array of double-precision data that stores the second real components of the vectors of complex numbers.
• dataImaginary2: - pointer to an array of double-precision data that stores the second imaginary components of the vectors of complex numbers.
• dataReal3: - pointer to an array of double-precision data that stores the third real components of the vectors of complex numbers.
• dataImaginary3: - pointer to an array of double-precision data that stores the third imaginary components of the vectors of complex numbers.
• size: - number of vectors.

Parameters:

• double * dataReal1
• double * dataImaginary1
• double * dataReal2
• double * dataImaginary2
• double * dataReal3
• double * dataImaginary3
• std::size_t size

Return type:

Function InputComplexVectorData

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

Provide a constructor for input complex vector data with compact storage for both vector components and complex components.

Parameters:

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

Parameters:

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

Return type:

Function InputComplexVectorData

sysc::InputComplexVectorData::InputComplexVectorData(std::vector< std::complex< float >> &dataComplex, Dimension dimension)

Provide a constructor for 2D input complex vector data with compact storage for both vector components and complex components.

Parameters:

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

Parameters:

• std::vector< std::complex< float >> & dataComplex
• Dimension dimension

Return type:

Function InputComplexVectorData

sysc::InputComplexVectorData::InputComplexVectorData(float *dataComplex, std::size_t size)

Provide a constructor for input complex vector data with compact storage for both vector components and complex components.

Parameters:

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

Parameters:

• float * dataComplex
• std::size_t size

Return type:

Function InputComplexVectorData

sysc::InputComplexVectorData::InputComplexVectorData(float *dataComplex, std::size_t size, Dimension dimension)

Provide a constructor for 2D input complex vector data with compact storage for both vector components and complex components.

Parameters:

• dataComplex: - pointer to an array of complex single-precision vectors.
• size: - number of vectors.
• dimension: dimension of complex vector data.

Parameters:

• float * dataComplex
• std::size_t size
• Dimension dimension

Return type:

Function InputComplexVectorData

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

Provide a constructor for input complex vector data with compact storage for both vector components and complex components.

Parameters:

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

Parameters:

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

Return type:

Function InputComplexVectorData

sysc::InputComplexVectorData::InputComplexVectorData(std::complex< float > *dataComplex, std::size_t size, Dimension dimension)

Provide a constructor for 2D input complex vector data with compact storage for both vector components and complex components.

Parameters:

• data: - pointer to an array of complex single-precision vectors.
• size: - number of vectors.
• dimension: dimension of complex vector data.

Parameters:

• std::complex< float > * dataComplex
• std::size_t size
• Dimension dimension

Return type:

Function InputComplexVectorData

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

Create an input complex vector data access object with compact storage for vector components and split storage for complex components.

Parameters:

• dataReal: - reference to the STL vector of single-precision data, that stores the real components of the complex vectors in compact storage format.
• dataImaginary: - reference to the STL vector of single-precision data, that stores the imaginary components of the complex vectors in compact storage format.

Parameters:

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

Return type:

Function InputComplexVectorData

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

Create an input complex vector data access object with compact storage for vector components and split storage for complex components.

Parameters:

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

Parameters:

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

Return type:

Function InputComplexVectorData

sysc::InputComplexVectorData::InputComplexVectorData(std::vector< std::complex< float >> &dataComplex1, std::vector< std::complex< float >> &dataComplex2, std::vector< std::complex< float >> &dataComplex3)

Create an input complex vector data access object with split storage for vector components and compact storage for complex components.

Parameters:

• dataComplex1: - reference to the STL vector of complex single-precision data that stores the first components of the vectors of complex numbers.
• dataComplex2: - reference to the STL vector of complex single-precision data that stores the second components of the vectors of complex numbers.
• dataComplex3: - reference to the STL vector of complex single-precision data that stores the third components of the vectors of complex numbers.

Parameters:

• std::vector< std::complex< float >> & dataComplex1
• std::vector< std::complex< float >> & dataComplex2
• std::vector< std::complex< float >> & dataComplex3

Return type:

Function InputComplexVectorData

sysc::InputComplexVectorData::InputComplexVectorData(std::complex< float > *dataComplex1, std::complex< float > *dataComplex2, std::complex< float > *dataComplex3, std::size_t size)

Create an input complex vector data access object with split storage for vector components and compact storage for complex components.

Parameters:

• dataComplex1: - pointer to an array of single-precision complex data that stores the first components of the vectors of complex numbers.
• dataComplex2: - pointer to an array of single-precision complex data that stores the second components of the vectors of complex numbers.
• dataComplex3: - pointer to an array of single-precision complex data that stores the third components of the vectors of complex numbers.
• size: - number of vectors.

Parameters:

• std::complex< float > * dataComplex1
• std::complex< float > * dataComplex2
• std::complex< float > * dataComplex3
• std::size_t size

Return type:

Function InputComplexVectorData

sysc::InputComplexVectorData::InputComplexVectorData(float *dataComplex1, float *dataComplex2, float *dataComplex3, std::size_t size)

Create an input complex vector data access object with split storage for vector components and compact storage for complex components.

Parameters:

• dataComplex1: - pointer to an array of single-precision data that stores the first components of the vectors of complex numbers.
• dataComplex2: - pointer to an array of single-precision data that stores the second components of the vectors of complex numbers.
• dataComplex3: - pointer to an array of single-precision data that stores the third components of the vectors of complex numbers.
• size: - number of vectors.

Parameters:

• float * dataComplex1
• float * dataComplex2
• float * dataComplex3
• std::size_t size

Return type:

Function InputComplexVectorData

sysc::InputComplexVectorData::InputComplexVectorData(std::vector< float > &dataReal1, std::vector< float > &dataImaginary1, std::vector< float > &dataReal2, std::vector< float > &dataImaginary2, std::vector< float > &dataReal3, std::vector< float > &dataImaginary3)

Create an input complex vector data access object with split storage for vector components and split storage for complex components.

Parameters:

• dataReal1: - reference to the STL vector of single-precision data that stores the first real components of the vectors of complex numbers.
• dataImaginary1: - reference to the STL vector of single-precision data that stores the first imaginary components of the vectors of complex numbers.
• dataReal2: - reference to the STL vector of single-precision data that stores the second real components of the vectors of complex numbers.
• dataImaginary2: - reference to the STL vector of single-precision data that stores the second imaginary components of the vectors of complex numbers.
• dataReal3: - reference to the STL vector of single-precision data that stores the third real components of the vectors of complex numbers.
• dataImaginary3: - reference to the STL vector of single-precision data that stores the third imaginary components of the vectors of complex numbers.

Parameters:

• std::vector< float > & dataReal1
• std::vector< float > & dataImaginary1
• std::vector< float > & dataReal2
• std::vector< float > & dataImaginary2
• std::vector< float > & dataReal3
• std::vector< float > & dataImaginary3

Return type:

Function InputComplexVectorData

sysc::InputComplexVectorData::InputComplexVectorData(float *dataReal1, float *dataImaginary1, float *dataReal2, float *dataImaginary2, float *dataReal3, float *dataImaginary3, std::size_t size)

Create an input complex vector data access object with split storage for vector components and split storage for complex components.

Parameters:

• dataReal1: - pointer to an array of single-precision data that stores the first real components of the vectors of complex numbers.
• dataImaginary1: - pointer to an array of single-precision data that stores the first imaginary components of the vectors of complex numbers.
• dataReal2: - pointer to an array of single-precision data that stores the second real components of the vectors of complex numbers.
• dataImaginary2: - pointer to an array of single-precision data that stores the second imaginary components of the vectors of complex numbers.
• dataReal3: - pointer to an array of single-precision data that stores the third real components of the vectors of complex numbers.
• dataImaginary3: - pointer to an array of single-precision data that stores the third imaginary components of the vectors of complex numbers.
• size: - number of vectors.

Parameters:

• float * dataReal1
• float * dataImaginary1
• float * dataReal2
• float * dataImaginary2
• float * dataReal3
• float * dataImaginary3
• std::size_t size

Return type:

Function InputComplexVectorData

sysc::InputComplexVectorData::InputComplexVectorData()=default

Provide a default constructor.

Return type:

Function InputComplexVectorData

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

Provide a copy-constructor.

Parameters:

• const InputComplexVectorData &

Return type:

Function InputComplexVectorData

sysc::InputComplexVectorData::InputComplexVectorData(InputComplexVectorData &&)=default

Provide a move-constructor.

Parameters:

• InputComplexVectorData &&

Return type:

Function operator=

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

Provide a copy-assign operator.

Parameters:

• const InputComplexVectorData &

Return type: InputComplexVectorData &

Function operator=

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

Provide a move-assign operator.

Parameters:

• InputComplexVectorData &&

Return type: InputComplexVectorData &

Function size

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

Get the size of data.

Return type: std::size_t

Function empty

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

Check if array "data" is empty.

Return type: bool

Function getDataType

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

Get the primitive type of data.

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

Return type: sysc::PrimitiveType

Function isSplitVector

bool sysc::InputComplexVectorData::isSplitVector() const noexcept

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

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

Return type: bool

Function isSplitComplex

bool sysc::InputComplexVectorData::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

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

Get pointer to data1.

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

Return type: void *

Function getData2

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

Get pointer to data2.

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

Return type: void *

Function getData3

void* sysc::InputComplexVectorData::getData3() const noexcept

Get pointer to data3.

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

Return type: void *

Function getData4

void* sysc::InputComplexVectorData::getData4() const noexcept

Get pointer to data4.

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

Return type: void *

Function getData5

void* sysc::InputComplexVectorData::getData5() const noexcept

Get pointer to data5.

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

Return type: void *

Function getData6

void* sysc::InputComplexVectorData::getData6() const noexcept

Get pointer to data6.

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

Return type: void *

Function getDimension

Dimension sysc::InputComplexVectorData::getDimension() const noexcept

Get the Dimension object.

Returns:

Dimension

Return type: Dimension

References:

• sysc::Double