ccgsl 2.7.2
C++wrappersforGnuScientificLibrary
gsl::matrix_ulong::vector_ulong_ptr Struct Reference

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

Inheritance diagram for gsl::matrix_ulong::vector_ulong_ptr:
Inheritance graph
Collaboration diagram for gsl::matrix_ulong::vector_ulong_ptr:
Collaboration graph

Public Member Functions

 vector_ulong_ptr (vector_ulong const &v)
 Typically we have to construct from a vector_ulong. More...
 
vector_ulongoperator* ()
 Dereference operator. More...
 
vector_ulongoperator-> ()
 Dereference operator. More...
 
- Public Member Functions inherited from gsl::vector_ulong
 vector_ulong ()
 The default constructor is only really useful for assigning to. More...
 
 vector_ulong (size_t const n)
 The default constructor creates a new vector_ulong with n elements. More...
 
 vector_ulong (gsl_vector_ulong *v)
 Could construct from a gsl_vector_ulong. More...
 
 vector_ulong (std::initializer_list< unsigned long > initializer_list)
 Could construct from a std::initializer_list in C++11. More...
 
 vector_ulong (vector_ulong const &v)
 The copy constructor. More...
 
 vector_ulong (vector_ulong &v)
 The copy constructor. More...
 
vector_ulongoperator= (vector_ulong const &v)
 The assignment operator. More...
 
template<typename V >
 vector_ulong (V &v, size_t const stride=1)
 Construct from an object that implements data() and size(). More...
 
vector_ulong clone () const
 The clone function. More...
 
 ~vector_ulong ()
 The destructor only deletes the pointers if count reaches zero. More...
 
void wrap_gsl_vector_ulong_without_ownership (gsl_vector_ulong *v)
 This function is intended mainly for internal use. More...
 
bool operator== (vector_ulong const &v) const
 Two vector_ulong objects are identically equal if their elements are identical. More...
 
void reset ()
 Stop sharing ownership of the shared pointer. More...
 
 vector_ulong (vector_ulong &&v)
 Move constructor. More...
 
vector_ulongoperator= (vector_ulong &&v)
 Move operator. More...
 
bool operator!= (vector_ulong const &v) const
 Two vector_ulong objects are different equal if their elements are not identical. More...
 
bool operator< (vector_ulong const &v) const
 A container needs to define an ordering for sorting. More...
 
bool operator> (vector_ulong const &v) const
 A container needs to define an ordering for sorting. More...
 
bool operator<= (vector_ulong const &v) const
 A container needs to define an ordering for sorting. More...
 
bool operator>= (vector_ulong const &v) const
 A container needs to define an ordering for sorting. More...
 
iterator begin ()
 Get iterator pointing to first vector_ulong element. More...
 
const_iterator begin () const
 Get iterator pointing to first vector_ulong element. More...
 
iterator end ()
 Get iterator pointing beyond last vector_ulong element. More...
 
const_iterator end () const
 Get iterator pointing beyond last vector_ulong element. More...
 
size_type size () const
 The size (number of elements) of the vector_ulong. More...
 
unsigned long * data ()
 Give access to the data block_ulong. More...
 
unsigned long const * data () const
 Give access to the data block_ulong. More...
 
size_type max_size () const
 The max size (number of elements) of the vector_ulong. More...
 
bool empty () const
 Find if the vector_ulong is empty. More...
 
void swap (vector_ulong &v)
 Swap two vector_ulong objects. More...
 
reverse_iterator rbegin ()
 Get iterator pointing to first vector_ulong element. More...
 
const_reverse_iterator rbegin () const
 Get iterator pointing to first vector_ulong element. More...
 
reverse_iterator rend ()
 Get iterator pointing beyond last vector_ulong element. More...
 
const_reverse_iterator rend () const
 Get iterator pointing beyond last vector_ulong element. More...
 
unsigned long & operator[] (size_t const n)
 Get element at position n by reference ([] operator). More...
 
unsigned long const & operator[] (size_t const n) const
 Get element at position n by reference ([] operator). More...
 
gsl_vector_ulong * get ()
 Get the gsl_vector_ulong. More...
 
gsl_vector_ulong const * get () const
 Get the gsl_vector_ulong. More...
 
bool unique () const
 Find if this is the only object sharing the gsl_vector_ulong. More...
 
size_t use_count () const
 Find how many vector_ulong objects share this pointer. More...
 
 operator bool () const
 Allow conversion to bool. More...
 
void set_zero ()
 C++ version of gsl_vector_ulong_set_zero(). More...
 
void set_all (unsigned long x)
 C++ version of gsl_vector_ulong_set_all(). More...
 
int set_basis (size_t i)
 C++ version of gsl_vector_ulong_set_basis(). More...
 
int memcpy (vector_ulong const &src)
 C++ version of gsl_vector_ulong_memcpy(). More...
 
int reverse ()
 C++ version of gsl_vector_ulong_reverse(). More...
 
int swap_elements (size_t const i, size_t const j)
 C++ version of gsl_vector_ulong_swap_elements(). More...
 
unsigned long max () const
 C++ version of gsl_vector_ulong_max(). More...
 
unsigned long min () const
 C++ version of gsl_vector_ulong_min(). More...
 
void minmax (unsigned long *min_out, unsigned long *max_out) const
 C++ version of gsl_vector_ulong_minmax(). More...
 
void minmax (unsigned long &min_out, unsigned long &max_out) const
 C++ version of gsl_vector_ulong_minmax(). More...
 
size_t max_index () const
 C++ version of gsl_vector_ulong_max_index(). More...
 
size_t min_index () const
 C++ version of gsl_vector_ulong_min_index(). More...
 
void minmax_index (size_t *imin, size_t *imax) const
 C++ version of gsl_vector_ulong_minmax_index(). More...
 
int add (vector_ulong const &b)
 C++ version of gsl_vector_ulong_add(). More...
 
int sub (vector_ulong const &b)
 C++ version of gsl_vector_ulong_sub(). More...
 
int mul (vector_ulong const &b)
 C++ version of gsl_vector_ulong_mul(). More...
 
int div (vector_ulong const &b)
 C++ version of gsl_vector_ulong_div(). More...
 
int scale (unsigned long const x)
 C++ version of gsl_vector_ulong_scale(). More...
 
int add_constant (unsigned long const x)
 C++ version of gsl_vector_ulong_add_constant(). More...
 
int axpby (unsigned long const alpha, vector_ulong const &x, unsigned long const beta)
 C++ version of gsl_vector_ulong_axpby(). More...
 
unsigned long sum (vector_ulong const &a) const
 C++ version of gsl_vector_ulong_sum(). More...
 
int isnull () const
 C++ version of gsl_vector_ulong_isnull(). More...
 
int ispos () const
 C++ version of gsl_vector_ulong_ispos(). More...
 
int isneg () const
 C++ version of gsl_vector_ulong_isneg(). More...
 
int isnonneg () const
 C++ version of gsl_vector_ulong_isnonneg(). More...
 
unsigned long get (size_t const i) const
 C++ version of gsl_vector_ulong_get(). More...
 
void set (size_t const i, unsigned long x)
 C++ version of gsl_vector_ulong_set(). More...
 
unsigned long * ptr (size_t const i)
 C++ version of gsl_vector_ulong_ptr(). More...
 
unsigned long const * const_ptr (size_t const i) const
 C++ version of gsl_vector_ulong_const_ptr(). More...
 
int fread (FILE *stream)
 C++ version of gsl_vector_ulong_fread(). More...
 
int fwrite (FILE *stream) const
 C++ version of gsl_vector_ulong_fwrite(). More...
 
int fscanf (FILE *stream)
 C++ version of gsl_vector_ulong_fscanf(). More...
 
int fprintf (FILE *stream, char const *format) const
 C++ version of gsl_vector_ulong_fprintf(). More...
 
 vector_ulong (block_ulong &b, size_t const offset, size_t const n, size_t const stride=1)
 C++ version of gsl_vector_ulong_alloc_from_block(). More...
 
 vector_ulong (vector_ulong &v, size_t const offset, size_t const n, size_t const stride=1)
 C++ version of gsl_vector_ulong_alloc_from_vector(). More...
 
vector_ulong subvector (size_t i, size_t n)
 C++ version of gsl_vector_ulong_subvector(). More...
 
vector_ulong subvector_with_stride (size_t i, size_t stride, size_t n)
 C++ version of gsl_vector_ulong_subvector_with_stride(). More...
 
vector_ulong const const_subvector (size_t i, size_t n) const
 C++ version of gsl_vector_ulong_const_subvector(). More...
 
vector_ulong const const_subvector_with_stride (size_t i, size_t stride, size_t n) const
 C++ version of gsl_vector_ulong_const_subvector_with_stride(). More...
 

Additional Inherited Members

- Public Types inherited from gsl::vector_ulong
typedef unsigned long 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_ulong
static vector_ulong calloc (size_t const n)
 C++ version of gsl_vector_ulong_calloc(). More...
 
static vector_ulong view_array (unsigned long *v, size_t n)
 C++ version of gsl_vector_ulong_view_array(). More...
 
static vector_ulong view_array_with_stride (unsigned long *base, size_t stride, size_t n)
 C++ version of gsl_vector_ulong_view_array_with_stride(). More...
 
static vector_ulong const const_view_array (unsigned long const *v, size_t n)
 C++ version of gsl_vector_ulong _const_view_array(). More...
 
static vector_ulong const const_view_array_with_stride (unsigned long const *base, size_t stride, size_t n)
 C++ version of gsl_vector_ulong_const_view_array_with_stride(). More...
 
template<typename ARRAY >
static vector_ulong view_array (ARRAY &v, size_t n=0)
 C++ version of gsl_vector_ulong_view_array(). More...
 
template<typename ARRAY >
static vector_ulong view_array_with_stride (ARRAY &base, size_t stride, size_t n=0)
 C++ version of gsl_vector_ulong_view_array_with_stride(). More...
 
template<typename ARRAY >
static vector_ulong const const_view_array (ARRAY const &v, size_t n=0)
 C++ version of gsl_vector_ulong _const_view_array(). More...
 
template<typename ARRAY >
static vector_ulong const const_view_array_with_stride (ARRAY const &base, size_t stride, size_t n=0)
 C++ version of gsl_vector_ulong_const_view_array_with_stride(). More...
 
static vector_ulong alloc_row_from_matrix (matrix_ulong &m, size_t const i)
 C++ version of gsl_vector_ulong_alloc_row_from_matrix(). More...
 
static vector_ulong alloc_col_from_matrix (matrix_ulong &m, size_t const j)
 C++ version of gsl_vector_ulong_alloc_col_from_matrix(). More...
 

Detailed Description

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

Definition at line 237 of file matrix_ulong.hpp.

Constructor & Destructor Documentation

◆ vector_ulong_ptr()

gsl::matrix_ulong::vector_ulong_ptr::vector_ulong_ptr ( vector_ulong const &  v)
inline

Typically we have to construct from a vector_ulong.

Parameters
vThe vector_ulong to construct from.

Definition at line 242 of file matrix_ulong.hpp.

Member Function Documentation

◆ operator*()

vector_ulong & gsl::matrix_ulong::vector_ulong_ptr::operator* ( )
inline

Dereference operator.

Returns
a vector_ulong

Definition at line 247 of file matrix_ulong.hpp.

◆ operator->()

vector_ulong * gsl::matrix_ulong::vector_ulong_ptr::operator-> ( )
inline

Dereference operator.

Returns
a pointer to a vector_ulong

Definition at line 252 of file matrix_ulong.hpp.


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