All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Modules | Functions

Modules

 DenseColumn
 
 DenseRow
 
 Dense Submatrix
 
 Dense Subvector
 
 SparseColumn
 
 SparseRow
 
 Sparse Submatrix
 
 Sparse Subvector
 

Functions

template<typename MT , bool SO>
DisableIf< Or< IsComputation
< MT >, IsTransExpr< MT >
>, DenseColumn< MT > >::Type 
column (DenseMatrix< MT, SO > &dm, size_t index)
 Creating a view on a specific column of the given dense matrix. More...
 
template<typename MT , bool SO>
DisableIf< Or< IsComputation
< MT >, IsTransExpr< MT >
>, DenseColumn< const MT >
>::Type 
column (const DenseMatrix< MT, SO > &dm, size_t index)
 Creating a view on a specific column of the given constant dense matrix. More...
 
template<typename MT , bool SO>
DisableIf< Or< IsComputation
< MT >, IsTransExpr< MT >
>, DenseRow< MT > >::Type 
row (DenseMatrix< MT, SO > &dm, size_t index)
 Creating a view on a specific row of the given dense matrix. More...
 
template<typename MT , bool SO>
DisableIf< Or< IsComputation
< MT >, IsTransExpr< MT >
>, DenseRow< const MT >
>::Type 
row (const DenseMatrix< MT, SO > &dm, size_t index)
 Creating a view on a specific row of the given constant dense matrix. More...
 
template<typename MT , bool SO>
DisableIf< Or< IsComputation
< MT >, IsTransExpr< MT >
>, DenseSubmatrix< MT >
>::Type 
submatrix (DenseMatrix< MT, SO > &dm, size_t row, size_t column, size_t m, size_t n)
 Creating a view on a specific submatrix of the given dense matrix. More...
 
template<typename MT , bool SO>
DisableIf< Or< IsComputation
< MT >, IsTransExpr< MT >
>, DenseSubmatrix< const MT >
>::Type 
submatrix (const DenseMatrix< MT, SO > &dm, size_t row, size_t column, size_t m, size_t n)
 Creating a view on a specific submatrix of the given dense matrix. More...
 
template<typename VT , bool TF>
DisableIf< Or< IsComputation
< VT >, IsTransExpr< VT >
>, DenseSubvector< VT >
>::Type 
blaze::subvector (DenseVector< VT, TF > &dv, size_t index, size_t size)
 Creating a view on a specific subvector of the given dense vector. More...
 
template<typename VT , bool TF>
DisableIf< Or< IsComputation
< VT >, IsTransExpr< VT >
>, DenseSubvector< const VT >
>::Type 
blaze::subvector (const DenseVector< VT, TF > &dv, size_t index, size_t size)
 Creating a view on a specific subvector of the given dense vector. More...
 
template<typename MT , bool SO>
DisableIf< Or< IsComputation
< MT >, IsTransExpr< MT >
>, SparseColumn< MT > >::Type 
column (SparseMatrix< MT, SO > &sm, size_t index)
 Creating a view on a specific column of the given sparse matrix. More...
 
template<typename MT , bool SO>
DisableIf< Or< IsComputation
< MT >, IsTransExpr< MT >
>, SparseColumn< const MT >
>::Type 
column (const SparseMatrix< MT, SO > &sm, size_t index)
 Creating a view on a specific column of the given constant sparse matrix. More...
 
template<typename MT , bool SO>
DisableIf< Or< IsComputation
< MT >, IsTransExpr< MT >
>, SparseRow< MT > >::Type 
row (SparseMatrix< MT, SO > &sm, size_t index)
 Creating a view on a specific row of the given sparse matrix. More...
 
template<typename MT , bool SO>
DisableIf< Or< IsComputation
< MT >, IsTransExpr< MT >
>, SparseRow< const MT >
>::Type 
row (const SparseMatrix< MT, SO > &sm, size_t index)
 Creating a view on a specific row of the given constant sparse matrix. More...
 
template<typename MT , bool SO>
DisableIf< Or< IsComputation
< MT >, IsTransExpr< MT >
>, SparseSubmatrix< MT >
>::Type 
submatrix (SparseMatrix< MT, SO > &sm, size_t row, size_t column, size_t m, size_t n)
 Creating a view on a specific submatrix of the given sparse matrix. More...
 
template<typename MT , bool SO>
DisableIf< Or< IsComputation
< MT >, IsTransExpr< MT >
>, SparseSubmatrix< const MT >
>::Type 
submatrix (const SparseMatrix< MT, SO > &sm, size_t row, size_t column, size_t m, size_t n)
 Creating a view on a specific submatrix of the given sparse matrix. More...
 
template<typename VT , bool TF>
DisableIf< Or< IsComputation
< VT >, IsTransExpr< VT >
>, SparseSubvector< VT >
>::Type 
blaze::subvector (SparseVector< VT, TF > &sv, size_t index, size_t size)
 Creating a view on a specific subvector of the given sparse vector. More...
 
template<typename VT , bool TF>
DisableIf< Or< IsComputation
< VT >, IsTransExpr< VT >
>, SparseSubvector< const VT >
>::Type 
blaze::subvector (const SparseVector< VT, TF > &sv, size_t index, size_t size)
 Creating a view on a specific subvector of the given sparse vector. More...
 

Detailed Description

Function Documentation

template<typename MT , bool SO>
DisableIf< Or< IsComputation<MT>, IsTransExpr<MT> >, DenseColumn<MT> >::Type column ( DenseMatrix< MT, SO > &  dm,
size_t  index 
)
inlineprivate

Creating a view on a specific column of the given dense matrix.

Parameters
dmThe dense matrix containing the column.
indexThe index of the column.
Returns
View on the specified column of the matrix.
Exceptions
std::invalid_argumentInvalid column access index.

This function returns an expression representing the specified column of the given dense matrix.

Matrix A;
// ... Resizing and initialization
template<typename MT , bool SO>
DisableIf< Or< IsComputation<MT>, IsTransExpr<MT> >, DenseColumn<const MT> >::Type column ( const DenseMatrix< MT, SO > &  dm,
size_t  index 
)
inlineprivate

Creating a view on a specific column of the given constant dense matrix.

Parameters
dmThe constant dense matrix containing the column.
indexThe index of the column.
Returns
View on the specified column of the matrix.
Exceptions
std::invalid_argumentInvalid column access index.

This function returns an expression representing the specified column of the given dense matrix.

const Matrix A;
// ... Resizing and initialization
template<typename MT , bool SO>
DisableIf< Or< IsComputation<MT>, IsTransExpr<MT> >, SparseColumn<MT> >::Type column ( SparseMatrix< MT, SO > &  sm,
size_t  index 
)
inlineprivate

Creating a view on a specific column of the given sparse matrix.

Parameters
smThe sparse matrix containing the column.
indexThe index of the column.
Returns
View on the specified column of the matrix.
Exceptions
std::invalid_argumentInvalid column access index.

This function returns an expression representing the specified column of the given sparse matrix.

Matrix A;
// ... Resizing and initialization
template<typename MT , bool SO>
DisableIf< Or< IsComputation<MT>, IsTransExpr<MT> >, SparseColumn<const MT> >::Type column ( const SparseMatrix< MT, SO > &  sm,
size_t  index 
)
inlineprivate

Creating a view on a specific column of the given constant sparse matrix.

Parameters
smThe constant sparse matrix containing the column.
indexThe index of the column.
Returns
View on the specified column of the matrix.
Exceptions
std::invalid_argumentInvalid column access index.

This function returns an expression representing the specified column of the given sparse matrix.

const Matrix A;
// ... Resizing and initialization
template<typename MT , bool SO>
DisableIf< Or< IsComputation<MT>, IsTransExpr<MT> >, DenseRow<MT> >::Type row ( DenseMatrix< MT, SO > &  dm,
size_t  index 
)
inlineprivate

Creating a view on a specific row of the given dense matrix.

Parameters
dmThe dense matrix containing the row.
indexThe index of the row.
Returns
View on the specified row of the matrix.
Exceptions
std::invalid_argumentInvalid row access index.

This function returns an expression representing the specified row of the given dense matrix.

Matrix A;
// ... Resizing and initialization
template<typename MT , bool SO>
DisableIf< Or< IsComputation<MT>, IsTransExpr<MT> >, DenseRow<const MT> >::Type row ( const DenseMatrix< MT, SO > &  dm,
size_t  index 
)
inlineprivate

Creating a view on a specific row of the given constant dense matrix.

Parameters
dmThe constant dense matrix containing the row.
indexThe index of the row.
Returns
View on the specified row of the matrix.
Exceptions
std::invalid_argumentInvalid row access index.

This function returns an expression representing the specified row of the given dense matrix.

const Matrix A;
// ... Resizing and initialization
template<typename MT , bool SO>
DisableIf< Or< IsComputation<MT>, IsTransExpr<MT> >, SparseRow<MT> >::Type row ( SparseMatrix< MT, SO > &  sm,
size_t  index 
)
inlineprivate

Creating a view on a specific row of the given sparse matrix.

Parameters
smThe sparse matrix containing the row.
indexThe index of the row.
Returns
View on the specified row of the matrix.
Exceptions
std::invalid_argumentInvalid row access index.

This function returns an expression representing the specified row of the given sparse matrix.

Matrix A;
// ... Resizing and initialization
template<typename MT , bool SO>
DisableIf< Or< IsComputation<MT>, IsTransExpr<MT> >, SparseRow<const MT> >::Type row ( const SparseMatrix< MT, SO > &  sm,
size_t  index 
)
inlineprivate

Creating a view on a specific row of the given constant sparse matrix.

Parameters
smThe constant sparse matrix containing the row.
indexThe index of the row.
Returns
View on the specified row of the matrix.
Exceptions
std::invalid_argumentInvalid row access index.

This function returns an expression representing the specified row of the given sparse matrix.

const Matrix A;
// ... Resizing and initialization
template<typename MT , bool SO>
DisableIf< Or< IsComputation<MT>, IsTransExpr<MT> >, SparseSubmatrix<MT> >::Type submatrix ( SparseMatrix< MT, SO > &  sm,
size_t  row,
size_t  column,
size_t  m,
size_t  n 
)
inlineprivate

Creating a view on a specific submatrix of the given sparse matrix.

Parameters
smThe sparse matrix containing the submatrix.
rowThe index of the first row of the submatrix.
columnThe index of the first column of the submatrix.
mThe number of rows of the submatrix.
nThe number of columns of the submatrix.
Returns
View on the specific submatrix of the sparse matrix.
Exceptions
std::invalid_argumentInvalid submatrix specification.

This function returns an expression representing the specified submatrix of the given sparse matrix. The following example demonstrates the creation of a submatrix of size 4 by 4 starting from position (3,2):

using blaze::rowMatrix;
Matrix A;
// ... Resizing and initialization
blaze::SparseSubmatrix<Matrix> = submatrix( A, 3UL, 2UL, 4UL, 4UL );

In case the submatrix is not properly specified (i.e. if the specified submatrix is not contained in the given sparse matrix) a std::invalid_argument exception is thrown.

template<typename MT , bool SO>
DisableIf< Or< IsComputation<MT>, IsTransExpr<MT> >, SparseSubmatrix<const MT> >::Type submatrix ( const SparseMatrix< MT, SO > &  sm,
size_t  row,
size_t  column,
size_t  m,
size_t  n 
)
inlineprivate

Creating a view on a specific submatrix of the given sparse matrix.

Parameters
smThe sparse matrix containing the submatrix.
rowThe index of the first row of the submatrix.
columnThe index of the first column of the submatrix.
mThe number of rows of the submatrix.
nThe number of columns of the submatrix.
Returns
View on the specific submatrix of the sparse matrix.
Exceptions
std::invalid_argumentInvalid submatrix specification.

This function returns an expression representing the specified submatrix of the given sparse matrix. The following example demonstrates the creation of a submatrix of size 4 by 4 starting from position (3,2):

using blaze::rowMatrix;
Matrix A;
// ... Resizing and initialization
blaze::SparseSubmatrix<Matrix> = submatrix( A, 3UL, 2UL, 4UL, 4UL );

In case the submatrix is not properly specified (i.e. if the specified submatrix is not contained in the given sparse matrix) a std::invalid_argument exception is thrown.

template<typename MT , bool SO>
DisableIf< Or< IsComputation<MT>, IsTransExpr<MT> >, DenseSubmatrix<MT> >::Type submatrix ( DenseMatrix< MT, SO > &  dm,
size_t  row,
size_t  column,
size_t  m,
size_t  n 
)
inline

Creating a view on a specific submatrix of the given dense matrix.

Parameters
dmThe dense matrix containing the submatrix.
rowThe index of the first row of the submatrix.
columnThe index of the first column of the submatrix.
mThe number of rows of the submatrix.
nThe number of columns of the submatrix.
Returns
View on the specific submatrix of the dense matrix.
Exceptions
std::invalid_argumentInvalid submatrix specification.

This function returns an expression representing the specified submatrix of the given dense matrix. The following example demonstrates the creation of a submatrix of size 4 by 4 starting from position (3,2):

using blaze::rowMatrix;
Matrix A;
// ... Resizing and initialization
blaze::DenseSubmatrix<Matrix> = submatrix( A, 3UL, 2UL, 4UL, 4UL );

In case the submatrix is not properly specified (i.e. if the specified submatrix is not contained in the given dense matrix) a std::invalid_argument exception is thrown.

template<typename MT , bool SO>
DisableIf< Or< IsComputation<MT>, IsTransExpr<MT> >, DenseSubmatrix<const MT> >::Type submatrix ( const DenseMatrix< MT, SO > &  dm,
size_t  row,
size_t  column,
size_t  m,
size_t  n 
)
inline

Creating a view on a specific submatrix of the given dense matrix.

Parameters
dmThe dense matrix containing the submatrix.
rowThe index of the first row of the submatrix.
columnThe index of the first column of the submatrix.
mThe number of rows of the submatrix.
nThe number of columns of the submatrix.
Returns
View on the specific submatrix of the dense matrix.
Exceptions
std::invalid_argumentInvalid submatrix specification.

This function returns an expression representing the specified submatrix of the given dense matrix. The following example demonstrates the creation of a submatrix of size 4 by 4 starting from position (3,2):

using blaze::rowMatrix;
Matrix A;
// ... Resizing and initialization
blaze::DenseSubmatrix<Matrix> = submatrix( A, 3UL, 2UL, 4UL, 4UL );

In case the submatrix is not properly specified (i.e. if the specified submatrix is not contained in the given dense matrix) a std::invalid_argument exception is thrown.

template<typename VT , bool TF>
DisableIf< Or< IsComputation<VT>, IsTransExpr<VT> >, SparseSubvector<VT> >::Type blaze::subvector ( SparseVector< VT, TF > &  sv,
size_t  index,
size_t  size 
)
inline

Creating a view on a specific subvector of the given sparse vector.

Parameters
svThe sparse vector containing the subvector.
indexThe index of the first element of the subvector.
sizeThe size of the subvector.
Returns
View on the specific subvector of the sparse vector.
Exceptions
std::invalid_argumentInvalid subvector specification.

This function returns an expression representing the specified subvector of the given sparse vector. The following example demonstrates the creation of a subvector of size 8 starting from index 4:

Vector v;
// ... Resizing and initialization

In case the subvector is not properly specified (i.e. if the specified first index is larger than the total size of the given vector or the subvector is specified beyond the size of the vector) a std::invalid_argument exception is thrown.

template<typename VT , bool TF>
DisableIf< Or< IsComputation<VT>, IsTransExpr<VT> >, SparseSubvector<const VT> >::Type blaze::subvector ( const SparseVector< VT, TF > &  sv,
size_t  index,
size_t  size 
)
inline

Creating a view on a specific subvector of the given sparse vector.

Parameters
svThe sparse vector containing the subvector.
indexThe index of the first element of the subvector.
sizeThe size of the subvector.
Returns
View on the specific subvector of the sparse vector.
Exceptions
std::invalid_argumentInvalid subvector specification.

This function returns an expression representing the specified subvector of the given sparse vector. The following example demonstrates the creation of a subvector of size 8 starting from index 4:

Vector v;
// ... Resizing and initialization

In case the subvector is not properly specified (i.e. if the specified first index is larger than the total size of the given vector or the subvector is specified beyond the size of the vector) a std::invalid_argument exception is thrown.

template<typename VT , bool TF>
DisableIf< Or< IsComputation<VT>, IsTransExpr<VT> >, DenseSubvector<VT> >::Type blaze::subvector ( DenseVector< VT, TF > &  dv,
size_t  index,
size_t  size 
)
inline

Creating a view on a specific subvector of the given dense vector.

Parameters
dvThe dense vector containing the subvector.
indexThe index of the first element of the subvector.
sizeThe size of the subvector.
Returns
View on the specific subvector of the dense vector.
Exceptions
std::invalid_argumentInvalid subvector specification.

This function returns an expression representing the specified subvector of the given dense vector. The following example demonstrates the creation of a subvector of size 8 starting from index 4:

Vector v;
// ... Resizing and initialization

In case the subvector is not properly specified (i.e. if the specified first index is larger than the total size of the given vector or the subvector is specified beyond the size of the vector) a std::invalid_argument exception is thrown.

template<typename VT , bool TF>
DisableIf< Or< IsComputation<VT>, IsTransExpr<VT> >, DenseSubvector<const VT> >::Type blaze::subvector ( const DenseVector< VT, TF > &  dv,
size_t  index,
size_t  size 
)
inline

Creating a view on a specific subvector of the given dense vector.

Parameters
dvThe dense vector containing the subvector.
indexThe index of the first element of the subvector.
sizeThe size of the subvector.
Returns
View on the specific subvector of the dense vector.
Exceptions
std::invalid_argumentInvalid subvector specification.

This function returns an expression representing the specified subvector of the given dense vector. The following example demonstrates the creation of a subvector of size 8 starting from index 4:

Vector v;
// ... Resizing and initialization

In case the subvector is not properly specified (i.e. if the specified first index is larger than the total size of the given vector or the subvector is specified beyond the size of the vector) a std::invalid_argument exception is thrown.