ccgsl 2.7.2
C++wrappersforGnuScientificLibrary
gsl::matrix_complex_float::vector_complex_float_ptr Struct Reference

This is a pointer-like type for iterator return values. More...

Inheritance diagram for gsl::matrix_complex_float::vector_complex_float_ptr:
Inheritance graph
Collaboration diagram for gsl::matrix_complex_float::vector_complex_float_ptr:
Collaboration graph

Public Member Functions

 vector_complex_float_ptr (vector_complex_float const &v)
 Typically we have to construct from a vector_complex_float. More...
 
vector_complex_floatoperator* ()
 Dereference operator. More...
 
vector_complex_floatoperator-> ()
 Dereference operator. More...
 
- Public Member Functions inherited from gsl::vector_complex_float
 vector_complex_float ()
 The default constructor is only really useful for assigning to. More...
 
 vector_complex_float (size_t const n)
 The default constructor creates a new vector_complex_float with n elements. More...
 
 vector_complex_float (gsl_vector_complex_float *v)
 Could construct from a gsl_vector_complex_float. More...
 
 vector_complex_float (std::initializer_list< std::complex< float > > initializer_list)
 Could construct from a std::initializer_list in C++11. More...
 
 vector_complex_float (vector_complex_float const &v)
 The copy constructor. More...
 
vector_complex_floatoperator= (vector_complex_float const &v)
 The assignment operator. More...
 
vector_complex_float clone () const
 The clone function. More...
 
 ~vector_complex_float ()
 The destructor only deletes the pointers if count reaches zero. More...
 
void wrap_gsl_vector_complex_float_without_ownership (gsl_vector_complex_float *v)
 This function is intended mainly for internal use. More...
 
bool operator== (vector_complex_float const &v) const
 Two vector_complex_float objects are identically equal if their elements are identical. More...
 
void reset ()
 Stop sharing ownership of the shared pointer. More...
 
 vector_complex_float (vector_complex_float &&v)
 Move constructor. More...
 
vector_complex_floatoperator= (vector_complex_float &&v)
 Move operator. More...
 
bool operator!= (vector_complex_float const &v) const
 Two vector_complex_float objects are different equal if their elements are not identical. More...
 
bool operator< (vector_complex_float const &v) const
 A container needs to define an ordering for sorting. More...
 
bool operator> (vector_complex_float const &v) const
 A container needs to define an ordering for sorting. More...
 
bool operator<= (vector_complex_float const &v) const
 A container needs to define an ordering for sorting. More...
 
bool operator>= (vector_complex_float const &v) const
 A container needs to define an ordering for sorting. More...
 
iterator begin ()
 Get iterator pointing to first vector_complex_float element. More...
 
const_iterator begin () const
 Get iterator pointing to first vector_complex_float element. More...
 
iterator end ()
 Get iterator pointing beyond last vector_complex_float element. More...
 
const_iterator end () const
 Get iterator pointing beyond last vector_complex_float element. More...
 
size_type size () const
 The size (number of elements) of the vector_complex_float. More...
 
float * data ()
 Give access to the data block. More...
 
float const * data () const
 Give access to the data block. More...
 
size_type max_size () const
 The max size (number of elements) of the vector_complex_float. More...
 
bool empty () const
 Find if the vector_complex_float is empty. More...
 
void swap (vector_complex_float &v)
 Swap two vector_complex_float objects. More...
 
reverse_iterator rbegin ()
 Get iterator pointing to first vector_complex_float element. More...
 
const_reverse_iterator rbegin () const
 Get iterator pointing to first vector_complex_float element. More...
 
reverse_iterator rend ()
 Get iterator pointing beyond last vector_complex_float element. More...
 
const_reverse_iterator rend () const
 Get iterator pointing beyond last vector_complex_float element. More...
 
complex_float_ref operator[] (size_t const n)
 Get element at position n by reference ([] operator). More...
 
complex_float_ref const operator[] (size_t const n) const
 Get element at position n by reference ([] operator). More...
 
gsl_vector_complex_float * get ()
 Get the gsl_vector_complex_float. More...
 
gsl_vector_complex_float const * get () const
 Get the gsl_vector_complex_float. More...
 
bool unique () const
 Find if this is the only object sharing the gsl_vector_complex_float. More...
 
size_t use_count () const
 Find how many vector_complex_float objects share this pointer. More...
 
 operator bool () const
 Allow conversion to bool. More...
 
void set_zero ()
 C++ version of gsl_vector_complex_float_set_zero(). More...
 
void set_all (complex_float x)
 C++ version of gsl_vector_complex_float_set_all(). More...
 
int set_basis (size_t i)
 C++ version of gsl_vector_complex_float_set_basis(). More...
 
int memcpy (vector_complex_float const &src)
 C++ version of gsl_vector_complex_float_memcpy(). More...
 
int reverse ()
 C++ version of gsl_vector_complex_float_reverse(). More...
 
int swap_elements (size_t const i, size_t const j)
 C++ version of gsl_vector_complex_float_swap_elements(). More...
 
int add (vector_complex_float const &b)
 C++ version of gsl_vector_complex_float_add(). More...
 
int sub (vector_complex_float const &b)
 C++ version of gsl_vector_complex_float_sub(). More...
 
int mul (vector_complex_float const &b)
 C++ version of gsl_vector_complex_float_mul(). More...
 
int div (vector_complex_float const &b)
 C++ version of gsl_vector_complex_float_div(). More...
 
int scale (complex_float const x)
 C++ version of gsl_vector_complex_float_scale(). More...
 
int add_constant (complex_float const x)
 C++ version of gsl_vector_complex_float_add_constant(). More...
 
int axpby (complex_float const alpha, vector_complex_float const &x, complex_float const beta)
 C++ version of gsl_vector_complex_float_axpby(). More...
 
int isnull () const
 C++ version of gsl_vector_complex_float_isnull(). More...
 
int ispos () const
 C++ version of gsl_vector_complex_float_ispos(). More...
 
int isneg () const
 C++ version of gsl_vector_complex_float_isneg(). More...
 
int isnonneg () const
 C++ version of gsl_vector_complex_float_isnonneg(). More...
 
complex_float get (size_t const i) const
 C++ version of gsl_vector_complex_float_get(). More...
 
void set (size_t const i, complex_float x)
 C++ version of gsl_vector_complex_float_set(). More...
 
complex_float_ptr ptr (size_t const i)
 C++ version of gsl_vector_complex_float_ptr(). More...
 
complex_float_ptr const const_ptr (size_t const i)
 C++ version of gsl_vector_complex_float_const_ptr(). More...
 
int fread (FILE *stream)
 C++ version of gsl_vector_complex_float_fread(). More...
 
int fwrite (FILE *stream) const
 C++ version of gsl_vector_complex_float_fwrite(). More...
 
int fscanf (FILE *stream)
 C++ version of gsl_vector_complex_float_fscanf(). More...
 
int fprintf (FILE *stream, char const *format) const
 C++ version of gsl_vector_complex_float_fprintf(). More...
 
 vector_complex_float (block_complex_float &b, size_t const offset, size_t const n, size_t const stride=1)
 C++ version of gsl_vector_complex_float_alloc_from_block(). More...
 
 vector_complex_float (vector_complex_float &v, size_t const offset, size_t const n, size_t const stride=1)
 C++ version of gsl_vector_complex_float_alloc_from_vector(). More...
 
gsl::vector_float real ()
 C++ version of gsl_vector_complex_real(). More...
 
gsl::vector_float const const_real () const
 C++ version of gsl_vector_complex_const_real(). More...
 
gsl::vector_float const real () const
 Another C++ version of gsl_vector_complex_const_real(). More...
 
gsl::vector_float imag ()
 C++ version of gsl_vector_complex_imag(). More...
 
gsl::vector_float const const_imag () const
 C++ version of gsl_vector_complex_const_imag(). More...
 
gsl::vector_float const imag () const
 Another C++ version of gsl_vector_complex_const_imag(). More...
 
vector_complex_float subvector (size_t i, size_t n)
 C++ version of gsl_vector_complex_float_subvector(). More...
 
vector_complex_float subvector_with_stride (size_t i, size_t stride, size_t n)
 C++ version of gsl_vector_complex_float_subvector_with_stride(). More...
 
vector_complex_float const const_subvector (size_t i, size_t n) const
 C++ version of gsl_vector_complex_float_const_subvector(). More...
 
vector_complex_float const const_subvector_with_stride (size_t i, size_t stride, size_t n) const
 C++ version of gsl_vector_complex_float_const_subvector_with_stride(). More...
 

Additional Inherited Members

- Public Types inherited from gsl::vector_complex_float
typedef complex_float value_type
 A container must have a value_type. More...
 
typedef complex_float_ref reference
 A container must have a reference type. More...
 
typedef reference const const_reference
 A container must have a constant reference type. More...
 
typedef complex_float_ptr pointer
 A container must have a pointer type. More...
 
typedef complex_float_ptr const const_pointer
 A container must have a constant pointer type. More...
 
typedef const_iterator_t< false > const_iterator
 The const_iterator type. More...
 
typedef iterator_t< false > iterator
 The iterator type. More...
 
typedef const_iterator_t< true > const_reverse_iterator
 The const_reverse_t type. More...
 
typedef iterator_t< true > reverse_iterator
 The reverse_iterator type. More...
 
typedef const_iterator::difference_type difference_type
 A container must have a difference_type. More...
 
typedef size_t size_type
 A container must have a size_type. More...
 
- Static Public Member Functions inherited from gsl::vector_complex_float
static vector_complex_float calloc (size_t const n)
 C++ version of gsl_vector_complex_float_calloc(). More...
 
static vector_complex_float view_array (float *v, size_t n)
 C++ version of gsl_vector_complex_float_view_array(). More...
 
static vector_complex_float view_array_with_stride (float *base, size_t stride, size_t n)
 C++ version of gsl_vector_complex_float_view_array_with_stride(). More...
 
static vector_complex_float const const_view_array (float const *v, size_t n)
 C++ version of gsl_vector_complex_float _const_view_array(). More...
 
static vector_complex_float const const_view_array_with_stride (float const *base, size_t stride, size_t n)
 C++ version of gsl_vector_complex_float_const_view_array_with_stride(). More...
 
template<typename ARRAY >
static vector_complex_float view_array (ARRAY &v, size_t n=0)
 C++ version of gsl_vector_complex_float_view_array(). More...
 
template<typename ARRAY >
static vector_complex_float view_array_with_stride (ARRAY &base, size_t stride, size_t n=0)
 C++ version of gsl_vector_complex_float_view_array_with_stride(). More...
 
template<typename ARRAY >
static vector_complex_float const const_view_array (ARRAY const &v, size_t n=0)
 C++ version of gsl_vector_complex_float _const_view_array(). More...
 
template<typename ARRAY >
static vector_complex_float const const_view_array_with_stride (ARRAY const &base, size_t stride, size_t n=0)
 C++ version of gsl_vector_complex_float_const_view_array_with_stride(). More...
 
static vector_complex_float alloc_row_from_matrix (matrix_complex_float &m, size_t const i)
 C++ version of gsl_vector_complex_float_alloc_row_from_matrix(). More...
 
static vector_complex_float alloc_col_from_matrix (matrix_complex_float &m, size_t const j)
 C++ version of gsl_vector_complex_float_alloc_col_from_matrix(). More...
 

Detailed Description

This is a pointer-like type for iterator return values.

Definition at line 214 of file matrix_complex_float.hpp.

Constructor & Destructor Documentation

◆ vector_complex_float_ptr()

gsl::matrix_complex_float::vector_complex_float_ptr::vector_complex_float_ptr ( vector_complex_float const &  v)
inline

Typically we have to construct from a vector_complex_float.

Parameters
vThe vector_complex_float to construct from.

Definition at line 219 of file matrix_complex_float.hpp.

Member Function Documentation

◆ operator*()

vector_complex_float & gsl::matrix_complex_float::vector_complex_float_ptr::operator* ( )
inline

Dereference operator.

Returns
a vector_complex

Definition at line 224 of file matrix_complex_float.hpp.

◆ operator->()

vector_complex_float * gsl::matrix_complex_float::vector_complex_float_ptr::operator-> ( )
inline

Dereference operator.

Returns
a pointer to a vector_complex_float

Definition at line 229 of file matrix_complex_float.hpp.


The documentation for this struct was generated from the following file: