Structure sysc::OutputComplexScalarData
Last update: 09.03.2026
Definition: OutputComplexScalarData.hpp (line 23)
Provide a struct 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
- OutputComplexScalarData
- size
Private attributes
Variable m_dataType
Definition: OutputComplexScalarData.hpp (line 278)
sysc::PrimitiveType sysc::OutputComplexScalarData::m_dataType {[sysc::Double](group__SystemCouplingParticipantAPIs.md#group__SystemCouplingParticipantAPIs_1ggad3b1c73e4a63f4d292d65f3db875e844a29843d2c1bb5760f768dcc066dac1ac1)}
Type: sysc::PrimitiveType
Variable m_isSplitComplex
Definition: OutputComplexScalarData.hpp (line 279)
bool sysc::OutputComplexScalarData::m_isSplitComplex {false}
Type: bool
Variable m_data1
Definition: OutputComplexScalarData.hpp (line 281)
const void* sysc::OutputComplexScalarData::m_data1 {nullptr}
Type: const void *
Variable m_data2
Definition: OutputComplexScalarData.hpp (line 282)
const void* sysc::OutputComplexScalarData::m_data2 {nullptr}
Type: const void *
Variable m_size
Definition: OutputComplexScalarData.hpp (line 284)
std::size_t sysc::OutputComplexScalarData::m_size {0}
Type: std::size_t
Public functions
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:
References:
Referenced by:
- operator=
- operator=
- OutputComplexScalarData
- OutputComplexScalarData
- OutputComplexScalarData
- OutputComplexScalarData
- OutputComplexScalarData
- OutputComplexScalarData
- OutputComplexScalarData
- OutputComplexScalarData
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:
References:
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:
References:
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:
References:
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:
References:
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:
References:
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:
References:
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:
References:
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:
References:
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:
References:
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:
References:
Function OutputComplexScalarData
sysc::OutputComplexScalarData::OutputComplexScalarData(OutputComplexScalarData &&)=default
Provide a move-constructor.
Parameters:
Return type:
References:
Function operator=
OutputComplexScalarData & sysc::OutputComplexScalarData::operator=(const OutputComplexScalarData &)=default
Provide a copy-assign operator.
Parameters:
- const OutputComplexScalarData &
Return type: OutputComplexScalarData &
References:
Function operator=
OutputComplexScalarData & sysc::OutputComplexScalarData::operator=(OutputComplexScalarData &&)=default
Provide a move-assign operator.
Parameters:
Return type: OutputComplexScalarData &
References:
Function OutputComplexScalarData
sysc::OutputComplexScalarData::OutputComplexScalarData(InputComplexScalarData icsd)
Provide a constructor from input data.
Parameters:
Return type:
References:
Function size
std::size_t sysc::OutputComplexScalarData::size() const noexcept
Get the size of data.
Return type: std::size_t
Referenced by:
- OutputComplexScalarData
- OutputComplexScalarData
- OutputComplexScalarData
- OutputComplexScalarData
- OutputComplexScalarData
- OutputComplexScalarData
- OutputComplexScalarData
- OutputComplexScalarData
- OutputComplexScalarData
- OutputComplexScalarData
- OutputComplexScalarData
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
Referenced by:
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
Referenced by:
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 *
Referenced by:
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 *
Referenced by: