This class can be used like a pointer for complex_float objects so that we can iterate over a vector (for example) of them. More...
#include <complex_float.hpp>
Public Member Functions | |
| complex_float_ptr (float *dat) | |
| Typically we are given a pointer to the data storing the complex_float and need to construct a complex_float_ptr from it. More... | |
| complex_float_ref | operator* () |
| Dereference the pointer. More... | |
| complex_float_ref * | operator-> () |
| Dereference the pointer. More... | |
| complex_float_ref const | operator* () const |
| Dereference the pointer. More... | |
| complex_float_ref const * | operator-> () const |
| Dereference the pointer. More... | |
Additional Inherited Members | |
 Private Member Functions inherited from gsl::complex_float_ref | |
| complex_float_ref (float *dat) | |
| We use this in constructing complex_float_ptr objects. More... | |
| operator gsl_complex_float () const | |
Make sure this is convertible to gsl_complex_float. More... | |
| operator complex_float () const | |
Make sure this is convertible to complex_float. More... | |
| complex_float_ref () | |
| The default constructor is only really useful for assigning to. More... | |
| complex_float_ref (complex_float &z) | |
| Make sure we can construct from a complex_float. More... | |
| complex_float_ref & | operator= (complex_float const &z) |
| Assignment from complex_float. More... | |
| void | set_complex_float (float x, float y) |
| C++ version of GSL_SET_COMPLEX(). More... | |
| float | real () const |
| C++ version of GSL_REAL(). More... | |
| float | imag () const |
| C++ version of GSL_IMAG(). More... | |
| void | set_real (float x) |
| C++ version of GSL_SET_REAL(). More... | |
| void | set_imag (float y) |
| C++ version of GSL_SET_IMAG(). More... | |
| Private Attributes inherited from gsl::complex_float_ref | |
| float * | dat |
| The data. More... | |
Detailed Description
This class can be used like a pointer for complex_float objects so that we can iterate over a vector (for example) of them.
Definition at line 281 of file complex_float.hpp.
Constructor & Destructor Documentation
◆ complex_float_ptr()
|
inline |
Typically we are given a pointer to the data storing the complex_float and need to construct a complex_float_ptr from it.
- Parameters
-
dat A pointer to the data
Definition at line 288 of file complex_float.hpp.
Member Function Documentation
◆ operator*() [1/2]
|
inline |
Dereference the pointer.
- Returns
- the complex_float object
Definition at line 293 of file complex_float.hpp.
◆ operator*() [2/2]
|
inline |
Dereference the pointer.
- Returns
- the complex_float object
Definition at line 303 of file complex_float.hpp.
◆ operator->() [1/2]
|
inline |
Dereference the pointer.
- Returns
- a pointer to the complex_float object
Definition at line 298 of file complex_float.hpp.
◆ operator->() [2/2]
|
inline |
Dereference the pointer.
- Returns
- a pointer to the complex_float object
Definition at line 308 of file complex_float.hpp.
The documentation for this class was generated from the following file:
