ccgsl 2.7.2
C++wrappersforGnuScientificLibrary
gsl::matrix_complex::vector_complex_ptr Struct Reference

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

Inheritance diagram for gsl::matrix_complex::vector_complex_ptr:
Inheritance graph
Collaboration diagram for gsl::matrix_complex::vector_complex_ptr:
Collaboration graph

Public Member Functions

 vector_complex_ptr (vector_complex const &v)
 Typically we have to construct from a vector_complex. More...
 
vector_complexoperator* ()
 Dereference operator. More...
 
vector_complexoperator-> ()
 Dereference operator. More...
 
- Public Member Functions inherited from gsl::vector_complex
 vector_complex ()
 The default constructor is only really useful for assigning to. More...
 
 vector_complex (size_t const n)
 The default constructor creates a new vector_complex with n elements. More...
 
 vector_complex (gsl_vector_complex *v)
 Could construct from a gsl_vector_complex. More...
 
 vector_complex (std::initializer_list< std::complex< double > > initializer_list)
 Could construct from a std::initializer_list in C++11. More...
 
 vector_complex (vector_complex const &v)
 The copy constructor. More...
 
vector_complexoperator= (vector_complex const &v)
 The assignment operator. More...
 
vector_complex clone () const
 The clone function. More...
 
 ~vector_complex ()
 The destructor only deletes the pointers if count reaches zero. More...
 
void wrap_gsl_vector_complex_without_ownership (gsl_vector_complex *v)
 This function is intended mainly for internal use. More...
 
bool operator== (vector_complex const &v) const
 Two vector_complex objects are identically equal if their elements are identical. More...
 
void reset ()
 Stop sharing ownership of the shared pointer. More...
 
 vector_complex (vector_complex &&v)
 Move constructor. More...
 
vector_complexoperator= (vector_complex &&v)
 Move operator. More...
 
bool operator!= (vector_complex const &v) const
 Two vector_complex objects are different equal if their elements are not identical. More...
 
bool operator< (vector_complex const &v) const
 A container needs to define an ordering for sorting. More...
 
bool operator> (vector_complex const &v) const
 A container needs to define an ordering for sorting. More...
 
bool operator<= (vector_complex const &v) const
 A container needs to define an ordering for sorting. More...
 
bool operator>= (vector_complex const &v) const
 A container needs to define an ordering for sorting. More...
 
iterator begin ()
 Get iterator pointing to first vector_complex element. More...
 
const_iterator begin () const
 Get iterator pointing to first vector_complex element. More...
 
iterator end ()
 Get iterator pointing beyond last vector_complex element. More...
 
const_iterator end () const
 Get iterator pointing beyond last vector_complex element. More...
 
size_type size () const
 The size (number of elements) of the vector_complex. More...
 
double * data ()
 Give access to the data block. More...
 
double 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. More...
 
bool empty () const
 Find if the vector_complex is empty. More...
 
void swap (vector_complex &v)
 Swap two vector_complex objects. More...
 
reverse_iterator rbegin ()
 Get iterator pointing to first vector_complex element. More...
 
const_reverse_iterator rbegin () const
 Get iterator pointing to first vector_complex element. More...
 
reverse_iterator rend ()
 Get iterator pointing beyond last vector_complex element. More...
 
const_reverse_iterator rend () const
 Get iterator pointing beyond last vector_complex element. More...
 
complex_ref operator[] (size_t const n)
 Get element at position n by reference ([] operator). More...
 
complex_ref const operator[] (size_t const n) const
 Get element at position n by reference ([] operator). More...
 
gsl_vector_complex * get ()
 Get the gsl_vector_complex. More...
 
gsl_vector_complex const * get () const
 Get the gsl_vector_complex. More...
 
bool unique () const
 Find if this is the only object sharing the gsl_vector_complex. More...
 
size_t use_count () const
 Find how many vector_complex objects share this pointer. More...
 
 operator bool () const
 Allow conversion to bool. More...
 
void set_zero ()
 C++ version of gsl_vector_complex_set_zero(). More...
 
void set_all (complex x)
 C++ version of gsl_vector_complex_set_all(). More...
 
int set_basis (size_t i)
 C++ version of gsl_vector_complex_set_basis(). More...
 
int memcpy (vector_complex const &src)
 C++ version of gsl_vector_complex_memcpy(). More...
 
int reverse ()
 C++ version of gsl_vector_complex_reverse(). More...
 
int swap_elements (size_t const i, size_t const j)
 C++ version of gsl_vector_complex_swap_elements(). More...
 
int add (vector_complex const &b)
 C++ version of gsl_vector_complex_add(). More...
 
int sub (vector_complex const &b)
 C++ version of gsl_vector_complex_sub(). More...
 
int mul (vector_complex const &b)
 C++ version of gsl_vector_complex_mul(). More...
 
int div (vector_complex const &b)
 C++ version of gsl_vector_complex_div(). More...
 
int scale (complex const x)
 C++ version of gsl_vector_complex_scale(). More...
 
int add_constant (complex const x)
 C++ version of gsl_vector_complex_add_constant(). More...
 
int axpby (complex const alpha, vector_complex const &x, complex const beta)
 C++ version of gsl_vector_complex_axpby(). More...
 
int isnull () const
 C++ version of gsl_vector_complex_isnull(). More...
 
int ispos () const
 C++ version of gsl_vector_complex_ispos(). More...
 
int isneg () const
 C++ version of gsl_vector_complex_isneg(). More...
 
int isnonneg () const
 C++ version of gsl_vector_complex_isnonneg(). More...
 
complex get (size_t const i) const
 C++ version of gsl_vector_complex_get(). More...
 
void set (size_t const i, complex x)
 C++ version of gsl_vector_complex_set(). More...
 
complex_ptr ptr (size_t const i)
 C++ version of gsl_vector_complex_ptr(). More...
 
complex_ptr const const_ptr (size_t const i)
 C++ version of gsl_vector_complex_const_ptr(). More...
 
int fread (FILE *stream)
 C++ version of gsl_vector_complex_fread(). More...
 
int fwrite (FILE *stream) const
 C++ version of gsl_vector_complex_fwrite(). More...
 
int fscanf (FILE *stream)
 C++ version of gsl_vector_complex_fscanf(). More...
 
int fprintf (FILE *stream, char const *format) const
 C++ version of gsl_vector_complex_fprintf(). More...
 
 vector_complex (block_complex &b, size_t const offset, size_t const n, size_t const stride=1)
 C++ version of gsl_vector_complex_alloc_from_block(). More...
 
 vector_complex (vector_complex &v, size_t const offset, size_t const n, size_t const stride=1)
 C++ version of gsl_vector_complex_alloc_from_vector(). More...
 
gsl::vector real ()
 C++ version of gsl_vector_complex_real(). More...
 
gsl::vector const const_real () const
 C++ version of gsl_vector_complex_const_real(). More...
 
gsl::vector const real () const
 Another C++ version of gsl_vector_complex_const_real(). More...
 
gsl::vector imag ()
 C++ version of gsl_vector_complex_imag(). More...
 
gsl::vector const const_imag () const
 C++ version of gsl_vector_complex_const_imag(). More...
 
gsl::vector const imag () const
 Another C++ version of gsl_vector_complex_const_imag(). More...
 
vector_complex subvector (size_t i, size_t n)
 C++ version of gsl_vector_complex_subvector(). More...
 
vector_complex subvector_with_stride (size_t i, size_t stride, size_t n)
 C++ version of gsl_vector_complex_subvector_with_stride(). More...
 
vector_complex const const_subvector (size_t i, size_t n) const
 C++ version of gsl_vector_complex_const_subvector(). More...
 
vector_complex const const_subvector_with_stride (size_t i, size_t stride, size_t n) const
 C++ version of gsl_vector_complex_const_subvector_with_stride(). More...
 

Additional Inherited Members

- Public Types inherited from gsl::vector_complex
typedef complex value_type
 A container must have a value_type. More...
 
typedef complex_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_ptr pointer
 A container must have a pointer type. More...
 
typedef complex_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
static vector_complex calloc (size_t const n)
 C++ version of gsl_vector_complex_calloc(). More...
 
static vector_complex view_array (double *v, size_t n)
 C++ version of gsl_vector_complex_view_array(). More...
 
static vector_complex view_array_with_stride (double *base, size_t stride, size_t n)
 C++ version of gsl_vector_complex_view_array_with_stride(). More...
 
static vector_complex const const_view_array (double const *v, size_t n)
 C++ version of gsl_vector_complex _const_view_array(). More...
 
static vector_complex const const_view_array_with_stride (double const *base, size_t stride, size_t n)
 C++ version of gsl_vector_complex_const_view_array_with_stride(). More...
 
template<typename ARRAY >
static vector_complex view_array (ARRAY &v, size_t n=0)
 C++ version of gsl_vector_complex_view_array(). More...
 
template<typename ARRAY >
static vector_complex view_array_with_stride (ARRAY &base, size_t stride, size_t n=0)
 C++ version of gsl_vector_complex_view_array_with_stride(). More...
 
template<typename ARRAY >
static vector_complex const const_view_array (ARRAY const &v, size_t n=0)
 C++ version of gsl_vector_complex _const_view_array(). More...
 
template<typename ARRAY >
static vector_complex const const_view_array_with_stride (ARRAY const &base, size_t stride, size_t n=0)
 C++ version of gsl_vector_complex_const_view_array_with_stride(). More...
 
static vector_complex alloc_row_from_matrix (matrix_complex &m, size_t const i)
 C++ version of gsl_vector_complex_alloc_row_from_matrix(). More...
 
static vector_complex alloc_col_from_matrix (matrix_complex &m, size_t const j)
 C++ version of gsl_vector_complex_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.hpp.

Constructor & Destructor Documentation

◆ vector_complex_ptr()

gsl::matrix_complex::vector_complex_ptr::vector_complex_ptr ( vector_complex const &  v)
inline

Typically we have to construct from a vector_complex.

Parameters
vThe vector_complex to construct from.

Definition at line 219 of file matrix_complex.hpp.

Member Function Documentation

◆ operator*()

vector_complex & gsl::matrix_complex::vector_complex_ptr::operator* ( )
inline

Dereference operator.

Returns
a vector_complex

Definition at line 224 of file matrix_complex.hpp.

◆ operator->()

vector_complex * gsl::matrix_complex::vector_complex_ptr::operator-> ( )
inline

Dereference operator.

Returns
a pointer to a vector_complex

Definition at line 229 of file matrix_complex.hpp.


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