ViennaCL - The Vienna Computing Library
1.5.2
|
Common base class for dense vectors, vector ranges, and vector slices. More...
#include <forwards.h>
Public Types | |
typedef scalar< SCALARTYPE > | value_type |
typedef SCALARTYPE | cpu_value_type |
typedef viennacl::backend::mem_handle | handle_type |
typedef SizeType | size_type |
typedef DistanceType | difference_type |
typedef const_vector_iterator < SCALARTYPE, 1 > | const_iterator |
typedef vector_iterator < SCALARTYPE, 1 > | iterator |
Public Member Functions | |
vector_base () | |
Default constructor in order to be compatible with various containers. More... | |
vector_base (viennacl::backend::mem_handle &h, size_type vec_size, size_type vec_start, difference_type vec_stride) | |
An explicit constructor for wrapping an existing vector into a vector_range or vector_slice. More... | |
vector_base (size_type vec_size, viennacl::context ctx=viennacl::context()) | |
Creates a vector and allocates the necessary memory. More... | |
vector_base (SCALARTYPE *ptr_to_mem, viennacl::memory_types mem_type, size_type vec_size, vcl_size_t start=0, difference_type stride=1) | |
template<typename LHS , typename RHS , typename OP > | |
vector_base (vector_expression< const LHS, const RHS, OP > const &proxy) | |
Creates the vector from the supplied random vector. More... | |
self_type & | operator= (const self_type &vec) |
Assignment operator. Other vector needs to be of the same size, or this vector is not yet initialized. More... | |
template<typename LHS , typename RHS , typename OP > | |
self_type & | operator= (const vector_expression< const LHS, const RHS, OP > &proxy) |
Implementation of the operation v1 = v2 @ alpha, where @ denotes either multiplication or division, and alpha is either a CPU or a GPU scalar. More... | |
template<typename T > | |
self_type & | operator= (const vector_base< T > &v1) |
self_type & | operator= (unit_vector< SCALARTYPE > const &v) |
Creates the vector from the supplied unit vector. More... | |
self_type & | operator= (zero_vector< SCALARTYPE > const &v) |
Creates the vector from the supplied zero vector. More... | |
self_type & | operator= (scalar_vector< SCALARTYPE > const &v) |
Creates the vector from the supplied scalar vector. More... | |
template<typename F > | |
self_type & | operator= (const viennacl::vector_expression< const matrix_base< SCALARTYPE, F >, const vector_base< SCALARTYPE >, viennacl::op_prod > &proxy) |
Operator overload for v1 = A * v2, where v1, v2 are vectors and A is a dense matrix. More... | |
template<typename F > | |
self_type & | operator= (const vector_expression< const matrix_expression< const matrix_base< SCALARTYPE, F >, const matrix_base< SCALARTYPE, F >, op_trans >, const vector_base< SCALARTYPE >, op_prod > &proxy) |
Operator overload for v1 = trans(A) * v2, where v1, v2 are vectors and A is a dense matrix. More... | |
entry_proxy< SCALARTYPE > | operator() (size_type index) |
Read-write access to a single element of the vector. More... | |
entry_proxy< SCALARTYPE > | operator[] (size_type index) |
Read-write access to a single element of the vector. More... | |
const_entry_proxy< SCALARTYPE > | operator() (size_type index) const |
Read access to a single element of the vector. More... | |
const_entry_proxy< SCALARTYPE > | operator[] (size_type index) const |
Read access to a single element of the vector. More... | |
self_type & | operator+= (const self_type &vec) |
self_type & | operator-= (const self_type &vec) |
self_type & | operator*= (SCALARTYPE val) |
Scales a vector (or proxy) by a CPU scalar value. More... | |
self_type & | operator/= (SCALARTYPE val) |
Scales this vector by a CPU scalar value. More... | |
vector_expression< const self_type, const SCALARTYPE, op_mult > | operator* (SCALARTYPE value) const |
Scales the vector by a CPU scalar 'alpha' and returns an expression template. More... | |
vector_expression< const self_type, const SCALARTYPE, op_div > | operator/ (SCALARTYPE value) const |
Scales the vector by a CPU scalar 'alpha' and returns an expression template. More... | |
vector_expression< const self_type, const SCALARTYPE, op_mult > | operator- () const |
Sign flip for the vector. Emulated to be equivalent to -1.0 * vector. More... | |
iterator | begin () |
Returns an iterator pointing to the beginning of the vector (STL like) More... | |
iterator | end () |
Returns an iterator pointing to the end of the vector (STL like) More... | |
const_iterator | begin () const |
Returns a const-iterator pointing to the beginning of the vector (STL like) More... | |
const_iterator | end () const |
Returns a const-iterator pointing to the end of the vector (STL like) More... | |
self_type & | swap (self_type &other) |
Swaps the entries of the two vectors. More... | |
size_type | size () const |
Returns the length of the vector (cf. std::vector) More... | |
size_type | internal_size () const |
Returns the internal length of the vector, which is given by size() plus the extra memory due to padding the memory with zeros up to a multiple of 'ALIGNMENT'. More... | |
size_type | start () const |
Returns the offset within the buffer. More... | |
size_type | stride () const |
Returns the stride within the buffer (in multiples of sizeof(SCALARTYPE)) More... | |
bool | empty () const |
Returns true is the size is zero. More... | |
const handle_type & | handle () const |
Returns the memory handle. More... | |
handle_type & | handle () |
Returns the memory handle. More... | |
void | clear () |
Resets all entries to zero. Does not change the size of the vector. More... | |
viennacl::memory_types | memory_domain () const |
Static Public Attributes | |
static const size_type | alignment = 128 |
Protected Member Functions | |
void | set_handle (viennacl::backend::mem_handle const &h) |
self_type & | fast_swap (self_type &other) |
Swaps the handles of two vectors by swapping the OpenCL handles only, no data copy. More... | |
void | pad () |
Pads vectors with alignment > 1 with trailing zeros if the internal size is larger than the visible size. More... | |
void | switch_memory_context (viennacl::context new_ctx) |
void | resize (size_type new_size, bool preserve=true) |
Resizes the allocated memory for the vector. Pads the memory to be a multiple of 'ALIGNMENT'. More... | |
void | resize (size_type new_size, viennacl::context ctx, bool preserve=true) |
Resizes the allocated memory for the vector. Convenience function for setting an OpenCL context in case reallocation is needed. More... | |
Common base class for dense vectors, vector ranges, and vector slices.
SCALARTYPE | The floating point type, either 'float' or 'double' |
typedef const_vector_iterator<SCALARTYPE, 1> const_iterator |
typedef SCALARTYPE cpu_value_type |
typedef DistanceType difference_type |
typedef vector_iterator<SCALARTYPE, 1> iterator |
typedef SizeType size_type |
typedef scalar<SCALARTYPE> value_type |
|
inlineexplicit |
Default constructor in order to be compatible with various containers.
|
inlineexplicit |
An explicit constructor for wrapping an existing vector into a vector_range or vector_slice.
h | The existing memory handle from a vector/vector_range/vector_slice |
vec_size | The length (i.e. size) of the buffer |
vec_start | The offset from the beginning of the buffer identified by 'h' |
vec_stride | Increment between two elements in the original buffer (in multiples of SCALARTYPE) |
|
inlineexplicit |
Creates a vector and allocates the necessary memory.
|
inlineexplicit |
|
inlineexplicit |
Creates the vector from the supplied random vector.
|
inline |
Returns an iterator pointing to the beginning of the vector (STL like)
|
inline |
Returns a const-iterator pointing to the beginning of the vector (STL like)
|
inline |
Resets all entries to zero. Does not change the size of the vector.
|
inline |
Returns true is the size is zero.
|
inline |
Returns an iterator pointing to the end of the vector (STL like)
|
inline |
Returns a const-iterator pointing to the end of the vector (STL like)
Swaps the handles of two vectors by swapping the OpenCL handles only, no data copy.
|
inline |
Returns the memory handle.
|
inline |
Returns the memory handle.
|
inline |
Returns the internal length of the vector, which is given by size() plus the extra memory due to padding the memory with zeros up to a multiple of 'ALIGNMENT'.
|
inline |
|
inline |
Read-write access to a single element of the vector.
|
inline |
Read access to a single element of the vector.
|
inline |
Scales the vector by a CPU scalar 'alpha' and returns an expression template.
|
inline |
Scales a vector (or proxy) by a CPU scalar value.
|
inline |
Sign flip for the vector. Emulated to be equivalent to -1.0 * vector.
|
inline |
Scales the vector by a CPU scalar 'alpha' and returns an expression template.
|
inline |
Scales this vector by a CPU scalar value.
Assignment operator. Other vector needs to be of the same size, or this vector is not yet initialized.
|
inline |
Implementation of the operation v1 = v2 @ alpha, where @ denotes either multiplication or division, and alpha is either a CPU or a GPU scalar.
proxy | An expression template proxy class. |
|
inline |
|
inline |
Creates the vector from the supplied unit vector.
|
inline |
Creates the vector from the supplied zero vector.
|
inline |
Creates the vector from the supplied scalar vector.
|
inline |
Operator overload for v1 = A * v2, where v1, v2 are vectors and A is a dense matrix.
proxy | An expression template proxy class |
|
inline |
Operator overload for v1 = trans(A) * v2, where v1, v2 are vectors and A is a dense matrix.
proxy | An expression template proxy class |
|
inline |
Read-write access to a single element of the vector.
|
inline |
Read access to a single element of the vector.
|
inlineprotected |
Pads vectors with alignment > 1 with trailing zeros if the internal size is larger than the visible size.
|
inlineprotected |
Resizes the allocated memory for the vector. Pads the memory to be a multiple of 'ALIGNMENT'.
new_size | The new size of the vector |
preserve | If true, old entries of the vector are preserved, otherwise eventually discarded. |
|
inlineprotected |
Resizes the allocated memory for the vector. Convenience function for setting an OpenCL context in case reallocation is needed.
new_size | The new size of the vector |
ctx | The context within which the new memory should be allocated |
preserve | If true, old entries of the vector are preserved, otherwise eventually discarded. |
|
inlineprotected |
|
inline |
Returns the length of the vector (cf. std::vector)
|
inline |
Returns the offset within the buffer.
|
inline |
Returns the stride within the buffer (in multiples of sizeof(SCALARTYPE))
|
inlineprotected |
|
static |