![]() |
Modules | |
Expressions | |
CompressedVector | |
Classes | |
struct | blaze::SparseVector< VT, TF > |
Base class for sparse vectors.The SparseVector class is a base class for all arbitrarily sized (N-dimensional) sparse vectors. It provides an abstraction from the actual type of the sparse vector, but enables a conversion back to this type via the Vector base class. More... | |
Functions | |
template<typename T1 , typename T2 , bool TF> | |
const DVecSVecMultExpr< T1, T2, TF > | blaze::operator* (const DenseVector< T1, TF > &lhs, const SparseVector< T2, TF > &rhs) |
Multiplication operator for the componentwise product of a dense vector and a sparse vector ( ![]() | |
template<typename T1 , typename T2 > | |
const DisableIf< Or< IsSymmetric< T1 >, IsMatMatMultExpr< T1 > >, SMatSVecMultExpr< T1, T2 > >::Type | blaze::operator* (const SparseMatrix< T1, false > &mat, const SparseVector< T2, false > &vec) |
Multiplication operator for the multiplication of a row-major sparse matrix and a sparse vector ( ![]() | |
template<typename VT , bool TF> | |
const SVecAbsExpr< VT, TF > | blaze::abs (const SparseVector< VT, TF > &sv) |
Returns a vector containing the absolute values of each single element of sv. More... | |
template<typename T1 , typename T2 , bool TF> | |
const SVecDVecMultExpr< T1, T2, TF > | blaze::operator* (const SparseVector< T1, TF > &lhs, const DenseVector< T2, TF > &rhs) |
Multiplication operator for the componentwise product of a sparse vector and a dense vector ( ![]() | |
template<typename VT , bool TF> | |
const SVecEvalExpr< VT, TF > | blaze::eval (const SparseVector< VT, TF > &sv) |
Forces the evaluation of the given sparse vector expression sv. More... | |
template<typename T1 , typename T2 , bool TF> | |
const EnableIf< IsNumeric< T2 >, typename DivExprTrait< T1, T2 >::Type >::Type | blaze::operator/ (const SparseVector< T1, TF > &vec, T2 scalar) |
Division operator for the divison of a sparse vector by a scalar value ( ![]() | |
template<typename VT , bool TF> | |
const SVecScalarMultExpr< VT, typename BaseElementType< VT >::Type, TF > | blaze::operator- (const SparseVector< VT, TF > &sv) |
Unary minus operator for the negation of a sparse vector ( ![]() | |
template<typename T1 , typename T2 , bool TF> | |
const EnableIf< IsNumeric< T2 >, typename MultExprTrait< T1, T2 >::Type >::Type | blaze::operator* (const SparseVector< T1, TF > &vec, T2 scalar) |
Multiplication operator for the multiplication of a sparse vector and a scalar value ( ![]() | |
template<typename T1 , typename T2 , bool TF> | |
const EnableIf< IsNumeric< T1 >, typename MultExprTrait< T1, T2 >::Type >::Type | blaze::operator* (T1 scalar, const SparseVector< T2, TF > &vec) |
Multiplication operator for the multiplication of a scalar value and a sparse vector ( ![]() | |
template<typename VT , bool TF> | |
const SVecSerialExpr< VT, TF > | blaze::serial (const SparseVector< VT, TF > &sv) |
Forces the serial evaluation of the given sparse vector expression sv. More... | |
template<typename T1 , typename T2 , bool TF> | |
const SVecSVecAddExpr< T1, T2, TF > | blaze::operator+ (const SparseVector< T1, TF > &lhs, const SparseVector< T2, TF > &rhs) |
Addition operator for the addition of two sparse vectors ( ![]() | |
template<typename T1 , typename T2 , bool TF> | |
const SVecSVecMultExpr< T1, T2, TF > | blaze::operator* (const SparseVector< T1, TF > &lhs, const SparseVector< T2, TF > &rhs) |
Multiplication operator for the componentwise multiplication of two sparse vectors ( ![]() | |
template<typename T1 , typename T2 , bool TF> | |
const SVecSVecSubExpr< T1, T2, TF > | blaze::operator- (const SparseVector< T1, TF > &lhs, const SparseVector< T2, TF > &rhs) |
Subtraction operator for the subtraction of two sparse vectors ( ![]() | |
template<typename VT , bool TF> | |
const SVecTransExpr< VT,!TF > | blaze::trans (const SparseVector< VT, TF > &sv) |
Calculation of the transpose of the given sparse vector. More... | |
template<typename T1 , typename T2 > | |
const MultTrait< typename T1::ElementType, typename T2::ElementType >::Type | blaze::operator* (const DenseVector< T1, true > &lhs, const SparseVector< T2, false > &rhs) |
Multiplication operator for the scalar product (inner product) of a dense and a sparse vector ( ![]() | |
template<typename T1 , typename T2 > | |
const DisableIf< IsMatMatMultExpr< T1 >, TSMatSVecMultExpr< T1, T2 > >::Type | blaze::operator* (const SparseMatrix< T1, true > &mat, const SparseVector< T2, false > &vec) |
Multiplication operator for the multiplication of a transpose sparse matrix and a sparse vector ( ![]() | |
template<typename T1 , typename T2 > | |
const MultTrait< typename T1::ElementType, typename T2::ElementType >::Type | blaze::operator* (const SparseVector< T1, true > &lhs, const DenseVector< T2, false > &rhs) |
Multiplication operator for the scalar product (inner product) of a sparse and a dense vector ( ![]() | |
template<typename T1 , typename T2 > | |
const DisableIf< IsMatMatMultExpr< T2 >, TSVecSMatMultExpr< T1, T2 > >::Type | blaze::operator* (const SparseVector< T1, true > &vec, const SparseMatrix< T2, false > &mat) |
Multiplication operator for the multiplication of a transpose sparse vector and a row-major sparse matrix ( ![]() | |
template<typename T1 , typename T2 , bool SO> | |
const EnableIf< IsMatMatMultExpr< T2 >, typename MultExprTrait< T1, T2 >::Type >::Type | blaze::operator* (const SparseVector< T1, true > &vec, const SparseMatrix< T2, SO > &mat) |
Multiplication operator for the multiplication of a transpose sparse vector and a sparse matrix-matrix multiplication expression ( ![]() | |
template<typename T1 , typename T2 > | |
const MultTrait< typename T1::ElementType, typename T2::ElementType >::Type | blaze::operator* (const SparseVector< T1, true > &lhs, const SparseVector< T2, false > &rhs) |
Multiplication operator for the scalar product (inner product) of two sparse vectors ( ![]() | |
template<typename T1 , typename T2 > | |
const DisableIf< Or< IsSymmetric< T2 >, IsMatMatMultExpr< T2 > >, TSVecTSMatMultExpr< T1, T2 > >::Type | blaze::operator* (const SparseVector< T1, true > &vec, const SparseMatrix< T2, true > &mat) |
Multiplication operator for the multiplication of a transpose sparse vector and a column-major sparse matrix ( ![]() | |
SparseVector operators | |
template<typename T1 , bool TF1, typename T2 , bool TF2> | |
bool | blaze::operator== (const SparseVector< T1, TF1 > &lhs, const SparseVector< T2, TF2 > &rhs) |
Equality operator for the comparison of two sparse vectors. More... | |
template<typename T1 , bool TF1, typename T2 , bool TF2> | |
bool | blaze::operator!= (const SparseVector< T1, TF1 > &lhs, const SparseVector< T2, TF2 > &rhs) |
Inequality operator for the comparison of two sparse vectors. More... | |
SparseVector functions | |
template<typename VT , bool TF> | |
bool | blaze::isnan (const SparseVector< VT, TF > &sv) |
Checks the given sparse vector for not-a-number elements. More... | |
template<typename VT , bool TF> | |
bool | blaze::isUniform (const SparseVector< VT, TF > &sv) |
Checks if the given sparse vector is a uniform vector. More... | |
template<typename VT , bool TF> | |
CMathTrait< typename VT::ElementType >::Type | blaze::length (const SparseVector< VT, TF > &sv) |
Calculation of the sparse vector length ![]() | |
template<typename VT , bool TF> | |
const VT::ElementType | blaze::sqrLength (const SparseVector< VT, TF > &sv) |
Calculation of the sparse vector square length ![]() | |
template<typename VT , bool TF> | |
const VT::ElementType | blaze::min (const SparseVector< VT, TF > &sv) |
Returns the smallest element of the sparse vector. More... | |
template<typename VT , bool TF> | |
const VT::ElementType | blaze::max (const SparseVector< VT, TF > &sv) |
Returns the largest element of the sparse vector. More... | |
|
inline |
Returns a vector containing the absolute values of each single element of sv.
sv | The integral sparse input vector. |
The abs function calculates the absolute value of each element of the sparse input vector sv. The function returns an expression representing this operation.
The following example demonstrates the use of the abs function:
|
inline |
Forces the evaluation of the given sparse vector expression sv.
sv | The input vector. |
The eval function forces the evaluation of the given sparse vector expression sv. The function returns an expression representing this operation.
The following example demonstrates the use of the eval function:
|
inline |
Checks the given sparse vector for not-a-number elements.
sv | The sparse vector to be checked for not-a-number elements. |
This function checks the N-dimensional sparse vector for not-a-number (NaN) elements. If at least one element of the vector is not-a-number, the function returns true, otherwise it returns false.
Note that this function only works for vectors with floating point elements. The attempt to use it for a vector with a non-floating point element type results in a compile time error.
bool blaze::isUniform | ( | const SparseVector< VT, TF > & | sv | ) |
Checks if the given sparse vector is a uniform vector.
sv | The sparse vector to be checked. |
This function checks if the given sparse vector is a uniform vector. The vector is considered to be uniform if all its elements are identical. The following code example demonstrates the use of the function:
It is also possible to check if a vector expression results in a uniform vector:
However, note that this might require the complete evaluation of the expression, including the generation of a temporary vector.
CMathTrait< typename VT::ElementType >::Type blaze::length | ( | const SparseVector< VT, TF > & | sv | ) |
Calculation of the sparse vector length .
sv | The given sparse vector. |
This function calculates the actual length of the sparse vector. The return type of the length() function depends on the actual element type of the vector instance:
Type | LengthType |
float | float |
integral data types and double | double |
long double | long double |
Note: This operation is only defined for numeric data types. In case the element type is not a numeric data type (i.e. a user defined data type or boolean) the attempt to use the length() function results in a compile time error!
const VT::ElementType blaze::max | ( | const SparseVector< VT, TF > & | sv | ) |
Returns the largest element of the sparse vector.
sv | The given sparse vector. |
This function returns the largest element of the given sparse vector. This function can only be used for element types that support the smaller-than relationship. In case the vector currently has a size of 0, the returned value is the default value (e.g. 0 in case of fundamental data types).
Note: In case the compressed vector is not completely filled, the zero elements are also taken into account. Example: the following compressed vector has only 2 non-zero elements. However, the maximum of this vector is 0:
const VT::ElementType blaze::min | ( | const SparseVector< VT, TF > & | sv | ) |
Returns the smallest element of the sparse vector.
sv | The given sparse vector. |
This function returns the smallest element of the given sparse vector. This function can only be used for element types that support the smaller-than relationship. In case the vector currently has a size of 0, the returned value is the default value (e.g. 0 in case of fundamental data types).
Note: In case the sparse vector is not completely filled, the zero elements are also taken into account. Example: the following compressed vector has only 2 non-zero elements. However, the minimum of this vector is 0:
|
inline |
Inequality operator for the comparison of two sparse vectors.
lhs | The left-hand side sparse vector for the comparison. |
rhs | The right-hand side sparse vector for the comparison. |
|
inline |
Multiplication operator for the scalar product (inner product) of two sparse vectors ( ).
lhs | The left-hand side sparse vector for the inner product. |
rhs | The right-hand side sparse vector for the inner product. |
std::invalid_argument | Vector sizes do not match. |
This operator represents the scalar product (inner product) of two sparse vectors:
The operator returns a scalar value of the higher-order element type of the two involved vector element types T1::ElementType and T2::ElementType. Both vector types T1 and T2 as well as the two element types T1::ElementType and T2::ElementType have to be supported by the MultTrait class template.
In case the current sizes of the two given vectors don't match, a std::invalid_argument is thrown.
|
inline |
Multiplication operator for the scalar product (inner product) of a sparse and a dense vector ( ).
lhs | The left-hand side sparse vector for the inner product. |
rhs | The right-hand side dense vector for the inner product. |
std::invalid_argument | Vector sizes do not match. |
This operator represents the scalar product (inner product) of a sparse vector and a dense vector:
The operator returns a scalar value of the higher-order element type of the two involved vector element types T1::ElementType and T2::ElementType. Both vector types T1 and T2 as well as the two element types T1::ElementType and T2::ElementType have to be supported by the MultTrait class template.
In case the current sizes of the two given vectors don't match, a std::invalid_argument is thrown.
|
inline |
Multiplication operator for the scalar product (inner product) of a dense and a sparse vector ( ).
lhs | The left-hand side dense vector for the inner product. |
rhs | The right-hand side sparse vector for the inner product. |
std::invalid_argument | Vector sizes do not match. |
This operator represents the scalar product (inner product) of a dense vector and a sparse vector:
The operator returns a scalar value of the higher-order element type of the two involved vector element types T1::ElementType and T2::ElementType. Both vector types T1 and T2 as well as the two element types T1::ElementType and T2::ElementType have to be supported by the MultTrait class template.
In case the current sizes of the two given vectors don't match, a std::invalid_argument is thrown.
|
inline |
Multiplication operator for the componentwise multiplication of two sparse vectors ( ).
lhs | The left-hand side sparse vector for the component product. |
rhs | The right-hand side sparse vector for the component product. |
std::invalid_argument | Vector sizes do not match. |
This operator represents the componentwise multiplication of two sparse vectors:
The operator returns a sparse vector of the higher-order element type of the two involved vector element types T1::ElementType and T2::ElementType. Both vector types T1 and T2 as well as the two element types T1::ElementType and T2::ElementType have to be supported by the MultTrait class template.
In case the current sizes of the two given vectors don't match, a std::invalid_argument is thrown.
|
inline |
Multiplication operator for the componentwise product of a sparse vector and a dense vector ( ).
lhs | The left-hand side sparse vector for the component product. |
rhs | The right-hand side dense vector for the component product. |
std::invalid_argument | Vector sizes do not match. |
This operator represents the componentwise multiplication of a sparse vector and a dense vector:
The operator returns an expression representing a sparse vector of the higher-order element type of the two involved vector element types T1::ElementType and T2::ElementType. Both vector types T1 and T2 as well as the two element types T1::ElementType and T2::ElementType have to be supported by the MultTrait class template.
In case the current sizes of the two given vectors don't match, a std::invalid_argument is thrown.
|
inline |
Multiplication operator for the componentwise product of a dense vector and a sparse vector ( ).
lhs | The left-hand side dense vector for the component product. |
rhs | The right-hand side sparse vector for the component product. |
std::invalid_argument | Vector sizes do not match. |
This operator represents the componentwise multiplication of a dense vector and a sparse vector:
The operator returns an expression representing a sparse vector of the higher-order element type of the two involved vector element types T1::ElementType and T2::ElementType. Both vector types T1 and T2 as well as the two element types T1::ElementType and T2::ElementType have to be supported by the MultTrait class template.
In case the current sizes of the two given vectors don't match, a std::invalid_argument is thrown.
|
inline |
Multiplication operator for the multiplication of a sparse vector and a scalar value ( ).
vec | The left-hand side sparse vector for the multiplication. |
scalar | The right-hand side scalar value for the multiplication. |
This operator represents the multiplication between a sparse vector and a scalar value:
The operator returns a sparse vector of the higher-order element type of the involved data types T1::ElementType and T2. Note that this operator only works for scalar values of built-in data type.
|
inline |
Multiplication operator for the multiplication of a scalar value and a sparse vector ( ).
scalar | The left-hand side scalar value for the multiplication. |
vec | The right-hand side sparse vector for the multiplication. |
This operator represents the multiplication between a a scalar value and sparse vector:
The operator returns a sparse vector of the higher-order element type of the involved data types T1 and T2::ElementType. Note that this operator only works for scalar values of built-in data type.
|
inline |
Multiplication operator for the multiplication of a transpose sparse matrix and a sparse vector ( ).
mat | The left-hand side sparse matrix for the multiplication. |
vec | The right-hand side sparse vector for the multiplication. |
std::invalid_argument | Matrix and vector sizes do not match. |
This operator represents the multiplication between a transpose sparse matrix and a sparse vector:
The operator returns an expression representing a sparse vector of the higher-order element type of the two involved element types T1::ElementType and T2::ElementType. Both the sparse matrix type T1 and the sparse vector type T2 as well as the two element types T1::ElementType and T2::ElementType have to be supported by the MultTrait class template.
In case the current size of the vector vec doesn't match the current number of columns of the matrix mat, a std::invalid_argument is thrown.
|
inline |
Multiplication operator for the multiplication of a transpose sparse vector and a row-major sparse matrix ( ).
vec | The left-hand side transpose sparse vector for the multiplication. |
mat | The right-hand side row-major sparse matrix for the multiplication. |
std::invalid_argument | Vector and matrix sizes do not match. |
This operator represents the multiplication between a transpose sparse vector and a row-major sparse matrix:
The operator returns an expression representing a transpose sparse vector of the higher-order element type of the two involved element types T1::ElementType and T2::ElementType. Both the sparse vector type T1 and the sparse matrix type T2 as well as the two element types T1::ElementType and T2::ElementType have to be supported by the MultTrait class template.
In case the current size of the vector vec doesn't match the current number of rows of the matrix mat, a std::invalid_argument is thrown.
|
inline |
Multiplication operator for the multiplication of a transpose sparse vector and a sparse matrix-matrix multiplication expression ( ).
vec | The left-hand side sparse vector for the multiplication. |
mat | The right-hand side sparse matrix-matrix multiplication. |
This operator implements a performance optimized treatment of the multiplication of a sparse vector and a sparse matrix-matrix multiplication expression. It restructures the expression to the expression
.
|
inline |
Multiplication operator for the multiplication of a transpose sparse vector and a column-major sparse matrix ( ).
vec | The left-hand side transpose sparse vector for the multiplication. |
mat | The right-hand side column-major sparse matrix for the multiplication. |
std::invalid_argument | Vector and matrix sizes do not match. |
This operator represents the multiplication between a transpose sparse vector and a column-major sparse matrix:
The operator returns an expression representing a transpose sparse vector of the higher-order element type of the two involved element types T1::ElementType and T2::ElementType. Both the sparse vector type T1 and the sparse matrix type T2 as well as the two element types T1::ElementType and T2::ElementType have to be supported by the MultTrait class template.
In case the current size of the vector vec doesn't match the current number of rows of the matrix mat, a std::invalid_argument is thrown.
|
inline |
Multiplication operator for the multiplication of a row-major sparse matrix and a sparse vector ( ).
mat | The left-hand side sparse matrix for the multiplication. |
vec | The right-hand side sparse vector for the multiplication. |
std::invalid_argument | Matrix and vector sizes do not match. |
This operator represents the multiplication between a row-major sparse matrix and a sparse vector:
The operator returns an expression representing a sparse vector of the higher-order element type of the two involved element types T1::ElementType and T2::ElementType. Both the sparse matrix type T1 and the sparse vector type T2 as well as the two element types T1::ElementType and T2::ElementType have to be supported by the MultTrait class template.
In case the current size of the vector vec doesn't match the current number of columns of the matrix mat, a std::invalid_argument is thrown.
|
inline |
Addition operator for the addition of two sparse vectors ( ).
lhs | The left-hand side sparse vector for the vector addition. |
rhs | The right-hand side sparse vector for the vector addition. |
std::invalid_argument | Vector sizes do not match. |
This operator represents the addition of two sparse vectors:
The operator returns a sparse vector of the higher-order element type of the two involved vector element types T1::ElementType and T2::ElementType. Both vector types T1 and T2 as well as the two element types T1::ElementType and T2::ElementType have to be supported by the AddTrait class template.
In case the current sizes of the two given vectors don't match, a std::invalid_argument is thrown.
|
inline |
Subtraction operator for the subtraction of two sparse vectors ( ).
lhs | The left-hand side sparse vector for the vector subtraction. |
rhs | The right-hand side sparse vector to be subtracted from the vector. |
std::invalid_argument | Vector sizes do not match. |
This operator represents the subtraction of two sparse vectors:
The operator returns a sparse vector of the higher-order element type of the two involved vector element types T1::ElementType and T2::ElementType. Both vector types T1 and T2 as well as the two element types T1::ElementType and T2::ElementType have to be supported by the SubTrait class template.
In case the current sizes of the two given vectors don't match, a std::invalid_argument is thrown.
|
inline |
Unary minus operator for the negation of a sparse vector ( ).
sv | The sparse vector to be negated. |
This operator represents the negation of a sparse vector:
The operator returns an expression representing the negation of the given sparse vector.
|
inline |
Division operator for the divison of a sparse vector by a scalar value ( ).
vec | The left-hand side sparse vector for the division. |
scalar | The right-hand side scalar value for the division. |
This operator represents the division of a sparse vector by a scalar value:
The operator returns a sparse vector of the higher-order element type of the involved data types T1::ElementType and T2. Note that this operator only works for scalar values of built-in data type.
Note: A division by zero is only checked by an user assert.
|
inline |
Equality operator for the comparison of two sparse vectors.
lhs | The left-hand side sparse vector for the comparison. |
rhs | The right-hand side sparse vector for the comparison. |
|
inline |
Forces the serial evaluation of the given sparse vector expression sv.
sv | The input vector. |
The serial function forces the serial evaluation of the given sparse vector expression sv. The function returns an expression representing this operation.
The following example demonstrates the use of the serial function:
const VT::ElementType blaze::sqrLength | ( | const SparseVector< VT, TF > & | sv | ) |
Calculation of the sparse vector square length .
sv | The given sparse vector. |
This function calculates the actual square length of the sparse vector.
Note: This operation is only defined for numeric data types. In case the element type is not a numeric data type (i.e. a user defined data type or boolean) the attempt to use the sqrLength() function results in a compile time error!
|
inline |
Calculation of the transpose of the given sparse vector.
sv | The sparse vector to be transposed. |
This function returns an expression representing the transpose of the given sparse vector: