Skip to main content

Class sysc::InputComplexScalarData

Definition: InputComplexScalarData.hpp (line 24)

Provide a class for input complex scalar data.

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

Members​

Private attributes​

Variable m_dataType​

Definition: InputComplexScalarData.hpp (line 219)

PrimitiveType sysc::InputComplexScalarData::m_dataType {PrimitiveType::Double}

Type: PrimitiveType

Variable m_isSplitComplex​

Definition: InputComplexScalarData.hpp (line 220)

bool sysc::InputComplexScalarData::m_isSplitComplex {false}

Type: bool

Variable m_data1​

Definition: InputComplexScalarData.hpp (line 222)

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

Type: void *

Variable m_data2​

Definition: InputComplexScalarData.hpp (line 223)

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

Type: void *

Variable m_size​

Definition: InputComplexScalarData.hpp (line 225)

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

Type: std::size_t

Public functions​

Function InputComplexScalarData​

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

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

Parameters:

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

Parameters:

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

Return type:

Function InputComplexScalarData​

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

Provide a constructor for input 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:

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

Return type:

Function InputComplexScalarData​

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

Provide a constructor for input 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:

  • double * dataComplex
  • std::size_t size

Return type:

Function InputComplexScalarData​

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

Create an input complex scalar data access object with split storage for complex 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:

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

Return type:

Function InputComplexScalarData​

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

Create an input complex scalar data access object with split storage for complex 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:

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

Return type:

Function InputComplexScalarData​

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

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

Parameters:

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

Parameters:

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

Return type:

Function InputComplexScalarData​

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

Provide a constructor for input 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:

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

Return type:

Function InputComplexScalarData​

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

Provide a constructor for input 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:

  • float * dataComplex
  • std::size_t size

Return type:

Function InputComplexScalarData​

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

Create an input complex scalar data access object with split storage for complex 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:

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

Return type:

Function InputComplexScalarData​

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

Create an input complex scalar data access object with split storage for complex 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:

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

Return type:

Function InputComplexScalarData​

sysc::InputComplexScalarData::InputComplexScalarData()=default

Provide a default constructor.

Return type:

Function InputComplexScalarData​

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

Provide a copy-constructor.

Parameters:

Return type:

Function InputComplexScalarData​

sysc::InputComplexScalarData::InputComplexScalarData(InputComplexScalarData &&)=default

Provide a move-constructor.

Parameters:

Return type:

Function operator=​

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

Provide a copy-assign operator.

Parameters:

Return type: InputComplexScalarData &

Function operator=​

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

Provide a move-assign operator.

Parameters:

Return type: InputComplexScalarData &

Function size​

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

Get the size of data.

Return type: std::size_t

Function empty​

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

Check if array "data" is empty.

Return type: bool

Function getDataType​

sysc::PrimitiveType sysc::InputComplexScalarData::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::InputComplexScalarData::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::InputComplexScalarData::getData1() const noexcept

Get pointer to data1.

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

Return type: void *

Function getData2​

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

Get pointer to data2.

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

Return type: void *

References:

Last updated on by rborsaru-ansys