Stokhos Package Browser (Single Doxygen Collection)  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Types | Public Member Functions | Public Attributes | List of all members
Stokhos::SparseArray< ordinal_type, val_type > Struct Template Reference

Container for a "sparse" array. More...

#include <Stokhos_SparseArray.hpp>

Inheritance diagram for Stokhos::SparseArray< ordinal_type, val_type >:
Inheritance graph
[legend]

Public Types

typedef Teuchos::Array
< ordinal_type >
::const_iterator 
index_const_iterator
 
typedef Teuchos::Array
< val_type >::const_iterator 
value_const_iterator
 
typedef SparseArrayIterator
< index_const_iterator,
value_const_iterator
const_iterator
 
typedef
SparseArrayReverseIterator
< index_const_iterator,
value_const_iterator
const_reverse_iterator
 

Public Member Functions

ordinal_type size () const
 Return size of array. More...
 
void resize (ordinal_type sz)
 Resize array. More...
 
const_iterator begin () const
 Iterator pointing to beginning of array. More...
 
const_iterator end () const
 Iterator pointing to end of array. More...
 
const_reverse_iterator rbegin () const
 Reverse iterator pointing to end of array. More...
 
const_reverse_iterator rend () const
 Reverse iterator pointing to begining of array. More...
 
const_iterator find (ordinal_type i) const
 Return iterator pointing to given index i. More...
 

Public Attributes

Teuchos::Array< ordinal_type > indices
 Indices of nonzeros. More...
 
Teuchos::Array< val_type > values
 Nonzero values. More...
 

Detailed Description

template<typename ordinal_type, typename val_type>
struct Stokhos::SparseArray< ordinal_type, val_type >

Container for a "sparse" array.

Definition at line 63 of file Stokhos_SparseArray.hpp.

Member Typedef Documentation

template<typename ordinal_type, typename val_type>
typedef Teuchos::Array<ordinal_type>::const_iterator Stokhos::SparseArray< ordinal_type, val_type >::index_const_iterator

Definition at line 80 of file Stokhos_SparseArray.hpp.

template<typename ordinal_type, typename val_type>
typedef Teuchos::Array<val_type>::const_iterator Stokhos::SparseArray< ordinal_type, val_type >::value_const_iterator

Definition at line 81 of file Stokhos_SparseArray.hpp.

template<typename ordinal_type, typename val_type>
typedef SparseArrayIterator<index_const_iterator, value_const_iterator> Stokhos::SparseArray< ordinal_type, val_type >::const_iterator

Definition at line 82 of file Stokhos_SparseArray.hpp.

template<typename ordinal_type, typename val_type>
typedef SparseArrayReverseIterator<index_const_iterator, value_const_iterator> Stokhos::SparseArray< ordinal_type, val_type >::const_reverse_iterator

Definition at line 83 of file Stokhos_SparseArray.hpp.

Member Function Documentation

template<typename ordinal_type, typename val_type>
ordinal_type Stokhos::SparseArray< ordinal_type, val_type >::size ( ) const
inline

Return size of array.

Definition at line 72 of file Stokhos_SparseArray.hpp.

template<typename ordinal_type, typename val_type>
void Stokhos::SparseArray< ordinal_type, val_type >::resize ( ordinal_type  sz)
inline

Resize array.

Definition at line 75 of file Stokhos_SparseArray.hpp.

template<typename ordinal_type, typename val_type>
const_iterator Stokhos::SparseArray< ordinal_type, val_type >::begin ( ) const
inline

Iterator pointing to beginning of array.

Definition at line 86 of file Stokhos_SparseArray.hpp.

template<typename ordinal_type, typename val_type>
const_iterator Stokhos::SparseArray< ordinal_type, val_type >::end ( ) const
inline

Iterator pointing to end of array.

Definition at line 91 of file Stokhos_SparseArray.hpp.

template<typename ordinal_type, typename val_type>
const_reverse_iterator Stokhos::SparseArray< ordinal_type, val_type >::rbegin ( ) const
inline

Reverse iterator pointing to end of array.

Definition at line 96 of file Stokhos_SparseArray.hpp.

template<typename ordinal_type, typename val_type>
const_reverse_iterator Stokhos::SparseArray< ordinal_type, val_type >::rend ( ) const
inline

Reverse iterator pointing to begining of array.

Definition at line 101 of file Stokhos_SparseArray.hpp.

template<typename ordinal_type, typename val_type>
const_iterator Stokhos::SparseArray< ordinal_type, val_type >::find ( ordinal_type  i) const
inline

Return iterator pointing to given index i.

Returns end() if array doesn't contain index i

Definition at line 109 of file Stokhos_SparseArray.hpp.

Member Data Documentation

template<typename ordinal_type, typename val_type>
Teuchos::Array<ordinal_type> Stokhos::SparseArray< ordinal_type, val_type >::indices

Indices of nonzeros.

Definition at line 66 of file Stokhos_SparseArray.hpp.

template<typename ordinal_type, typename val_type>
Teuchos::Array<val_type> Stokhos::SparseArray< ordinal_type, val_type >::values

Nonzero values.

Definition at line 69 of file Stokhos_SparseArray.hpp.


The documentation for this struct was generated from the following file: