gsl::vector_complex_float Class Reference

This class handles vector_complex_float objects as shared handles. More...

#include <vector_complex_float.hpp>

Inheritance diagram for gsl::vector_complex_float:

Collaboration diagram for gsl::vector_complex_float:

Classes
class	const_iterator_t
	A class template for the const iterators. More...
class	iterator_base
	The container must have iterator types. More...
class	iterator_t
	A class template for the two non-const iterators. More...

Public Types
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...

Public Member Functions
	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_float &	operator= (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_float &	operator= (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...

Static Public Member Functions
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...

Private Attributes
bool	owns_data
	Used to allow a vector that does not own its data. More...
gsl_vector_complex_float *	ccgsl_pointer
	The shared pointer. More...
size_t *	count
	The shared reference count. More...

Detailed Description

This class handles vector_complex_float objects as shared handles.

It models a random access container so that STL functions work with vector_complex_float.

Note that vector_complex_float_views are implemented as vector_complex_float objects here.

Definition at line 46 of file vector_complex_float.hpp.

Member Typedef Documentation

const_iterator

typedef const_iterator_t<false> gsl::vector_complex_float::const_iterator

The const_iterator type.

Definition at line 1033 of file vector_complex_float.hpp.

const_pointer

typedef complex_float_ptr const gsl::vector_complex_float::const_pointer

A container must have a constant pointer type.

Definition at line 368 of file vector_complex_float.hpp.

const_reference

typedef reference const gsl::vector_complex_float::const_reference

A container must have a constant reference type.

Definition at line 358 of file vector_complex_float.hpp.

const_reverse_iterator

typedef const_iterator_t<true> gsl::vector_complex_float::const_reverse_iterator

The const_reverse_t type.

Definition at line 1041 of file vector_complex_float.hpp.

difference_type

typedef const_iterator::difference_type gsl::vector_complex_float::difference_type

A container must have a difference_type.

Definition at line 1050 of file vector_complex_float.hpp.

iterator

typedef iterator_t<false> gsl::vector_complex_float::iterator

The iterator type.

Definition at line 1037 of file vector_complex_float.hpp.

pointer

typedef complex_float_ptr gsl::vector_complex_float::pointer

A container must have a pointer type.

Definition at line 363 of file vector_complex_float.hpp.

reference

typedef complex_float_ref gsl::vector_complex_float::reference

A container must have a reference type.

Definition at line 353 of file vector_complex_float.hpp.

reverse_iterator

typedef iterator_t<true> gsl::vector_complex_float::reverse_iterator

The reverse_iterator type.

Definition at line 1045 of file vector_complex_float.hpp.

size_type

typedef size_t gsl::vector_complex_float::size_type

A container must have a size_type.

Definition at line 1055 of file vector_complex_float.hpp.

value_type

typedef complex_float gsl::vector_complex_float::value_type

A container must have a value_type.

Definition at line 348 of file vector_complex_float.hpp.

Constructor & Destructor Documentation

vector_complex_float() [1/8]

gsl::vector_complex_float::vector_complex_float ( )

inline

The default constructor is only really useful for assigning to.

Definition at line 51 of file vector_complex_float.hpp.

References ccgsl_pointer, count, and owns_data.

Referenced by calloc(), const_subvector(), const_subvector_with_stride(), const_view_array(), const_view_array_with_stride(), operator=(), reset(), subvector(), subvector_with_stride(), view_array(), and view_array_with_stride().

vector_complex_float() [2/8]

gsl::vector_complex_float::vector_complex_float ( size_t const  n )

inlineexplicit

The default constructor creates a new vector_complex_float with n elements.

Parameters

n	The number of elements in the vector_complex_float

Definition at line 62 of file vector_complex_float.hpp.

References ccgsl_pointer, count, and gsl::rstat::n().

vector_complex_float() [3/8]

gsl::vector_complex_float::vector_complex_float ( gsl_vector_complex_float *  v )

inlineexplicit

Could construct from a gsl_vector_complex_float.

This is not usually a good idea. In this case you should not use gsl_vector_complex_float_free() to deallocate the memory.

Parameters

v	The vector_complex_float

Definition at line 102 of file vector_complex_float.hpp.

References ccgsl_pointer, and count.

vector_complex_float() [4/8]

gsl::vector_complex_float::vector_complex_float ( std::initializer_list< std::complex< float > >  initializer_list )

inline

Could construct from a std::initializer_list in C++11.

Parameters

initializer_list

The initializer_list.

Definition at line 114 of file vector_complex_float.hpp.

References begin(), ccgsl_pointer, count, and gsl::rstat::n().

vector_complex_float() [5/8]

gsl::vector_complex_float::vector_complex_float ( vector_complex_float const &  v )

inline

The copy constructor.

This shares the vector_complex_float. Use clone() if you want a full copy.

Parameters

v	The vector_complex_float to copy.

Definition at line 138 of file vector_complex_float.hpp.

References count.

~vector_complex_float()

gsl::vector_complex_float::~vector_complex_float ( )

inline

The destructor only deletes the pointers if count reaches zero.

Definition at line 180 of file vector_complex_float.hpp.

References ccgsl_pointer, count, and owns_data.

vector_complex_float() [6/8]

gsl::vector_complex_float::vector_complex_float ( vector_complex_float &&  v )

inline

Move constructor.

Parameters

v	The vector_complex_float to move.

Definition at line 239 of file vector_complex_float.hpp.

References count.

vector_complex_float() [7/8]

gsl::vector_complex_float::vector_complex_float ( block_complex_float &  b, size_t const  offset, size_t const  n, size_t const  stride = 1  )

inline

C++ version of gsl_vector_complex_float_alloc_from_block().

Parameters

b	The block_complex_float
offset	The offset within the block_complex_float
n	The number of elements
stride	The stride

Definition at line 1439 of file vector_complex_float.hpp.

References gsl::sf::mathieu::b(), ccgsl_pointer, count, and gsl::rstat::n().

vector_complex_float() [8/8]

gsl::vector_complex_float::vector_complex_float ( vector_complex_float &  v, size_t const  offset, size_t const  n, size_t const  stride = 1  )

inline

C++ version of gsl_vector_complex_float_alloc_from_vector().

Parameters

v	The vector_complex_float
offset	The offset
n	The number of elements
stride	The stride

Definition at line 1456 of file vector_complex_float.hpp.

References ccgsl_pointer, count, get(), and gsl::rstat::n().

Member Function Documentation

add()

int gsl::vector_complex_float::add ( vector_complex_float const &  b )

inline

C++ version of gsl_vector_complex_float_add().

Parameters

b	vector_complex_float to add to this

Returns

error code on failure

Definition at line 1314 of file vector_complex_float.hpp.

References gsl::sf::mathieu::b(), and get().

add_constant()

int gsl::vector_complex_float::add_constant ( complex_float const  x )

inline

C++ version of gsl_vector_complex_float_add_constant().

Parameters

x	constant to add to each element of this

Returns

error code on failure

Definition at line 1344 of file vector_complex_float.hpp.

References get().

alloc_col_from_matrix()

static vector_complex_float gsl::vector_complex_float::alloc_col_from_matrix ( matrix_complex_float &  m, size_t const  j  )

static

C++ version of gsl_vector_complex_float_alloc_col_from_matrix().

Parameters

m	A matrix
j	A column

Returns

A vector_complex_float

alloc_row_from_matrix()

static vector_complex_float gsl::vector_complex_float::alloc_row_from_matrix ( matrix_complex_float &  m, size_t const  i  )

static

C++ version of gsl_vector_complex_float_alloc_row_from_matrix().

Parameters

m	A matrix_complex_float
i	A row

Returns

A vector_complex_float

axpby()

int gsl::vector_complex_float::axpby ( complex_float const  alpha, vector_complex_float const &  x, complex_float const  beta  )

inline

C++ version of gsl_vector_complex_float_axpby().

Parameters

alpha	constant to multiply x by
x	another matrix
beta	constant to multiply this by

Returns

alpha * x + beta * this

Definition at line 1352 of file vector_complex_float.hpp.

References gsl::ran::beta(), and get().

begin() [1/2]

iterator gsl::vector_complex_float::begin ( )

inline

Get iterator pointing to first vector_complex_float element.

Returns

iterator pointing to first vector_complex_float element

Definition at line 1061 of file vector_complex_float.hpp.

Referenced by vector_complex_float().

begin() [2/2]

const_iterator gsl::vector_complex_float::begin ( ) const

inline

Get iterator pointing to first vector_complex_float element.

Returns

iterator pointing to first vector_complex_float element

Definition at line 1068 of file vector_complex_float.hpp.

calloc()

static vector_complex_float gsl::vector_complex_float::calloc ( size_t const  n )

inlinestatic

C++ version of gsl_vector_complex_float_calloc().

This constructs a vector_complex_float object with entries initialised to zero.

Parameters

n	The size of the vector_complex_float

Returns

A vector_complex_float initialised to zero

Definition at line 1274 of file vector_complex_float.hpp.

References gsl::rstat::n(), and vector_complex_float().

clone()

vector_complex_float gsl::vector_complex_float::clone ( ) const

inline

The clone function.

Use this if you want a copy of the vector_complex_float that does not share the underlying data.

Returns

a new copy of this.

Definition at line 169 of file vector_complex_float.hpp.

References get(), and size().

const_imag()

gsl::vector_float const gsl::vector_complex_float::const_imag ( ) const

inline

C++ version of gsl_vector_complex_const_imag().

Note that this is a view: if the complex_vector from which the return value is constructed is deleted then the return value should not be used.

Returns

The imaginary parts of each element

Definition at line 1504 of file vector_complex_float.hpp.

References CCGSL_MTY, gsl::vector_float::const_view_array_with_stride(), data(), and size().

const_ptr()

complex_float_ptr const gsl::vector_complex_float::const_ptr ( size_t const  i )

inline

C++ version of gsl_vector_complex_float_const_ptr().

Parameters

i	index of element to get

Returns

pointer to element

Definition at line 1402 of file vector_complex_float.hpp.

References CCGSL_MTY, ccgsl_pointer, and gsl::exception::GSL_EINVAL.

const_real()

gsl::vector_float const gsl::vector_complex_float::const_real ( ) const

inline

C++ version of gsl_vector_complex_const_real().

Note that this is a view: if the complex_vector from which the return value is constructed is deleted then the return value should not be used.

Returns

The real parts of each element

Definition at line 1480 of file vector_complex_float.hpp.

References CCGSL_MTY, gsl::vector_float::const_view_array_with_stride(), data(), and size().

const_subvector()

vector_complex_float const gsl::vector_complex_float::const_subvector ( size_t  i, size_t  n  ) const

inline

C++ version of gsl_vector_complex_float_const_subvector().

Parameters

i	The offset
n	The size

Returns

A subvector

Definition at line 1632 of file vector_complex_float.hpp.

References get(), gsl::rstat::n(), and vector_complex_float().

const_subvector_with_stride()

vector_complex_float const gsl::vector_complex_float::const_subvector_with_stride ( size_t  i, size_t  stride, size_t  n  ) const

inline

C++ version of gsl_vector_complex_float_const_subvector_with_stride().

Parameters

i	The offset
stride	The stride
n	The size

Returns

A subvector

Definition at line 1646 of file vector_complex_float.hpp.

References get(), gsl::rstat::n(), and vector_complex_float().

const_view_array() [1/2]

template<typename ARRAY >

static vector_complex_float const gsl::vector_complex_float::const_view_array ( ARRAY const &  v, size_t  n = 0  )

inlinestatic

C++ version of gsl_vector_complex_float _const_view_array().

Parameters

v	An array of type float
n	The size of the vector_complex_float: the default gives access to the whole array

Returns

A vector_complex_float

Definition at line 1728 of file vector_complex_float.hpp.

References gsl::exception::GSL_EBADLEN, gsl::rstat::n(), and vector_complex_float().

const_view_array() [2/2]

static vector_complex_float const gsl::vector_complex_float::const_view_array ( float const *  v, size_t  n  )

inlinestatic

C++ version of gsl_vector_complex_float _const_view_array().

Parameters

v	An array of type float
n	The size of the vector_complex_float

Returns

A vector_complex_float

Definition at line 1547 of file vector_complex_float.hpp.

References gsl::rstat::n(), and vector_complex_float().

const_view_array_with_stride() [1/2]

template<typename ARRAY >

static vector_complex_float const gsl::vector_complex_float::const_view_array_with_stride ( ARRAY const &  base, size_t  stride, size_t  n = 0  )

inlinestatic

C++ version of gsl_vector_complex_float_const_view_array_with_stride().

Parameters

base	An array of type float
stride	The stride
n	The size of the vector_complex_float: the default gives access to the whole array

Returns

A vector_complex_float

Definition at line 1747 of file vector_complex_float.hpp.

References gsl::exception::GSL_EBADLEN, gsl::rstat::n(), and vector_complex_float().

const_view_array_with_stride() [2/2]

static vector_complex_float const gsl::vector_complex_float::const_view_array_with_stride ( float const *  base, size_t  stride, size_t  n  )

inlinestatic

C++ version of gsl_vector_complex_float_const_view_array_with_stride().

Parameters

base	An array of type float
stride	The stride
n	The size of the vector_complex_float

Returns

A vector_complex_float

Definition at line 1561 of file vector_complex_float.hpp.

References gsl::rstat::n(), and vector_complex_float().

data() [1/2]

float * gsl::vector_complex_float::data ( )

inline

Give access to the data block.

The data() and size() functions mimic the functions of std::array<T> and std::vector<T>. This function can throw an exception or produce a GSL error if the vector stride is not 1. However, new vector objects are always initialised to have a stride of 1.

Returns

The data block.

Definition at line 1101 of file vector_complex_float.hpp.

References ccgsl_pointer.

Referenced by gsl::fft::complex_float::radix2::backward(), gsl::fft::complex_float::backward(), const_imag(), const_real(), gsl::fft::complex_float::radix2::dif_backward(), gsl::fft::complex_float::radix2::dif_forward(), gsl::fft::complex_float::radix2::dif_inverse(), gsl::fft::complex_float::radix2::dif_transform(), gsl::fft::complex_float::radix2::forward(), gsl::fft::complex_float::forward(), imag(), gsl::fft::complex_float::radix2::inverse(), gsl::fft::complex_float::inverse(), real(), gsl::fft::complex_float::radix2::transform(), gsl::fft::complex_float::transform(), gsl::fft::halfcomplex_float::unpack(), and gsl::fft::real_float::unpack().

data() [2/2]

float const * gsl::vector_complex_float::data ( ) const

inline

Give access to the data block.

The data() and size() functions mimic the functions of std::array<T> and std::vector<T>. This function can throw an exception or produce a GSL error if the vector stride is not 1. However, new vector objects are always initialised to have a stride of 1.

Returns

The data block.

Definition at line 1115 of file vector_complex_float.hpp.

References ccgsl_pointer.

div()

int gsl::vector_complex_float::div ( vector_complex_float const &  b )

inline

C++ version of gsl_vector_complex_float_div().

Parameters

b	vector_complex_float to dividev this by elementwise

Returns

error code on failure

Definition at line 1332 of file vector_complex_float.hpp.

References gsl::sf::mathieu::b(), and get().

empty()

bool gsl::vector_complex_float::empty ( ) const

inline

Find if the vector_complex_float is empty.

Returns

true if has size zero; otherwise false

Definition at line 1134 of file vector_complex_float.hpp.

References ccgsl_pointer.

end() [1/2]

iterator gsl::vector_complex_float::end ( )

inline

Get iterator pointing beyond last vector_complex_float element.

Returns

iterator pointing beyond last vector_complex_float element

Definition at line 1076 of file vector_complex_float.hpp.

References ccgsl_pointer, and size().

end() [2/2]

const_iterator gsl::vector_complex_float::end ( ) const

inline

Get iterator pointing beyond last vector_complex_float element.

Returns

iterator pointing beyond last vector_complex_float element

Definition at line 1084 of file vector_complex_float.hpp.

References ccgsl_pointer, and size().

fprintf()

int gsl::vector_complex_float::fprintf ( FILE *  stream, char const *  format  ) const

inline

C++ version of gsl_vector_complex_float_fprintf().

Parameters

stream	A C file stream
format	d, e, f or g

Returns

error code on failure

Definition at line 1430 of file vector_complex_float.hpp.

References get().

fread()

int gsl::vector_complex_float::fread ( FILE *  stream )

inline

C++ version of gsl_vector_complex_float_fread().

Parameters

stream

A C file stream

Returns

error code on failure

Definition at line 1411 of file vector_complex_float.hpp.

References get().

fscanf()

int gsl::vector_complex_float::fscanf ( FILE *  stream )

inline

C++ version of gsl_vector_complex_float_fscanf().

Parameters

stream

A C file stream

Returns

error code on failure

Definition at line 1423 of file vector_complex_float.hpp.

References get().

fwrite()

int gsl::vector_complex_float::fwrite ( FILE *  stream ) const

inline

C++ version of gsl_vector_complex_float_fwrite().

Parameters

stream

A C file stream

Returns

error code on failure

Definition at line 1417 of file vector_complex_float.hpp.

References get().

get() [1/3]

gsl_vector_complex_float * gsl::vector_complex_float::get ( )

inline

Get the gsl_vector_complex_float.

Returns

the gsl_vector_complex_float

Definition at line 1240 of file vector_complex_float.hpp.

References ccgsl_pointer.

Referenced by add(), add_constant(), axpby(), gsl::blas::caxpy(), gsl::blas::ccopy(), gsl::blas::cdotc(), gsl::blas::cdotu(), gsl::blas::cgemv(), gsl::blas::cgerc(), gsl::blas::cgeru(), gsl::blas::chemv(), gsl::blas::cher(), gsl::blas::cher2(), clone(), const_subvector(), const_subvector_with_stride(), gsl::matrix_complex_float::const_view_vector(), gsl::matrix_complex_float::const_view_vector_with_tda(), gsl::blas::cscal(), gsl::blas::csscal(), gsl::blas::cswap(), gsl::blas::ctrmv(), gsl::blas::ctrsv(), div(), fprintf(), fread(), fscanf(), fwrite(), gsl::matrix_complex_float::get_col(), gsl::matrix_complex_float::get_row(), gsl::blas::icamax(), isneg(), isnonneg(), isnull(), ispos(), memcpy(), mul(), reverse(), scale(), gsl::spmatrix_complex_float::scale_columns(), gsl::matrix_complex_float::scale_columns(), gsl::spmatrix_complex_float::scale_rows(), gsl::matrix_complex_float::scale_rows(), gsl::blas::scasum(), gsl::blas::scnrm2(), set(), set_all(), set_basis(), gsl::matrix_complex_float::set_col(), gsl::matrix_complex_float::set_row(), set_zero(), sub(), subvector(), subvector_with_stride(), swap_elements(), vector_complex_float(), gsl::permute::vector_complex_float_forward(), gsl::permute::vector_complex_float_inverse(), gsl::matrix_complex_float::view_vector(), and gsl::matrix_complex_float::view_vector_with_tda().

get() [2/3]

gsl_vector_complex_float const * gsl::vector_complex_float::get ( ) const

inline

Get the gsl_vector_complex_float.

Returns

the gsl_vector_complex_float

Definition at line 1245 of file vector_complex_float.hpp.

References ccgsl_pointer.

get() [3/3]

complex_float gsl::vector_complex_float::get ( size_t const  i ) const

inline

C++ version of gsl_vector_complex_float_get().

Parameters

i	index of element to get

Returns

value of element

Definition at line 1381 of file vector_complex_float.hpp.

References get().

Referenced by get().

imag() [1/2]

gsl::vector_float gsl::vector_complex_float::imag ( )

inline

C++ version of gsl_vector_complex_imag().

Note that this is a view: if the complex_vector from which the return value is constructed is deleted then the return value should not be used.

Returns

The imaginary parts of each element

Definition at line 1496 of file vector_complex_float.hpp.

References CCGSL_MTY, data(), size(), and gsl::vector_float::view_array_with_stride().

imag() [2/2]

gsl::vector_float const gsl::vector_complex_float::imag ( ) const

inline

Another C++ version of gsl_vector_complex_const_imag().

Note that this is a view: if the complex_vector from which the return value is constructed is deleted then the return value should not be used.

Returns

The imaginary parts of each element

Definition at line 1512 of file vector_complex_float.hpp.

References CCGSL_MTY, gsl::vector_float::const_view_array_with_stride(), data(), and size().

isneg()

int gsl::vector_complex_float::isneg ( ) const

inline

C++ version of gsl_vector_complex_float_isneg().

Returns

+1 or 0 according as elements are all negative or not

Definition at line 1370 of file vector_complex_float.hpp.

References get().

isnonneg()

int gsl::vector_complex_float::isnonneg ( ) const

inline

C++ version of gsl_vector_complex_float_isnonneg().

Returns

+1 or 0 according as elements are all nonnegative or not

Definition at line 1375 of file vector_complex_float.hpp.

References get().

isnull()

int gsl::vector_complex_float::isnull ( ) const

inline

C++ version of gsl_vector_complex_float_isnull().

Returns

+1 or 0 according as elements are all zero or not

Definition at line 1360 of file vector_complex_float.hpp.

References get().

ispos()

int gsl::vector_complex_float::ispos ( ) const

inline

C++ version of gsl_vector_complex_float_ispos().

Returns

+1 or 0 according as elements are all positive or not

Definition at line 1365 of file vector_complex_float.hpp.

References get().

max_size()

size_type gsl::vector_complex_float::max_size ( ) const

inline

The max size (number of elements) of the vector_complex_float.

Identical to size but required for a container.

Returns

The size of the vector_complex_float

Definition at line 1128 of file vector_complex_float.hpp.

References ccgsl_pointer.

memcpy()

int gsl::vector_complex_float::memcpy ( vector_complex_float const &  src )

inline

C++ version of gsl_vector_complex_float_memcpy().

Parameters

src	source vector_complex_float

Returns

error code on failure

Definition at line 1295 of file vector_complex_float.hpp.

References get().

mul()

int gsl::vector_complex_float::mul ( vector_complex_float const &  b )

inline

C++ version of gsl_vector_complex_float_mul().

Parameters

b	vector_complex_float to multiply elementwise with this

Returns

error code on failure

Definition at line 1326 of file vector_complex_float.hpp.

References gsl::sf::mathieu::b(), and get().

operator bool()

gsl::vector_complex_float::operator bool ( ) const

inlineexplicit

Allow conversion to bool.

Returns

true or false according as this contains a pointer to a gsl_vector_complex_float

Definition at line 1265 of file vector_complex_float.hpp.

References ccgsl_pointer.

operator!=()

bool gsl::vector_complex_float::operator!= ( vector_complex_float const &  v ) const

inline

Two vector_complex_float objects are different equal if their elements are not identical.

Parameters

v	The vector_complex_float to be compared with this

Returns

false or true according as this and v have identical elements or not

Definition at line 262 of file vector_complex_float.hpp.

References operator==().

operator<()

bool gsl::vector_complex_float::operator< ( vector_complex_float const &  v ) const

inline

A container needs to define an ordering for sorting.

This uses standard lexicographical ordering and so is not useful, for example, for checking, that a vector_complex_float is nonnegative.

Parameters

v	The vector_complex_float to be compared with this

Returns

false or true according as this is less than v lexicographically

Definition at line 274 of file vector_complex_float.hpp.

References ccgsl_pointer, gsl::movstat::min(), and size().

Referenced by operator<=().

operator<=()

bool gsl::vector_complex_float::operator<= ( vector_complex_float const &  v ) const

inline

A container needs to define an ordering for sorting.

This uses standard lexicographical ordering and so is not useful, for example, for checking, that a vector_complex_float is nonnegative.

Parameters

v	The vector_complex_float to be compared with this

Returns

false or true according as this is less than or equal to v lexicographically

Definition at line 328 of file vector_complex_float.hpp.

References operator<(), and operator==().

operator=() [1/2]

vector_complex_float & gsl::vector_complex_float::operator= ( vector_complex_float &&  v )

inline

Move operator.

Parameters

v	The vector_complex_float to move.

Returns

A reference to this.

Definition at line 250 of file vector_complex_float.hpp.

References vector_complex_float().

operator=() [2/2]

vector_complex_float & gsl::vector_complex_float::operator= ( vector_complex_float const &  v )

inline

The assignment operator.

This makes a shared copy.

Parameters

v	The vector_complex_float to copy

Definition at line 148 of file vector_complex_float.hpp.

References ccgsl_pointer, count, and owns_data.

operator==()

bool gsl::vector_complex_float::operator== ( vector_complex_float const &  v ) const

inline

Two vector_complex_float objects are identically equal if their elements are identical.

Parameters

v	The vector_complex_float to be compared with this

Returns

true or false according as this and v have identical elements or not

Definition at line 217 of file vector_complex_float.hpp.

References CCGSL_MTY, and ccgsl_pointer.

Referenced by operator!=(), operator<=(), and operator>=().

operator>()

bool gsl::vector_complex_float::operator> ( vector_complex_float const &  v ) const

inline

A container needs to define an ordering for sorting.

This uses standard lexicographical ordering and so is not useful, for example, for checking, that a vector_complex_float is nonnegative.

Parameters

v	The vector_complex_float to be compared with this

Returns

false or true according as this is greater than v lexicographically

Definition at line 301 of file vector_complex_float.hpp.

References ccgsl_pointer, gsl::movstat::min(), and size().

Referenced by operator>=().

operator>=()

bool gsl::vector_complex_float::operator>= ( vector_complex_float const &  v ) const

inline

A container needs to define an ordering for sorting.

This uses standard lexicographical ordering and so is not useful, for example, for checking, that a vector_complex_float is nonnegative.

Parameters

v	The vector_complex_float to be compared with this

Returns

false or true according as this is no less than v lexicographically

Definition at line 340 of file vector_complex_float.hpp.

References operator==(), and operator>().

operator[]() [1/2]

complex_float_ref gsl::vector_complex_float::operator[] ( size_t const  n )

inline

Get element at position n by reference ([] operator).

Parameters

n	The position of the element

Returns

a reference to a complex_float

Definition at line 1184 of file vector_complex_float.hpp.

References CCGSL_MTY, ccgsl_pointer, gsl::exception::GSL_EFAILED, gsl::rstat::n(), and size().

operator[]() [2/2]

complex_float_ref const gsl::vector_complex_float::operator[] ( size_t const  n ) const

inline

Get element at position n by reference ([] operator).

Parameters

n	The position of the element

Returns

a reference to a complex_float

Definition at line 1205 of file vector_complex_float.hpp.

References ccgsl_pointer, gsl::exception::GSL_EFAILED, gsl::rstat::n(), and size().

ptr()

complex_float_ptr gsl::vector_complex_float::ptr ( size_t const  i )

inline

C++ version of gsl_vector_complex_float_ptr().

Parameters

i	index of element to get

Returns

pointer to element

Definition at line 1393 of file vector_complex_float.hpp.

References CCGSL_MTY, ccgsl_pointer, and gsl::exception::GSL_EINVAL.

rbegin() [1/2]

reverse_iterator gsl::vector_complex_float::rbegin ( )

inline

Get iterator pointing to first vector_complex_float element.

Returns

iterator pointing to first vector_complex_float element

Definition at line 1151 of file vector_complex_float.hpp.

References ccgsl_pointer, and size().

rbegin() [2/2]

const_reverse_iterator gsl::vector_complex_float::rbegin ( ) const

inline

Get iterator pointing to first vector_complex_float element.

Returns

iterator pointing to first vector_complex_float element

Definition at line 1159 of file vector_complex_float.hpp.

References ccgsl_pointer, and size().

real() [1/2]

gsl::vector_float gsl::vector_complex_float::real ( )

inline

C++ version of gsl_vector_complex_real().

Note that this is a view: if the complex_vector from which the return value is constructed is deleted then the return value should not be used.

Returns

The real parts of each element

Definition at line 1472 of file vector_complex_float.hpp.

References CCGSL_MTY, data(), size(), and gsl::vector_float::view_array_with_stride().

real() [2/2]

gsl::vector_float const gsl::vector_complex_float::real ( ) const

inline

Another C++ version of gsl_vector_complex_const_real().

Note that this is a view: if the complex_vector from which the return value is constructed is deleted then the return value should not be used.

Returns

The real parts of each element

Definition at line 1488 of file vector_complex_float.hpp.

References CCGSL_MTY, gsl::vector_float::const_view_array_with_stride(), data(), and size().

rend() [1/2]

reverse_iterator gsl::vector_complex_float::rend ( )

inline

Get iterator pointing beyond last vector_complex_float element.

Returns

iterator pointing beyond last vector_complex_float element

Definition at line 1168 of file vector_complex_float.hpp.

rend() [2/2]

const_reverse_iterator gsl::vector_complex_float::rend ( ) const

inline

Get iterator pointing beyond last vector_complex_float element.

Returns

iterator pointing beyond last vector_complex_float element

Definition at line 1175 of file vector_complex_float.hpp.

reset()

void gsl::vector_complex_float::reset ( )

inline

Stop sharing ownership of the shared pointer.

Definition at line 233 of file vector_complex_float.hpp.

References vector_complex_float().

reverse()

int gsl::vector_complex_float::reverse ( )

inline

C++ version of gsl_vector_complex_float_reverse().

Returns

error code on failure

Definition at line 1300 of file vector_complex_float.hpp.

References get().

scale()

int gsl::vector_complex_float::scale ( complex_float const  x )

inline

C++ version of gsl_vector_complex_float_scale().

Parameters

x	constant to multiply this by

Returns

error code on failure

Definition at line 1338 of file vector_complex_float.hpp.

References get().

set()

void gsl::vector_complex_float::set ( size_t const  i, complex_float  x  )

inline

C++ version of gsl_vector_complex_float_set().

Parameters

i	index to set
x	new value for element

Definition at line 1387 of file vector_complex_float.hpp.

References get().

set_all()

void gsl::vector_complex_float::set_all ( complex_float  x )

inline

C++ version of gsl_vector_complex_float_set_all().

Parameters

x	The value to which all elements are set

Definition at line 1283 of file vector_complex_float.hpp.

References get().

set_basis()

int gsl::vector_complex_float::set_basis ( size_t  i )

inline

C++ version of gsl_vector_complex_float_set_basis().

Creates a basis vector_complex_float with one nonzero element.

Parameters

i	The element to be set to 1.

Returns

error code on failure

Definition at line 1289 of file vector_complex_float.hpp.

References get().

set_zero()

void gsl::vector_complex_float::set_zero ( )

inline

C++ version of gsl_vector_complex_float_set_zero().

Definition at line 1278 of file vector_complex_float.hpp.

References get().

size()

size_type gsl::vector_complex_float::size ( ) const

inline

The size (number of elements) of the vector_complex_float.

Returns

The size of the vector_complex_float

Definition at line 1093 of file vector_complex_float.hpp.

References ccgsl_pointer.

Referenced by gsl::fft::complex_float::radix2::backward(), gsl::fft::complex_float::backward(), clone(), const_imag(), const_real(), gsl::fft::complex_float::radix2::dif_backward(), gsl::fft::complex_float::radix2::dif_forward(), gsl::fft::complex_float::radix2::dif_inverse(), gsl::fft::complex_float::radix2::dif_transform(), end(), gsl::fft::complex_float::radix2::forward(), gsl::fft::complex_float::forward(), imag(), gsl::fft::complex_float::radix2::inverse(), gsl::fft::complex_float::inverse(), operator<(), operator>(), operator[](), rbegin(), real(), gsl::fft::complex_float::radix2::transform(), gsl::fft::complex_float::transform(), gsl::fft::halfcomplex_float::unpack(), and gsl::fft::real_float::unpack().

sub()

int gsl::vector_complex_float::sub ( vector_complex_float const &  b )

inline

C++ version of gsl_vector_complex_float_sub().

Parameters

b	vector_complex_float to subtract from this

Returns

error code on failure

Definition at line 1320 of file vector_complex_float.hpp.

References gsl::sf::mathieu::b(), and get().

subvector()

vector_complex_float gsl::vector_complex_float::subvector ( size_t  i, size_t  n  )

inline

C++ version of gsl_vector_complex_float_subvector().

Parameters

i	The offset
n	The size

Returns

A subvector

Definition at line 1605 of file vector_complex_float.hpp.

References get(), gsl::rstat::n(), and vector_complex_float().

subvector_with_stride()

vector_complex_float gsl::vector_complex_float::subvector_with_stride ( size_t  i, size_t  stride, size_t  n  )

inline

C++ version of gsl_vector_complex_float_subvector_with_stride().

Parameters

i	The offset
stride	The stride
n	The size

Returns

A subvector

Definition at line 1619 of file vector_complex_float.hpp.

References get(), gsl::rstat::n(), and vector_complex_float().

swap()

void gsl::vector_complex_float::swap ( vector_complex_float &  v )

inline

Swap two vector_complex_float objects.

This works even if the vector_complex_float objects have different sizes because it swaps pointers.

Parameters

v	The vector_complex_float to swap with this.

Definition at line 1141 of file vector_complex_float.hpp.

References ccgsl_pointer, and count.

swap_elements()

int gsl::vector_complex_float::swap_elements ( size_t const  i, size_t const  j  )

inline

C++ version of gsl_vector_complex_float_swap_elements().

Parameters

i	first element
j	second element

Returns

error code on failure

Definition at line 1307 of file vector_complex_float.hpp.

References get().

unique()

bool gsl::vector_complex_float::unique ( ) const

inline

Find if this is the only object sharing the gsl_vector_complex_float.

Returns

true or falses according as this is the only vector_complex_float object sharing the gsl_vector_complex_float

Definition at line 1251 of file vector_complex_float.hpp.

References count.

use_count()

size_t gsl::vector_complex_float::use_count ( ) const

inline

Find how many vector_complex_float objects share this pointer.

Returns

the number of vector_complex_float objects that share this pointer

Definition at line 1256 of file vector_complex_float.hpp.

References count.

view_array() [1/2]

template<typename ARRAY >

static vector_complex_float gsl::vector_complex_float::view_array ( ARRAY &  v, size_t  n = 0  )

inlinestatic

C++ version of gsl_vector_complex_float_view_array().

Parameters

v	An array of float
n	The size of the vector_complex_float: the default gives access to the whole array

Returns

A vector_complex_float

Definition at line 1691 of file vector_complex_float.hpp.

References gsl::exception::GSL_EBADLEN, gsl::rstat::n(), and vector_complex_float().

view_array() [2/2]

static vector_complex_float gsl::vector_complex_float::view_array ( float *  v, size_t  n  )

inlinestatic

C++ version of gsl_vector_complex_float_view_array().

Parameters

v	An array of type float
n	The size of the vector_complex_float

Returns

A vector_complex_float

Definition at line 1520 of file vector_complex_float.hpp.

References gsl::rstat::n(), and vector_complex_float().

view_array_with_stride() [1/2]

template<typename ARRAY >

static vector_complex_float gsl::vector_complex_float::view_array_with_stride ( ARRAY &  base, size_t  stride, size_t  n = 0  )

inlinestatic

C++ version of gsl_vector_complex_float_view_array_with_stride().

Parameters

base	An array of type float
stride	The stride
n	The size of the vector_complex_float: the default gives access to the whole array

Returns

A vector_complex_float

Definition at line 1710 of file vector_complex_float.hpp.

References gsl::exception::GSL_EBADLEN, gsl::rstat::n(), and vector_complex_float().

view_array_with_stride() [2/2]

static vector_complex_float gsl::vector_complex_float::view_array_with_stride ( float *  base, size_t  stride, size_t  n  )

inlinestatic

C++ version of gsl_vector_complex_float_view_array_with_stride().

Parameters

base	An array of type float
stride	The stride
n	The size of the vector_complex_float

Returns

A vector_complex_float

Definition at line 1534 of file vector_complex_float.hpp.

References gsl::rstat::n(), and vector_complex_float().

wrap_gsl_vector_complex_float_without_ownership()

void gsl::vector_complex_float::wrap_gsl_vector_complex_float_without_ownership ( gsl_vector_complex_float *  v )

inline

This function is intended mainly for internal use.

It allows this to point to a gsl_vector_complex_float without the possibility deleting it when this is no longer in scope. It is the responsibility of the programmer to delete v. The function is used internally for converting a function that takes a gsl::vector_complex_float* argument to one that takes a gsl_vector_complex_float* argument.

Parameters

v	The gsl_vector_complex_float

Definition at line 197 of file vector_complex_float.hpp.

References ccgsl_pointer, count, and owns_data.

Referenced by gsl::matrix_complex_float::operator[]().

Member Data Documentation

ccgsl_pointer

gsl_vector_complex_float* gsl::vector_complex_float::ccgsl_pointer

private

The shared pointer.

Definition at line 1229 of file vector_complex_float.hpp.

Referenced by const_ptr(), data(), empty(), end(), get(), max_size(), operator bool(), gsl::vector_complex_float::iterator_t< reverse_t >::operator-(), gsl::vector_complex_float::const_iterator_t< reverse_t >::operator-(), gsl::vector_complex_float::iterator_t< reverse_t >::operator<(), gsl::vector_complex_float::const_iterator_t< reverse_t >::operator<(), operator<(), operator=(), operator==(), operator>(), operator[](), ptr(), rbegin(), size(), swap(), vector_complex_float(), wrap_gsl_vector_complex_float_without_ownership(), and ~vector_complex_float().

count

size_t* gsl::vector_complex_float::count

private

The shared reference count.

Definition at line 1233 of file vector_complex_float.hpp.

Referenced by operator=(), swap(), unique(), use_count(), vector_complex_float(), wrap_gsl_vector_complex_float_without_ownership(), and ~vector_complex_float().

owns_data

bool gsl::vector_complex_float::owns_data

private

Used to allow a vector that does not own its data.

Definition at line 1225 of file vector_complex_float.hpp.

Referenced by operator=(), vector_complex_float(), wrap_gsl_vector_complex_float_without_ownership(), and ~vector_complex_float().

---

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

• vector_complex_float.hpp