All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Classes | Namespaces | Typedefs | Functions
SparseSubmatrix.h File Reference

Header file for the SparseSubmatrix class template. More...

#include <iterator>
#include <stdexcept>
#include <vector>
#include <blaze/math/constraints/Computation.h>
#include <blaze/math/constraints/DenseMatrix.h>
#include <blaze/math/constraints/Matrix.h>
#include <blaze/math/constraints/RequiresEvaluation.h>
#include <blaze/math/constraints/SparseMatrix.h>
#include <blaze/math/constraints/StorageOrder.h>
#include <blaze/math/constraints/TransExpr.h>
#include <blaze/math/expressions/SparseMatrix.h>
#include <blaze/math/expressions/View.h>
#include <blaze/math/shims/IsDefault.h>
#include <blaze/math/StorageOrder.h>
#include <blaze/math/sparse/SparseElement.h>
#include <blaze/math/traits/AddTrait.h>
#include <blaze/math/traits/ColumnTrait.h>
#include <blaze/math/traits/DivTrait.h>
#include <blaze/math/traits/MultTrait.h>
#include <blaze/math/traits/RowTrait.h>
#include <blaze/math/traits/SubmatrixExprTrait.h>
#include <blaze/math/traits/SubmatrixTrait.h>
#include <blaze/math/traits/SubTrait.h>
#include <blaze/math/typetraits/IsColumnMajorMatrix.h>
#include <blaze/math/typetraits/IsComputation.h>
#include <blaze/math/typetraits/IsExpression.h>
#include <blaze/math/typetraits/IsTransExpr.h>
#include <blaze/math/typetraits/RequiresEvaluation.h>
#include <blaze/util/Assert.h>
#include <blaze/util/DisableIf.h>
#include <blaze/util/EnableIf.h>
#include <blaze/util/logging/FunctionTrace.h>
#include <blaze/util/mpl/If.h>
#include <blaze/util/mpl/Or.h>
#include <blaze/util/SelectType.h>
#include <blaze/util/Types.h>
#include <blaze/util/typetraits/IsConst.h>
#include <blaze/util/typetraits/IsFloatingPoint.h>
#include <blaze/util/typetraits/IsNumeric.h>

Go to the source code of this file.

Classes

class  blaze::SparseSubmatrix< typename, bool >
 View on a specific submatrix of a sparse matrix.The SparseSubmatrix template represents a view on a specific submatrix of a sparse matrix primitive. The type of the sparse matrix is specified via the first template parameter: More...
 
class  blaze::SparseSubmatrix< typename, bool >::SubmatrixElement< MatrixType, IteratorType >
 Access proxy for a specific element of the sparse submatrix. More...
 
class  blaze::SparseSubmatrix< typename, bool >::SubmatrixIterator< MatrixType, IteratorType >
 Iterator over the elements of the sparse submatrix. More...
 

Namespaces

 blaze
 Namespace of the Blaze C++ math library.
 

Typedefs

typedef SubmatrixIterator
< const MT, typename
MT::ConstIterator > 
ConstIterator
 Iterator over constant elements.
 
typedef SelectType< useConst,
ConstIterator,
SubmatrixIterator< MT,
typename MT::Iterator >
>::Type 
Iterator
 Iterator over non-constant elements.
 

Functions

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...
 
Constructors
 SparseSubmatrix (MT &matrix, size_t row, size_t column, size_t m, size_t n)
 
Data access functions
Reference operator() (size_t i, size_t j)
 
Iterator begin (size_t i)
 
ConstIterator cbegin (size_t i) const
 
Iterator end (size_t i)
 
ConstIterator cend (size_t i) const
 
Assignment operators
SparseSubmatrix & operator= (const SparseSubmatrix &rhs)
 
template<typename MT2 , bool SO>
SparseSubmatrix & operator= (const DenseMatrix< MT2, SO > &rhs)
 
template<typename MT2 , bool SO>
SparseSubmatrix & operator= (const SparseMatrix< MT2, SO > &rhs)
 
template<typename MT2 , bool SO>
SparseSubmatrix & operator+= (const Matrix< MT2, SO > &rhs)
 
template<typename MT2 , bool SO>
SparseSubmatrix & operator-= (const Matrix< MT2, SO > &rhs)
 
template<typename MT2 , bool SO>
SparseSubmatrix & operator*= (const Matrix< MT2, SO > &rhs)
 
template<typename Other >
EnableIf< IsNumeric< Other >
, SparseSubmatrix >::Type & 
operator*= (Other rhs)
 
template<typename Other >
EnableIf< IsNumeric< Other >
, SparseSubmatrix >::Type & 
operator/= (Other rhs)
 
Utility functions
size_t rows () const
 
size_t columns () const
 
size_t capacity () const
 
size_t capacity (size_t i) const
 
size_t nonZeros () const
 
size_t nonZeros (size_t i) const
 
void reset ()
 
void reset (size_t i)
 
Iterator insert (size_t i, size_t j, const ElementType &value)
 
void erase (size_t i, size_t j)
 
Iterator erase (size_t i, Iterator pos)
 
Iterator erase (size_t i, Iterator first, Iterator last)
 
void reserve (size_t nonzeros)
 
void reserve (size_t i, size_t nonzeros)
 
void trim ()
 
void trim (size_t j)
 
template<typename Other >
SparseSubmatrix & scale (Other scalar)
 
Lookup functions
Iterator find (size_t i, size_t j)
 
Iterator lowerBound (size_t i, size_t j)
 
Iterator upperBound (size_t i, size_t j)
 
Low-level utility functions
void append (size_t i, size_t j, const ElementType &value, bool check=false)
 
void finalize (size_t i)
 
Expression template evaluation functions
template<typename Other >
bool canAlias (const Other *alias) const
 
template<typename Other >
bool isAliased (const Other *alias) const
 
template<typename MT2 , bool SO>
void assign (const DenseMatrix< MT2, SO > &rhs)
 
template<typename MT2 >
void assign (const SparseMatrix< MT2, false > &rhs)
 
template<typename MT2 >
void assign (const SparseMatrix< MT2, true > &rhs)
 
template<typename MT2 , bool SO>
void addAssign (const DenseMatrix< MT2, SO > &rhs)
 
template<typename MT2 , bool SO>
void addAssign (const SparseMatrix< MT2, SO > &rhs)
 
template<typename MT2 , bool SO>
void subAssign (const DenseMatrix< MT2, SO > &rhs)
 
template<typename MT2 , bool SO>
void subAssign (const SparseMatrix< MT2, SO > &rhs)
 
SparseSubmatrix operators
template<typename MT , bool SO>
void reset (SparseSubmatrix< MT, SO > &sm)
 Resetting the given sparse submatrix. More...
 
template<typename MT , bool SO>
void clear (SparseSubmatrix< MT, SO > &sm)
 Clearing the given sparse matrix. More...
 
template<typename MT , bool SO>
bool isDefault (const SparseSubmatrix< MT, SO > &sm)
 Returns whether the given sparse submatrix is in default state. More...
 

Variables

Member variables
Operand matrix_
 The sparse matrix containing the submatrix.
 
const size_t row_
 The first row of the submatrix.
 
const size_t column_
 The first column of the submatrix.
 
const size_t m_
 The number of rows of the submatrix.
 
const size_t n_
 The number of columns of the submatrix.
 

Detailed Description

Header file for the SparseSubmatrix class template.

Copyright (C) 2013 Klaus Iglberger - All Rights Reserved

This file is part of the Blaze library. You can redistribute it and/or modify it under the terms of the New (Revised) BSD License. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

  1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
  2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
  3. Neither the names of the Blaze development group nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.