System Coupling C++ library 2025 R1

sysc::InputComplexScalarData Class Reference

Last update: 17.07.2025

Provide a class for input complex scalar data. More...

#include <InputComplexScalarData.hpp>

Public Member Functions

 InputComplexScalarData (std::vector< std::complex< double >> &dataComplex)
 Provide a constructor for input complex scalar data with compact storage for complex components. More...
 
 InputComplexScalarData (std::complex< double > *dataComplex, std::size_t size)
 Provide a constructor for input complex scalar data with compact storage for complex components. More...
 
 InputComplexScalarData (double *dataComplex, std::size_t size)
 Provide a constructor for input complex scalar data with compact storage for complex components. More...
 
 InputComplexScalarData (std::vector< double > &dataReal, std::vector< double > &dataImaginary)
 Create an input complex scalar data access object with split storage for complex components. More...
 
 InputComplexScalarData (double *dataReal, double *dataImaginary, std::size_t size)
 Create an input complex scalar data access object with split storage for complex components. More...
 
 InputComplexScalarData (std::vector< std::complex< float >> &dataComplex)
 Provide a constructor for input complex scalar data with compact storage for complex components. More...
 
 InputComplexScalarData (std::complex< float > *dataComplex, std::size_t size)
 Provide a constructor for input complex scalar data with compact storage for complex components. More...
 
 InputComplexScalarData (float *dataComplex, std::size_t size)
 Provide a constructor for input complex scalar data with compact storage for complex components. More...
 
 InputComplexScalarData (std::vector< float > &dataReal, std::vector< float > &dataImaginary)
 Create an input complex scalar data access object with split storage for complex components. More...
 
 InputComplexScalarData (float *dataReal, float *dataImaginary, std::size_t size)
 Create an input complex scalar data access object with split storage for complex components. More...
 
 InputComplexScalarData ()=default
 Provide a default constructor.
 
 InputComplexScalarData (const InputComplexScalarData &)=default
 Provide a copy-constructor.
 
 InputComplexScalarData (InputComplexScalarData &&)=default
 Provide a move-constructor.
 
InputComplexScalarData & operator= (const InputComplexScalarData &)=default
 Provide a copy-assign operator.
 
InputComplexScalarData & operator= (InputComplexScalarData &&)=default
 Provide a move-assign operator.
 
std::size_t size () const noexcept
 Get the size of data.
 
bool empty () const noexcept
 Check if array "data" is empty.
 
sysc::PrimitiveType getDataType () const noexcept
 Get the primitive type of data. More...
 
bool isSplitComplex () const noexcept
 Query whether it's a split or compact vector layout. More...
 
void * getData1 () const noexcept
 Get pointer to data1. More...
 
void * getData2 () const noexcept
 Get pointer to data2. More...
 

Detailed Description

Provide a class for input complex scalar data.

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

Definition at line 24 of file InputComplexScalarData.hpp.

Constructor & Destructor Documentation

◆ InputComplexScalarData() [1/10]

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

◆ InputComplexScalarData() [2/10]

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

◆ InputComplexScalarData() [3/10]

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

◆ InputComplexScalarData() [4/10]

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.

◆ InputComplexScalarData() [5/10]

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

◆ InputComplexScalarData() [6/10]

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

◆ InputComplexScalarData() [7/10]

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

◆ InputComplexScalarData() [8/10]

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

◆ InputComplexScalarData() [9/10]

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.

◆ InputComplexScalarData() [10/10]

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

Member Function Documentation

◆ getData1()

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

Get pointer to data1.

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

◆ getData2()

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

Get pointer to data2.

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

References sysc::Double.

◆ getDataType()

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

Get the primitive type of data.

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

◆ 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).

Connect with Ansys