MOOCHO (Single Doxygen Collection) Version of the Day
Private Member Functions | Private Attributes
AbstractLinAlgPack::COOMatrixPartitionedViewUtilityPack::TransposedPartition< T_Indice, T_Value > Class Template Reference

Class for the transpose of a Partition. More...

#include <AbstractLinAlgPack_COOMatrixPartitionedViewClassDecl.hpp>

List of all members.

Private Member Functions

TransposedPartitionoperator= (const TransposedPartition &)

Private Attributes

partition_type partition_

Public types

typedef Partition< T_Indice,
T_Value > 
partition_type
 
typedef
AbstractLinAlgPack::size_type 
size_type
 
typedef ptrdiff_t difference_type
 
typedef SparseCOOPtrElement
< T_Indice, T_Value > 
element_type
 
typedef
TransSparseCOOElementViewIter
< element_type
*, std::random_access_iterator_tag,
typename
element_type::indice_type,
typename
element_type::value_type
&, difference_type
iterator
 
typedef
TransSparseCOOElementViewIter
< const element_type
*, std::random_access_iterator_tag,
typename
element_type::indice_type,
const typename
element_type::value_type
&, difference_type
const_iterator
 

Constructors and initializes

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

 TransposedPartition (const partition_type &partition)
 Construct with the partition initialized.
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::TransposedPartition< T_Indice, T_Value >

Class for the transpose of a Partition.

This class represents the abstraction of the transpose of the matrix given by a Partition<> class.

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

This is a very light weight class and is just as efficient as Partition when used with templated linear algebra operations.

The default constructor is allowed in which case it is initialized to a default constructed partition object. Also to the default copy constructor is allowed. The default assignment operator however is not allowed since its meaning is a little confusing. When a client wants to copy the underlying partition, it should use the bind()# member function instead.

Definition at line 792 of file AbstractLinAlgPack_COOMatrixPartitionedViewClassDecl.hpp.


Member Typedef Documentation

template<class T_Indice, class T_Value>
typedef Partition<T_Indice,T_Value> AbstractLinAlgPack::COOMatrixPartitionedViewUtilityPack::TransposedPartition< T_Indice, T_Value >::partition_type
template<class T_Indice, class T_Value>
typedef ptrdiff_t AbstractLinAlgPack::COOMatrixPartitionedViewUtilityPack::TransposedPartition< T_Indice, T_Value >::difference_type
template<class T_Indice, class T_Value>
typedef SparseCOOPtrElement<T_Indice,T_Value> AbstractLinAlgPack::COOMatrixPartitionedViewUtilityPack::TransposedPartition< T_Indice, T_Value >::element_type
template<class T_Indice, class T_Value>
typedef TransSparseCOOElementViewIter< element_type* , std::random_access_iterator_tag , typename element_type::indice_type , typename element_type::value_type& , difference_type> AbstractLinAlgPack::COOMatrixPartitionedViewUtilityPack::TransposedPartition< T_Indice, T_Value >::iterator
template<class T_Indice, class T_Value>
typedef TransSparseCOOElementViewIter< const element_type* , std::random_access_iterator_tag , typename element_type::indice_type , const typename element_type::value_type& , difference_type> AbstractLinAlgPack::COOMatrixPartitionedViewUtilityPack::TransposedPartition< T_Indice, T_Value >::const_iterator

Constructor & Destructor Documentation

template<class T_Indice , class T_Value >
AbstractLinAlgPack::COOMatrixPartitionedViewUtilityPack::TransposedPartition< T_Indice, T_Value >::TransposedPartition ( const partition_type partition) [inline]

Construct with the partition initialized.

ToDo: finish documentation for this function

Definition at line 1037 of file AbstractLinAlgPack_COOMatrixPartitionedViewClassDecl.hpp.


Member Function Documentation

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

bind to a partion.

ToDo: finish documentation for this function

Definition at line 1042 of file AbstractLinAlgPack_COOMatrixPartitionedViewClassDecl.hpp.

template<class T_Indice , class T_Value >
TransposedPartition< T_Indice, T_Value >::size_type AbstractLinAlgPack::COOMatrixPartitionedViewUtilityPack::TransposedPartition< T_Indice, T_Value >::rows ( ) const [inline]
template<class T_Indice , class T_Value >
TransposedPartition< T_Indice, T_Value >::size_type AbstractLinAlgPack::COOMatrixPartitionedViewUtilityPack::TransposedPartition< T_Indice, T_Value >::cols ( ) const [inline]
template<class T_Indice , class T_Value >
TransposedPartition< T_Indice, T_Value >::size_type AbstractLinAlgPack::COOMatrixPartitionedViewUtilityPack::TransposedPartition< T_Indice, T_Value >::nz ( ) const [inline]
template<class T_Indice , class T_Value >
TransposedPartition< T_Indice, T_Value >::difference_type AbstractLinAlgPack::COOMatrixPartitionedViewUtilityPack::TransposedPartition< T_Indice, T_Value >::row_offset ( ) const [inline]
template<class T_Indice , class T_Value >
TransposedPartition< T_Indice, T_Value >::difference_type AbstractLinAlgPack::COOMatrixPartitionedViewUtilityPack::TransposedPartition< T_Indice, T_Value >::col_offset ( ) const [inline]
template<class T_Indice , class T_Value >
TransposedPartition< T_Indice, T_Value >::iterator AbstractLinAlgPack::COOMatrixPartitionedViewUtilityPack::TransposedPartition< T_Indice, T_Value >::begin ( ) [inline]
template<class T_Indice , class T_Value >
TransposedPartition< T_Indice, T_Value >::const_iterator AbstractLinAlgPack::COOMatrixPartitionedViewUtilityPack::TransposedPartition< T_Indice, T_Value >::begin ( ) const [inline]
template<class T_Indice , class T_Value >
TransposedPartition< T_Indice, T_Value >::iterator AbstractLinAlgPack::COOMatrixPartitionedViewUtilityPack::TransposedPartition< T_Indice, T_Value >::end ( ) [inline]
template<class T_Indice , class T_Value >
TransposedPartition< T_Indice, T_Value >::const_iterator AbstractLinAlgPack::COOMatrixPartitionedViewUtilityPack::TransposedPartition< T_Indice, T_Value >::end ( ) const [inline]
template<class T_Indice, class T_Value>
TransposedPartition& AbstractLinAlgPack::COOMatrixPartitionedViewUtilityPack::TransposedPartition< T_Indice, T_Value >::operator= ( const TransposedPartition< T_Indice, T_Value > &  ) [private]

Member Data Documentation

template<class T_Indice, class T_Value>
partition_type AbstractLinAlgPack::COOMatrixPartitionedViewUtilityPack::TransposedPartition< T_Indice, T_Value >::partition_ [private]

The documentation for this class was generated from the following file:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines