ccgsl 2.7.2
C++wrappersforGnuScientificLibrary
gsl::matrix_uchar::vector_uchar_ptr Struct Reference

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

Inheritance diagram for gsl::matrix_uchar::vector_uchar_ptr:
Inheritance graph
Collaboration diagram for gsl::matrix_uchar::vector_uchar_ptr:
Collaboration graph

Public Member Functions

 vector_uchar_ptr (vector_uchar const &v)
 Typically we have to construct from a vector_uchar. More...
 
vector_ucharoperator* ()
 Dereference operator. More...
 
vector_ucharoperator-> ()
 Dereference operator. More...
 
- Public Member Functions inherited from gsl::vector_uchar
 vector_uchar ()
 The default constructor is only really useful for assigning to. More...
 
 vector_uchar (size_t const n)
 The default constructor creates a new vector_uchar with n elements. More...
 
 vector_uchar (gsl_vector_uchar *v)
 Could construct from a gsl_vector_uchar. More...
 
 vector_uchar (std::initializer_list< unsigned char > initializer_list)
 Could construct from a std::initializer_list in C++11. More...
 
 vector_uchar (vector_uchar const &v)
 The copy constructor. More...
 
 vector_uchar (vector_uchar &v)
 The copy constructor. More...
 
vector_ucharoperator= (vector_uchar const &v)
 The assignment operator. More...
 
template<typename V >
 vector_uchar (V &v, size_t const stride=1)
 Construct from an object that implements data() and size(). More...
 
vector_uchar clone () const
 The clone function. More...
 
 ~vector_uchar ()
 The destructor only deletes the pointers if count reaches zero. More...
 
void wrap_gsl_vector_uchar_without_ownership (gsl_vector_uchar *v)
 This function is intended mainly for internal use. More...
 
bool operator== (vector_uchar const &v) const
 Two vector_uchar objects are identically equal if their elements are identical. More...
 
void reset ()
 Stop sharing ownership of the shared pointer. More...
 
 vector_uchar (vector_uchar &&v)
 Move constructor. More...
 
vector_ucharoperator= (vector_uchar &&v)
 Move operator. More...
 
bool operator!= (vector_uchar const &v) const
 Two vector_uchar objects are different equal if their elements are not identical. More...
 
bool operator< (vector_uchar const &v) const
 A container needs to define an ordering for sorting. More...
 
bool operator> (vector_uchar const &v) const
 A container needs to define an ordering for sorting. More...
 
bool operator<= (vector_uchar const &v) const
 A container needs to define an ordering for sorting. More...
 
bool operator>= (vector_uchar const &v) const
 A container needs to define an ordering for sorting. More...
 
iterator begin ()
 Get iterator pointing to first vector_uchar element. More...
 
const_iterator begin () const
 Get iterator pointing to first vector_uchar element. More...
 
iterator end ()
 Get iterator pointing beyond last vector_uchar element. More...
 
const_iterator end () const
 Get iterator pointing beyond last vector_uchar element. More...
 
size_type size () const
 The size (number of elements) of the vector_uchar. More...
 
unsigned char * data ()
 Give access to the data block_uchar. More...
 
unsigned char const * data () const
 Give access to the data block_uchar. More...
 
size_type max_size () const
 The max size (number of elements) of the vector_uchar. More...
 
bool empty () const
 Find if the vector_uchar is empty. More...
 
void swap (vector_uchar &v)
 Swap two vector_uchar objects. More...
 
reverse_iterator rbegin ()
 Get iterator pointing to first vector_uchar element. More...
 
const_reverse_iterator rbegin () const
 Get iterator pointing to first vector_uchar element. More...
 
reverse_iterator rend ()
 Get iterator pointing beyond last vector_uchar element. More...
 
const_reverse_iterator rend () const
 Get iterator pointing beyond last vector_uchar element. More...
 
unsigned char & operator[] (size_t const n)
 Get element at position n by reference ([] operator). More...
 
unsigned char const & operator[] (size_t const n) const
 Get element at position n by reference ([] operator). More...
 
gsl_vector_uchar * get ()
 Get the gsl_vector_uchar. More...
 
gsl_vector_uchar const * get () const
 Get the gsl_vector_uchar. More...
 
bool unique () const
 Find if this is the only object sharing the gsl_vector_uchar. More...
 
size_t use_count () const
 Find how many vector_uchar objects share this pointer. More...
 
 operator bool () const
 Allow conversion to bool. More...
 
void set_zero ()
 C++ version of gsl_vector_uchar_set_zero(). More...
 
void set_all (unsigned char x)
 C++ version of gsl_vector_uchar_set_all(). More...
 
int set_basis (size_t i)
 C++ version of gsl_vector_uchar_set_basis(). More...
 
int memcpy (vector_uchar const &src)
 C++ version of gsl_vector_uchar_memcpy(). More...
 
int reverse ()
 C++ version of gsl_vector_uchar_reverse(). More...
 
int swap_elements (size_t const i, size_t const j)
 C++ version of gsl_vector_uchar_swap_elements(). More...
 
unsigned char max () const
 C++ version of gsl_vector_uchar_max(). More...
 
unsigned char min () const
 C++ version of gsl_vector_uchar_min(). More...
 
void minmax (unsigned char *min_out, unsigned char *max_out) const
 C++ version of gsl_vector_uchar_minmax(). More...
 
void minmax (unsigned char &min_out, unsigned char &max_out) const
 C++ version of gsl_vector_uchar_minmax(). More...
 
size_t max_index () const
 C++ version of gsl_vector_uchar_max_index(). More...
 
size_t min_index () const
 C++ version of gsl_vector_uchar_min_index(). More...
 
void minmax_index (size_t *imin, size_t *imax) const
 C++ version of gsl_vector_uchar_minmax_index(). More...
 
int add (vector_uchar const &b)
 C++ version of gsl_vector_uchar_add(). More...
 
int sub (vector_uchar const &b)
 C++ version of gsl_vector_uchar_sub(). More...
 
int mul (vector_uchar const &b)
 C++ version of gsl_vector_uchar_mul(). More...
 
int div (vector_uchar const &b)
 C++ version of gsl_vector_uchar_div(). More...
 
int scale (unsigned char const x)
 C++ version of gsl_vector_uchar_scale(). More...
 
int add_constant (unsigned char const x)
 C++ version of gsl_vector_uchar_add_constant(). More...
 
int axpby (unsigned char const alpha, vector_uchar const &x, unsigned char const beta)
 C++ version of gsl_vector_uchar_axpby(). More...
 
unsigned char sum (vector_uchar const &a) const
 C++ version of gsl_vector_uchar_sum(). More...
 
int isnull () const
 C++ version of gsl_vector_uchar_isnull(). More...
 
int ispos () const
 C++ version of gsl_vector_uchar_ispos(). More...
 
int isneg () const
 C++ version of gsl_vector_uchar_isneg(). More...
 
int isnonneg () const
 C++ version of gsl_vector_uchar_isnonneg(). More...
 
unsigned char get (size_t const i) const
 C++ version of gsl_vector_uchar_get(). More...
 
void set (size_t const i, unsigned char x)
 C++ version of gsl_vector_uchar_set(). More...
 
unsigned char * ptr (size_t const i)
 C++ version of gsl_vector_uchar_ptr(). More...
 
unsigned char const * const_ptr (size_t const i) const
 C++ version of gsl_vector_uchar_const_ptr(). More...
 
int fread (FILE *stream)
 C++ version of gsl_vector_uchar_fread(). More...
 
int fwrite (FILE *stream) const
 C++ version of gsl_vector_uchar_fwrite(). More...
 
int fscanf (FILE *stream)
 C++ version of gsl_vector_uchar_fscanf(). More...
 
int fprintf (FILE *stream, char const *format) const
 C++ version of gsl_vector_uchar_fprintf(). More...
 
 vector_uchar (block_uchar &b, size_t const offset, size_t const n, size_t const stride=1)
 C++ version of gsl_vector_uchar_alloc_from_block(). More...
 
 vector_uchar (vector_uchar &v, size_t const offset, size_t const n, size_t const stride=1)
 C++ version of gsl_vector_uchar_alloc_from_vector(). More...
 
vector_uchar subvector (size_t i, size_t n)
 C++ version of gsl_vector_uchar_subvector(). More...
 
vector_uchar subvector_with_stride (size_t i, size_t stride, size_t n)
 C++ version of gsl_vector_uchar_subvector_with_stride(). More...
 
vector_uchar const const_subvector (size_t i, size_t n) const
 C++ version of gsl_vector_uchar_const_subvector(). More...
 
vector_uchar const const_subvector_with_stride (size_t i, size_t stride, size_t n) const
 C++ version of gsl_vector_uchar_const_subvector_with_stride(). More...
 

Additional Inherited Members

- Public Types inherited from gsl::vector_uchar
typedef unsigned char 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_uchar
static vector_uchar calloc (size_t const n)
 C++ version of gsl_vector_uchar_calloc(). More...
 
static vector_uchar view_array (unsigned char *v, size_t n)
 C++ version of gsl_vector_uchar_view_array(). More...
 
static vector_uchar view_array_with_stride (unsigned char *base, size_t stride, size_t n)
 C++ version of gsl_vector_uchar_view_array_with_stride(). More...
 
static vector_uchar const const_view_array (unsigned char const *v, size_t n)
 C++ version of gsl_vector_uchar _const_view_array(). More...
 
static vector_uchar const const_view_array_with_stride (unsigned char const *base, size_t stride, size_t n)
 C++ version of gsl_vector_uchar_const_view_array_with_stride(). More...
 
template<typename ARRAY >
static vector_uchar view_array (ARRAY &v, size_t n=0)
 C++ version of gsl_vector_uchar_view_array(). More...
 
template<typename ARRAY >
static vector_uchar view_array_with_stride (ARRAY &base, size_t stride, size_t n=0)
 C++ version of gsl_vector_uchar_view_array_with_stride(). More...
 
template<typename ARRAY >
static vector_uchar const const_view_array (ARRAY const &v, size_t n=0)
 C++ version of gsl_vector_uchar _const_view_array(). More...
 
template<typename ARRAY >
static vector_uchar const const_view_array_with_stride (ARRAY const &base, size_t stride, size_t n=0)
 C++ version of gsl_vector_uchar_const_view_array_with_stride(). More...
 
static vector_uchar alloc_row_from_matrix (matrix_uchar &m, size_t const i)
 C++ version of gsl_vector_uchar_alloc_row_from_matrix(). More...
 
static vector_uchar alloc_col_from_matrix (matrix_uchar &m, size_t const j)
 C++ version of gsl_vector_uchar_alloc_col_from_matrix(). More...
 

Detailed Description

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

Definition at line 237 of file matrix_uchar.hpp.

Constructor & Destructor Documentation

◆ vector_uchar_ptr()

gsl::matrix_uchar::vector_uchar_ptr::vector_uchar_ptr ( vector_uchar const &  v)
inline

Typically we have to construct from a vector_uchar.

Parameters
vThe vector_uchar to construct from.

Definition at line 242 of file matrix_uchar.hpp.

Member Function Documentation

◆ operator*()

vector_uchar & gsl::matrix_uchar::vector_uchar_ptr::operator* ( )
inline

Dereference operator.

Returns
a vector_uchar

Definition at line 247 of file matrix_uchar.hpp.

◆ operator->()

vector_uchar * gsl::matrix_uchar::vector_uchar_ptr::operator-> ( )
inline

Dereference operator.

Returns
a pointer to a vector_uchar

Definition at line 252 of file matrix_uchar.hpp.


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