AbstractLinAlgPack::COOMatrixPartitionedViewUtilityPack::Partition< T_Indice, T_Value > Class Template Reference

Class for a partition or a set of continous partitions in a partitioned COO matrix. More...

#include <AbstractLinAlgPack_COOMatrixPartitionedViewClassDecl.hpp>

List of all members.

Public types

typedef AbstractLinAlgPack::size_type size_type
 
typedef Partition< T_Indice,
T_Value > 
partition_type
 
typedef ptrdiff_t difference_type
 
typedef SparseCOOPtrElement<
T_Indice, T_Value > 
element_type
 
typedef element_typeiterator
 
typedef const element_typeconst_iterator
 

Constructors and initializes

The default copy constructor is allowed since it has the proper sematics.

 Partition ()
 Constructs an uninitialized partition view.
 Partition (size_type rows, size_type cols, size_type nz, element_type *ele, difference_type row_offset, difference_type col_offset)
 Construct with the COO matrix initialized.
void initialize (size_type rows, size_type cols, size_type nz, element_type *ele, difference_type row_offset, difference_type col_offset)
 Initialize the COO matrix.
void bind (const partition_type &partition)
 bind to a partion.

COOMatrixTemplateInterface interface

size_type rows () const
 
size_type cols () const
 
size_type nz () const
 
difference_type row_offset () const
 
difference_type col_offset () const
 
iterator begin ()
 
const_iterator begin () const
 
iterator end ()
 
const_iterator end () const
 


Detailed Description

template<class T_Indice, class T_Value>
class AbstractLinAlgPack::COOMatrixPartitionedViewUtilityPack::Partition< T_Indice, T_Value >

Class for a partition or a set of continous partitions in a partitioned COO matrix.

This class represents the abstraction of the submatrx or submatrices in a partion or a set of continous partitions in a COO matrix.

Its interface conforms to the template specification COOMatrixTemplateInterface so that it can be used with all of the linear algebra functions defined for that interface.

Definition at line 620 of file AbstractLinAlgPack_COOMatrixPartitionedViewClassDecl.hpp.


Member Typedef Documentation

template<class T_Indice, class T_Value>
typedef AbstractLinAlgPack::size_type AbstractLinAlgPack::COOMatrixPartitionedViewUtilityPack::Partition< T_Indice, T_Value >::size_type
 

Definition at line 627 of file AbstractLinAlgPack_COOMatrixPartitionedViewClassDecl.hpp.

template<class T_Indice, class T_Value>
typedef Partition<T_Indice,T_Value> AbstractLinAlgPack::COOMatrixPartitionedViewUtilityPack::Partition< T_Indice, T_Value >::partition_type
 

Definition at line 629 of file AbstractLinAlgPack_COOMatrixPartitionedViewClassDecl.hpp.

template<class T_Indice, class T_Value>
typedef ptrdiff_t AbstractLinAlgPack::COOMatrixPartitionedViewUtilityPack::Partition< T_Indice, T_Value >::difference_type
 

Definition at line 631 of file AbstractLinAlgPack_COOMatrixPartitionedViewClassDecl.hpp.

template<class T_Indice, class T_Value>
typedef SparseCOOPtrElement<T_Indice,T_Value> AbstractLinAlgPack::COOMatrixPartitionedViewUtilityPack::Partition< T_Indice, T_Value >::element_type
 

Definition at line 633 of file AbstractLinAlgPack_COOMatrixPartitionedViewClassDecl.hpp.

template<class T_Indice, class T_Value>
typedef element_type* AbstractLinAlgPack::COOMatrixPartitionedViewUtilityPack::Partition< T_Indice, T_Value >::iterator
 

Definition at line 635 of file AbstractLinAlgPack_COOMatrixPartitionedViewClassDecl.hpp.

template<class T_Indice, class T_Value>
typedef const element_type* AbstractLinAlgPack::COOMatrixPartitionedViewUtilityPack::Partition< T_Indice, T_Value >::const_iterator
 

Definition at line 637 of file AbstractLinAlgPack_COOMatrixPartitionedViewClassDecl.hpp.


Constructor & Destructor Documentation

template<class T_Indice, class T_Value>
AbstractLinAlgPack::COOMatrixPartitionedViewUtilityPack::Partition< T_Indice, T_Value >::Partition  )  [inline]
 

Constructs an uninitialized partition view.

Postconditions:{itemize} rows() == 0# cols() == 0# nz() == 0# row_offset() == 0# col_offset() == 0# {itemize}

Definition at line 900 of file AbstractLinAlgPack_COOMatrixPartitionedViewClassDecl.hpp.

template<class T_Indice, class T_Value>
AbstractLinAlgPack::COOMatrixPartitionedViewUtilityPack::Partition< T_Indice, T_Value >::Partition size_type  rows,
size_type  cols,
size_type  nz,
element_type ele,
difference_type  row_offset,
difference_type  col_offset
[inline]
 

Construct with the COO matrix initialized.

Equivalent to calling the default constructor and initialize(...)#.

Definition at line 905 of file AbstractLinAlgPack_COOMatrixPartitionedViewClassDecl.hpp.


Member Function Documentation

template<class T_Indice, class T_Value>
void AbstractLinAlgPack::COOMatrixPartitionedViewUtilityPack::Partition< T_Indice, T_Value >::initialize size_type  rows,
size_type  cols,
size_type  nz,
element_type ele,
difference_type  row_offset,
difference_type  col_offset
[inline]
 

Initialize the COO matrix.

Parameters:
rows number of rows in the submatrix
cols number of columns in the submatrix
nz number of nonzero elements in the submatrix
ele pointer to the array of nonzero elements in the submatrix
row_offset offset for each nonzero row indice in #ele#. i = #ele#[...].row_i + row_offset#
row_offset offset for each nonzero column indice in #ele#. j = #ele#[...].col_j + col_offset#

Definition at line 917 of file AbstractLinAlgPack_COOMatrixPartitionedViewClassDecl.hpp.

template<class T_Indice, class T_Value>
void AbstractLinAlgPack::COOMatrixPartitionedViewUtilityPack::Partition< T_Indice, T_Value >::bind const partition_type partition  )  [inline]
 

bind to a partion.

ToDo: finish documentation for this function

Definition at line 934 of file AbstractLinAlgPack_COOMatrixPartitionedViewClassDecl.hpp.

template<class T_Indice, class T_Value>
Partition< T_Indice, T_Value >::size_type AbstractLinAlgPack::COOMatrixPartitionedViewUtilityPack::Partition< T_Indice, T_Value >::rows  )  const [inline]
 

Definition at line 943 of file AbstractLinAlgPack_COOMatrixPartitionedViewClassDecl.hpp.

template<class T_Indice, class T_Value>
Partition< T_Indice, T_Value >::size_type AbstractLinAlgPack::COOMatrixPartitionedViewUtilityPack::Partition< T_Indice, T_Value >::cols  )  const [inline]
 

Definition at line 950 of file AbstractLinAlgPack_COOMatrixPartitionedViewClassDecl.hpp.

template<class T_Indice, class T_Value>
Partition< T_Indice, T_Value >::size_type AbstractLinAlgPack::COOMatrixPartitionedViewUtilityPack::Partition< T_Indice, T_Value >::nz  )  const [inline]
 

Definition at line 957 of file AbstractLinAlgPack_COOMatrixPartitionedViewClassDecl.hpp.

template<class T_Indice, class T_Value>
Partition< T_Indice, T_Value >::difference_type AbstractLinAlgPack::COOMatrixPartitionedViewUtilityPack::Partition< T_Indice, T_Value >::row_offset  )  const [inline]
 

Definition at line 964 of file AbstractLinAlgPack_COOMatrixPartitionedViewClassDecl.hpp.

template<class T_Indice, class T_Value>
Partition< T_Indice, T_Value >::difference_type AbstractLinAlgPack::COOMatrixPartitionedViewUtilityPack::Partition< T_Indice, T_Value >::col_offset  )  const [inline]
 

Definition at line 971 of file AbstractLinAlgPack_COOMatrixPartitionedViewClassDecl.hpp.

template<class T_Indice, class T_Value>
Partition< T_Indice, T_Value >::iterator AbstractLinAlgPack::COOMatrixPartitionedViewUtilityPack::Partition< T_Indice, T_Value >::begin  )  [inline]
 

Definition at line 978 of file AbstractLinAlgPack_COOMatrixPartitionedViewClassDecl.hpp.

template<class T_Indice, class T_Value>
Partition< T_Indice, T_Value >::const_iterator AbstractLinAlgPack::COOMatrixPartitionedViewUtilityPack::Partition< T_Indice, T_Value >::begin  )  const [inline]
 

Definition at line 986 of file AbstractLinAlgPack_COOMatrixPartitionedViewClassDecl.hpp.

template<class T_Indice, class T_Value>
Partition< T_Indice, T_Value >::iterator AbstractLinAlgPack::COOMatrixPartitionedViewUtilityPack::Partition< T_Indice, T_Value >::end  )  [inline]
 

Definition at line 994 of file AbstractLinAlgPack_COOMatrixPartitionedViewClassDecl.hpp.

template<class T_Indice, class T_Value>
Partition< T_Indice, T_Value >::const_iterator AbstractLinAlgPack::COOMatrixPartitionedViewUtilityPack::Partition< T_Indice, T_Value >::end  )  const [inline]
 

Definition at line 1002 of file AbstractLinAlgPack_COOMatrixPartitionedViewClassDecl.hpp.


The documentation for this class was generated from the following file:
Generated on Thu Sep 18 12:33:56 2008 for AbstractLinAlgPack: C++ Interfaces For Vectors, Matrices And Related Linear Algebra Objects by doxygen 1.3.9.1