Structure sysc::InputComplexScalarData
Last update: 09.03.2026
Definition: InputComplexScalarData.hpp (line 22)
Provide a class for input complex scalar data.
Input scalar data provides read and write access to an array of complex scalars.
Members
- empty
- getData1
- getData2
- getDataType
- InputComplexScalarData
- InputComplexScalarData
- InputComplexScalarData
- InputComplexScalarData
- InputComplexScalarData
- InputComplexScalarData
- InputComplexScalarData
- InputComplexScalarData
- InputComplexScalarData
- InputComplexScalarData
- InputComplexScalarData
- InputComplexScalarData
- InputComplexScalarData
- isSplitComplex
- m_data1
- m_data2
- m_dataType
- m_isSplitComplex
- m_size
- operator=
- operator=
- size
Private attributes
Variable m_dataType
Definition: InputComplexScalarData.hpp (line 259)
PrimitiveType sysc::InputComplexScalarData::m_dataType {[PrimitiveType::Double](group__SystemCouplingParticipantAPIs.md#group__SystemCouplingParticipantAPIs_1ggad3b1c73e4a63f4d292d65f3db875e844a29843d2c1bb5760f768dcc066dac1ac1)}
Type: PrimitiveType
Variable m_isSplitComplex
Definition: InputComplexScalarData.hpp (line 260)
bool sysc::InputComplexScalarData::m_isSplitComplex {false}
Type: bool
Variable m_data1
Definition: InputComplexScalarData.hpp (line 262)
void* sysc::InputComplexScalarData::m_data1 {nullptr}
Type: void *
Variable m_data2
Definition: InputComplexScalarData.hpp (line 263)
void* sysc::InputComplexScalarData::m_data2 {nullptr}
Type: void *
Variable m_size
Definition: InputComplexScalarData.hpp (line 265)
std::size_t sysc::InputComplexScalarData::m_size {0}
Type: std::size_t
Public functions
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:
References:
Referenced by:
- InputComplexScalarData
- InputComplexScalarData
- InputComplexScalarData
- InputComplexScalarData
- InputComplexScalarData
- InputComplexScalarData
- InputComplexScalarData
- InputComplexScalarData
- operator=
- operator=
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:
References:
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:
References:
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:
References:
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:
References:
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:
References:
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:
References:
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:
References:
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:
References:
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:
References:
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:
- const InputComplexScalarData &
Return type:
References:
Function InputComplexScalarData
sysc::InputComplexScalarData::InputComplexScalarData(InputComplexScalarData &&)=default
Provide a move-constructor.
Parameters:
Return type:
References:
Function operator=
InputComplexScalarData & sysc::InputComplexScalarData::operator=(const InputComplexScalarData &)=default
Provide a copy-assign operator.
Parameters:
- const InputComplexScalarData &
Return type: InputComplexScalarData &
References:
Function operator=
InputComplexScalarData & sysc::InputComplexScalarData::operator=(InputComplexScalarData &&)=default
Provide a move-assign operator.
Parameters:
Return type: InputComplexScalarData &
References:
Function size
std::size_t sysc::InputComplexScalarData::size() const noexcept
Get the size of data.
Return type: std::size_t
Referenced by:
- InputComplexScalarData
- InputComplexScalarData
- InputComplexScalarData
- InputComplexScalarData
- InputComplexScalarData
- InputComplexScalarData
- InputComplexScalarData
- InputComplexScalarData
- InputComplexScalarData
- InputComplexScalarData
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 *