ccgsl 2.7.2
C++wrappersforGnuScientificLibrary
gsl::matrix::vector_ptr Struct Reference

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

Inheritance diagram for gsl::matrix::vector_ptr:
Inheritance graph
Collaboration diagram for gsl::matrix::vector_ptr:
Collaboration graph

Public Member Functions

 vector_ptr (vector const &v)
 Typically we have to construct from a vector. More...
 
vectoroperator* ()
 Dereference operator. More...
 
vectoroperator-> ()
 Dereference operator. More...
 
- Public Member Functions inherited from gsl::vector
 vector ()
 The default constructor is only really useful for assigning to. More...
 
 vector (size_t const n)
 The default constructor creates a new vector with n elements. More...
 
 vector (gsl_vector *v)
 Could construct from a gsl_vector. More...
 
 vector (std::initializer_list< double > initializer_list)
 Could construct from a std::initializer_list in C++11. More...
 
 vector (vector const &v)
 The copy constructor. More...
 
 vector (vector &v)
 The copy constructor. More...
 
vectoroperator= (vector const &v)
 The assignment operator. More...
 
template<typename V >
 vector (V &v, size_t const stride=1)
 Construct from an object that implements data() and size(). More...
 
vector clone () const
 The clone function. More...
 
 ~vector ()
 The destructor only deletes the pointers if count reaches zero. More...
 
void wrap_gsl_vector_without_ownership (gsl_vector *v)
 This function is intended mainly for internal use. More...
 
bool operator== (vector const &v) const
 Two vector objects are identically equal if their elements are identical. More...
 
void reset ()
 Stop sharing ownership of the shared pointer. More...
 
 vector (vector &&v)
 Move constructor. More...
 
vectoroperator= (vector &&v)
 Move operator. More...
 
bool operator!= (vector const &v) const
 Two vector objects are different equal if their elements are not identical. More...
 
bool operator< (vector const &v) const
 A container needs to define an ordering for sorting. More...
 
bool operator> (vector const &v) const
 A container needs to define an ordering for sorting. More...
 
bool operator<= (vector const &v) const
 A container needs to define an ordering for sorting. More...
 
bool operator>= (vector const &v) const
 A container needs to define an ordering for sorting. More...
 
iterator begin ()
 Get iterator pointing to first vector element. More...
 
const_iterator begin () const
 Get iterator pointing to first vector element. More...
 
iterator end ()
 Get iterator pointing beyond last vector element. More...
 
const_iterator end () const
 Get iterator pointing beyond last vector element. More...
 
size_type size () const
 The size (number of elements) of the vector. 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. More...
 
bool empty () const
 Find if the vector is empty. More...
 
void swap (vector &v)
 Swap two vector objects. More...
 
reverse_iterator rbegin ()
 Get iterator pointing to first vector element. More...
 
const_reverse_iterator rbegin () const
 Get iterator pointing to first vector element. More...
 
reverse_iterator rend ()
 Get iterator pointing beyond last vector element. More...
 
const_reverse_iterator rend () const
 Get iterator pointing beyond last vector element. More...
 
double & operator[] (size_t const n)
 Get element at position n by reference ([] operator). More...
 
double const & operator[] (size_t const n) const
 Get element at position n by reference ([] operator). More...
 
gsl_vector * get ()
 Get the gsl_vector. More...
 
gsl_vector const * get () const
 Get the gsl_vector. More...
 
bool unique () const
 Find if this is the only object sharing the gsl_vector. More...
 
size_t use_count () const
 Find how many vector objects share this pointer. More...
 
 operator bool () const
 Allow conversion to bool. More...
 
void set_zero ()
 C++ version of gsl_vector_set_zero(). More...
 
void set_all (double x)
 C++ version of gsl_vector_set_all(). More...
 
int set_basis (size_t i)
 C++ version of gsl_vector_set_basis(). More...
 
int memcpy (vector const &src)
 C++ version of gsl_vector_memcpy(). More...
 
int reverse ()
 C++ version of gsl_vector_reverse(). More...
 
int swap_elements (size_t const i, size_t const j)
 C++ version of gsl_vector_swap_elements(). More...
 
double max () const
 C++ version of gsl_vector_max(). More...
 
double min () const
 C++ version of gsl_vector_min(). More...
 
void minmax (double *min_out, double *max_out) const
 C++ version of gsl_vector_minmax(). More...
 
size_t max_index () const
 C++ version of gsl_vector_max_index(). More...
 
size_t min_index () const
 C++ version of gsl_vector_min_index(). More...
 
void minmax_index (size_t *imin, size_t *imax) const
 C++ version of gsl_vector_minmax_index(). More...
 
void minmax_index (size_t &imin, size_t &imax) const
 C++ version of gsl_vector_minmax_index(). More...
 
int add (vector const &b)
 C++ version of gsl_vector_add(). More...
 
int sub (vector const &b)
 C++ version of gsl_vector_sub(). More...
 
int mul (vector const &b)
 C++ version of gsl_vector_mul(). More...
 
int div (vector const &b)
 C++ version of gsl_vector_div(). More...
 
int scale (double const x)
 C++ version of gsl_vector_scale(). More...
 
int add_constant (double const x)
 C++ version of gsl_vector_add_constant(). More...
 
int axpby (double const alpha, vector const &x, double const beta)
 C++ version of gsl_vector_axpby(). More...
 
double sum (vector const &a) const
 C++ version of gsl_vector_sum(). More...
 
int isnull () const
 C++ version of gsl_vector_isnull(). More...
 
int ispos () const
 C++ version of gsl_vector_ispos(). More...
 
int isneg () const
 C++ version of gsl_vector_isneg(). More...
 
int isnonneg () const
 C++ version of gsl_vector_isnonneg(). More...
 
double get (size_t const i) const
 C++ version of gsl_vector_get(). More...
 
void set (size_t const i, double x)
 C++ version of gsl_vector_set(). More...
 
double * ptr (size_t const i)
 C++ version of gsl_vector_ptr(). More...
 
double const * const_ptr (size_t const i) const
 C++ version of gsl_vector_const_ptr(). More...
 
int fread (FILE *stream)
 C++ version of gsl_vector_fread(). More...
 
int fwrite (FILE *stream) const
 C++ version of gsl_vector_fwrite(). More...
 
int fscanf (FILE *stream)
 C++ version of gsl_vector_fscanf(). More...
 
int fprintf (FILE *stream, char const *format) const
 C++ version of gsl_vector_fprintf(). More...
 
 vector (block &b, size_t const offset, size_t const n, size_t const stride=1)
 C++ version of gsl_vector_alloc_from_block(). More...
 
 vector (vector &v, size_t const offset, size_t const n, size_t const stride=1)
 C++ version of gsl_vector_alloc_from_vector(). More...
 
vector subvector (size_t i, size_t n)
 C++ version of gsl_vector_subvector(). More...
 
vector subvector_with_stride (size_t i, size_t stride, size_t n)
 C++ version of gsl_vector_subvectorwith_stride(). More...
 
vector const const_subvector (size_t i, size_t n) const
 C++ version of gsl_vector_const_subvector(). More...
 
vector const const_subvector_with_stride (size_t i, size_t stride, size_t n) const
 C++ version of gsl_vector_const_subvector_with_stride(). More...
 

Additional Inherited Members

- Public Types inherited from gsl::vector
typedef double value_type
 A container must have a value_type. More...
 
typedef value_typereference
 A container must have a reference type. More...
 
typedef value_type const & const_reference
 A container must have a constant reference type. More...
 
typedef value_typepointer
 A container must have a pointer type. More...
 
typedef value_type 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
static vector calloc (size_t const n)
 C++ version of gsl_vector_calloc(). More...
 
static vector view_array (double *v, size_t n)
 C++ version of gsl_vector_view_array(). More...
 
static vector view_array_with_stride (double *base, size_t stride, size_t n)
 C++ version of gsl_vector_view_array_with_stride(). More...
 
static vector const const_view_array (double const *v, size_t n)
 C++ version of gsl_vector _const_view_array(). More...
 
static vector const const_view_array_with_stride (double const *base, size_t stride, size_t n)
 C++ version of gsl_vector_const_view_array_with_stride(). More...
 
template<typename ARRAY >
static vector view_array (ARRAY &v, size_t n=0)
 C++ version of gsl_vector_view_array(). More...
 
template<typename ARRAY >
static vector view_array_with_stride (ARRAY &base, size_t stride, size_t n=0)
 C++ version of gsl_vector_view_array_with_stride(). More...
 
template<typename ARRAY >
static vector const const_view_array (ARRAY const &v, size_t n=0)
 C++ version of gsl_vector _const_view_array(). More...
 
template<typename ARRAY >
static vector const const_view_array_with_stride (ARRAY const &base, size_t stride, size_t n=0)
 C++ version of gsl_vector_const_view_array_with_stride(). More...
 
static vector alloc_row_from_matrix (matrix &m, size_t const i)
 C++ version of gsl_vector_alloc_row_from_matrix(). More...
 
static vector alloc_col_from_matrix (matrix &m, size_t const j)
 C++ version of gsl_vector_alloc_col_from_matrix(). More...
 
static double get (gsl_vector const *v, size_t const i)
 C++ version of get(). More...
 

Detailed Description

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

Definition at line 255 of file matrix.hpp.

Constructor & Destructor Documentation

◆ vector_ptr()

gsl::matrix::vector_ptr::vector_ptr ( vector const &  v)
inline

Typically we have to construct from a vector.

Parameters
vThe vector to construct from.

Definition at line 260 of file matrix.hpp.

Member Function Documentation

◆ operator*()

vector & gsl::matrix::vector_ptr::operator* ( )
inline

Dereference operator.

Returns
a vector

Definition at line 265 of file matrix.hpp.

◆ operator->()

vector * gsl::matrix::vector_ptr::operator-> ( )
inline

Dereference operator.

Returns
a pointer to a vector

Definition at line 270 of file matrix.hpp.


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