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

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

#include <iterator>
#include <stdexcept>
#include <blaze/math/constraints/Computation.h>
#include <blaze/math/constraints/DenseVector.h>
#include <blaze/math/constraints/RequiresEvaluation.h>
#include <blaze/math/constraints/SparseMatrix.h>
#include <blaze/math/constraints/SparseVector.h>
#include <blaze/math/constraints/StorageOrder.h>
#include <blaze/math/constraints/TransExpr.h>
#include <blaze/math/constraints/TransposeFlag.h>
#include <blaze/math/expressions/SparseVector.h>
#include <blaze/math/expressions/View.h>
#include <blaze/math/Functions.h>
#include <blaze/math/shims/IsDefault.h>
#include <blaze/math/shims/Reset.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/SubTrait.h>
#include <blaze/math/traits/SubvectorTrait.h>
#include <blaze/math/typetraits/IsColumnMajorMatrix.h>
#include <blaze/math/typetraits/IsExpression.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>
#include <blaze/util/Unused.h>

Go to the source code of this file.

Classes

class  blaze::SparseColumn< typename, bool >
 Reference to a specific column of a sparse matrix.The SparseColumn template represents a reference to a specific column of a sparse matrix primitive. The type of the sparse matrix is specified via the first template parameter: More...
 

Namespaces

 blaze
 Namespace of the Blaze C++ math library.
 

Typedefs

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

Functions

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...
 
Constructors
 SparseColumn (MT &matrix, size_t index)
 
Data access functions
Reference operator[] (size_t index)
 
Iterator begin ()
 
ConstIterator cbegin () const
 
Iterator end ()
 
ConstIterator cend () const
 
Assignment operators
SparseColumn & operator= (const SparseColumn &rhs)
 
template<typename VT >
SparseColumn & operator= (const Vector< VT, false > &rhs)
 
template<typename VT >
SparseColumn & operator+= (const Vector< VT, false > &rhs)
 
template<typename VT >
SparseColumn & operator-= (const Vector< VT, false > &rhs)
 
template<typename VT >
SparseColumn & operator*= (const Vector< VT, false > &rhs)
 
template<typename Other >
EnableIf< IsNumeric< Other >
, SparseColumn >::Type & 
operator*= (Other rhs)
 
template<typename Other >
EnableIf< IsNumeric< Other >
, SparseColumn >::Type & 
operator/= (Other rhs)
 
Utility functions
size_t size () const
 
size_t capacity () const
 
size_t nonZeros () const
 
void reset ()
 
Iterator insert (size_t index, const ElementType &value)
 
void erase (size_t index)
 
Iterator erase (Iterator pos)
 
Iterator erase (Iterator first, Iterator last)
 
void reserve (size_t n)
 
template<typename Other >
SparseColumn & scale (Other scalar)
 
Lookup functions
Iterator find (size_t index)
 
Iterator lowerBound (size_t index)
 
Iterator upperBound (size_t index)
 
Low-level utility functions
void append (size_t index, const ElementType &value, bool check=false)
 
Expression template evaluation functions
template<typename Other >
bool canAlias (const Other *alias) const
 
template<typename Other >
bool isAliased (const Other *alias) const
 
template<typename VT >
void assign (const DenseVector< VT, false > &rhs)
 
template<typename VT >
void assign (const SparseVector< VT, false > &rhs)
 
template<typename VT >
void addAssign (const Vector< VT, false > &rhs)
 
template<typename VT >
void subAssign (const Vector< VT, false > &rhs)
 
SparseColumn operators
template<typename MT , bool SO>
void reset (SparseColumn< MT, SO > &column)
 Resetting the given sparse column. More...
 
template<typename MT , bool SO>
void clear (SparseColumn< MT, SO > &column)
 Clearing the given sparse column. More...
 
template<typename MT , bool SO>
bool isDefault (const SparseColumn< MT, SO > &column)
 Returns whether the given sparse column is in default state. More...
 

Variables

Member variables
Operand matrix_
 The sparse matrix containing the column.
 
const size_t col_
 The index of the column in the matrix.
 

Detailed Description

Header file for the SparseColumn 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.